Installation¶

Standard Installation¶

The most stable version of PyADM1ODE_calibration can be installed directly via the Python Package Index (PyPI):

pip install pyadm1ode-calibration

For the latest features or active development, you can clone the repository:

git clone https://github.com/dgaida/PyADM1ODE_calibration.git
cd PyADM1ODE_calibration
pip install .

If you want to make changes to the code, install the package in editable mode with all development dependencies:

pip install -e ".[dev]"

If you are using Conda, you can create the environment using the provided environment.yml file:

conda env create -f environment.yml
conda activate biogas

Then install this package in editable mode:

pip install -e .

To build the documentation locally, install the docs extras:

pip install -e ".[docs]"

Then you can view the documentation using MkDocs:

mkdocs serve

A Dockerfile is available in the repository to provide a consistent environment that already includes all dependencies.

docker build -t pyadm1-calibration .
docker run -it pyadm1-calibration