Installation¶

Standard-Installation¶

Die stabilste Version von PyADM1ODE_calibration kann direkt über den Python Package Index (PyPI) installiert werden:

pip install pyadm1ode-calibration

Für die neuesten Features oder zur aktiven Entwicklung können Sie das Repository klonen:

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

Wenn Sie Änderungen am Code vornehmen möchten, installieren Sie das Paket im Editier-Modus mit allen Entwicklungs-Abhängigkeiten:

pip install -e ".[dev]"

Wenn Sie Conda verwenden, können Sie die Umgebung mit der bereitgestellten environment.yml Datei erstellen:

conda env create -f environment.yml
conda activate biogas

Anschließend installieren Sie dieses Paket im Editier-Modus:

pip install -e .

Um die Dokumentation lokal zu bauen, installieren Sie die docs Extras:

pip install -e ".[docs]"

Danach können Sie die Dokumentation mit MkDocs betrachten:

mkdocs serve

Ein Dockerfile ist im Repository verfügbar, um eine konsistente Umgebung bereitzustellen, die bereits alle Abhängigkeiten enthält.

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