Installation¶

Get the code¶

Create a github account if you do not have one already.
On the COVID19-Model Github repository page click the Fork button.
From your own repository page (your account) of the COVID19-Model, 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 COVID19-Model.

Install Python (conda) and packages¶

To use the 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
```
Setup/update the environment: Dependencies are collected in the conda environment.yml file (inside the root folder), so anybody can recreate the required environment using,
```
conda env create -f environment.yml
conda activate COVID_MODEL
```
or alternatively, to update the environment (needed after adding a dependency),
```
conda activate COVID_MODEL
conda env update -f environment.yml --prune
```
Mind that the step “solving the environment” can take quite some time.
Install the code developed specifically for the project (lives inside the src/covid19model folder) in the environment (in -e edit mode):
```
conda activate COVID_MODEL
pip install -e .
```
Note: This step needs to be done in a terminal or command prompt. Use your favorite terminal or use the Anaconda Prompt. Navigate with the cd command to the directory where you copied the repository.

Optional: To use the code, the general installation instruction outlined above suffice. When you’re planning to work on the documentation or the code of the model implementations itself, make sure to also install the development requirements:

pip install -e ".[develop]"