Installation

Get started with pyAgrum using one of the following installation methods. Choose the one that best suits your environment.

Tip

Ensure you have Python 3.10+ installed before running the above commands.

Pip

Install pyAgrum using Python’s package manager.

pip

pip install pyAgrum

poetry

poetry add pyagrum

Anaconda

Install pyAgrum via conda-forge for Anaconda environments.

conda install -c conda-forge pyagrum

Note

Verify that your Anaconda environment is activated before running the command.

Docker

Run pyAgrum in a Docker container for a pre-configured environment.

Jupyter Notebook with pyAgrum

Launch a Jupyter notebook with pyAgrum pre-installed:

docker pull agrumery/pyagrum-notebook:latest
docker run -it --rm -p 8888:8888 -v <workfolder>:/home/jovyan/work --user root -e NB_UID=1000 agrumery/pyagrum-notebook

Then, open your browser and navigate to:

http://127.0.0.1:8888

Note

Replace <workfolder> with the path to a local folder where your notebooks will be stored.

pyAgrum CLI

For a lightweight pyAgrum environment:

docker pull agrumery/pyagrum:latest
docker run -it agrumery/pyagrum

From Source

Build and install pyAgrum from source for Windows, Linux, or macOS.

# 1. Clone the pyAgrum repository
git clone https://gitlab.com/agrumery/aGrUM.git

# 2. Install dependencies
pip install numpy scipy matplotlib pydotplus

# 3. Build pyAgrum
cd aGrUM
python act release test -t quick pyAgrum

# 4. Install pyAgrum
python act install pyAgrum -d <installation_folder>

Caution

Replace <installation_folder> with your desired installation directory. Ensure all dependencies are installed before building.