We recommend using an IDE such as PyCharm or VSCode to edit the python files.

To manage the python package installations, we recommend using a virtual environment like venv or conda.

(Assumes conda is already installed). In a terminal, in the project root directory, run:

conda env create --file=environment.yml

and the conda environment will be created with the given requirements. To activate it, run:

conda activate cmca

and configure your IDE to use this conda environment as well.

Follow the instructions here to create and activate a new virtual python environment. Then install the required packages: In a terminal, with the environment activated, run:

python -m pip install requirements.txt -r

and configure your IDE to use this environment.

To launch the jupyter notebooks in a browser, simply run:

jupyter notebook

in a terminal, in the project root directory, with the python environment activated. Then you can navigate to the desired notebook and edit it using the jupyter browser interface.