Installation

Note

The following commands are tested for UNIX-based operating systems, i.e., MacOS and Linux. Some commands, in particular those for creating the virtual environment, differ for Windows machines.

We heavily recommend to install Propulate 🧬 in its own virtual environment:

$ python3 -m venv ./propulate-venv
$ source ./propulate-venv/bin/activate
$ pip install --upgrade pip

The latest stable release can easily be installed from PyPI using pip:

$ pip install propulate

If you need the latest updates, you can also install Propulate 🧬 directly from the Github master branch at your own risk:

$ pip install https://github.com/Helmholtz-AI-Energy/propulate

If you want to get the source code and modify it, you can clone the source code using git and install Propulate 🧬 with pip in editable mode:

$ git clone https://github.com/Helmholtz-AI-Energy/propulate
$ pip install -e .

If you plan to contribute to Propulate 🧬, you need to install it along with its developer dependencies:

$ pip install -e."[dev]"

If you wish to play around with the tutorials, you need to install Propulate 🧬 along with some additional dependencies required for running the tutorials:

$ pip install -e."[tutorials]"

Note

Propulate 🧬 uses the message passing interface (MPI) and requires an MPI implementation under the hood. Currently, it is only tested with OpenMPI.

You can check whether your installation was successful by importing Propulate 🧬 in Python:

import propulate