Installation

Requirements

To use mGrowthCtrl, you will need Python and a set of required packages. For optimal compatibility and performance, we recommend using the following minimum versions:

Python >= 3.10
numpy >= 1.26,<2.0
scipy >= 1.10
pandas >= 2.0
matplotlib >= 3.7
PyTorch >= 2.5 (optional, for neural controllers)
torchdiffeq >= 0.2 (optional, for neural ODE solving)
pymcmcstat >= 1.9 (optional, for MCMC fitting)

The required packages will be installed automatically during the installation process according to pyproject.toml.

Install mGrowthCtrl

To install the package locally, clone the repository and use pip in a virtual environment:

git clone https://gitlab.com/ComputationalScience/mgrowthctrl.git
cd mgrowthctrl

python -mvenv .venv
source .venv/bin/activate

pip install -e .

For optional features (neural controllers and MCMC), install with extras:

pip install -e ".[torch,mcmc]"

Alternatively, you can use the uv package manager and follow the instructions in their documentation.