Installation¶

Fast & Furious¶

pip install pySODM

Install pySODM in a conda environment¶

When making your own modeling and simulation project, we recommend storing the dependencies of your project in a conda environment. Using a conda environment allows others to more quickly replicate your code. Make sure you have Python (conda) and the required dependency packages installed. We recommend using Anaconda to manage your Python packages. See the conda installation instructions and make sure you have conda up and running. Next:

Update conda after the installation to make sure your version is up-to-date,
```
conda update conda
```
Make an environment file my_environment.yml with the dependencies of your own project. pySODM is currently validated on Python 3.12.
```
name: MY_ENVIRONMENT
channels:
- defaults
- conda-forge
dependencies:
- python=3.12
- ...
```
Setup/update the environment: Dependencies are collected in the conda my_environment.yml file (inside the root folder), so anybody can recreate the required environment using,
```
conda env create -f my_environment.yml
conda activate MY_ENVIRONMENT
```
or alternatively, to update the environment (needed after adding a dependency),
```
conda activate MY_ENVIRONMENT
conda env update -f my_environment.yml --prune
```
When creating or upating an environment, solving the environment can take very long if you have a lot of dependencies, so be wary of adding unnecessary dependencies.
Install the pySODM code inside the environment,
```
conda activate MY_ENVIRONMENT
pip install pySODM
```
Note: The above step should be executed in a Mac/Linux terminal or command prompt. Use your favorite terminal or use the Anaconda Prompt.

Want to try out the tutorials?¶

Installing pySODM from pyPI does not give you acces to the tutorials and case studies as these are located in the source on Github. To try them out,

Download the source code from GitHub. When all went fine, you should have the code on your computer in a directory called pySODM.
An environment with the dependencies for the tutorials is available inside the ~/tutorial_env.yml file (environment name: PYSODM-TUTORIALS). Open a terminal in the root folder and create the PYSODM environment:
```
conda env create -f tutorial_env.yml
```
Activate the environment and install pySODM from source in it:
```
conda activate PYSODM-TUTORIALS
pip install -e.
```

Want to work on pySODM?¶

Create a GitHub account if you do not have one already.
On the pySODM Github repository page click the Fork button.
From your own repository page (your account) of pySODM, use git to download the code to your own computer. See the Github documentation on how to clone/download a repository.

When all went fine, you should have the code on your computer in a directory called pySODM. This folder contains a file tutorials_env.yml containing all the dependencies necessary to recreate the tutorials on this website. Install pySODM in this environment with the development requirements (necessary to work on the documentation),

conda env create -f tutorial_env.yml
conda activate PYSODM-TUTORIALS
pip install -e ".[develop]"