This code does not work with python 3.10 because of a dependency issue with Escher: zakandrewking/escher#377 . So make sure you install the package in a venv with e.g. python 3.9.
- Clone the repo from GitHub.
- Make a venv with e.g. conda:
conda create --name mmon-gcm python=3.9 - Install the package and dependencies in that virtualenv by running
pip install -e .in the root of the repo - Run the notebook scripts in the order that they are numbered.
The project uses nbdev2 to autocreate packages and documentation from jupyter notebooks.
Noah Sprent developed and wrote the majority of the code. Maurice Cheung edited minor parts of the code for publication.