Prerequisites and installation

Miniforge

Using Monkey Wrench requires a working conda environment. One can install mamba through Miniforge.

Installation of CHIMP and Monkey Wrench

Clone the repository

git clone https://github.com/pkhalaj/monkey-wrench.git

All the requirements for running CHIMP are in chimp.yaml. The file provides a conda environment with the same name (excluding the .yaml extension). To install and activate the available conda environment, run:

mamba env create -f monkey-wrench/envs/chimp.yaml
mamba activate chimp

Install the package via:

pip install monkey-wrench

To install dependencies for development (e.g., tests and documentation):

pip install -e "monkey-wrench[dev]"

CHIMP models

To run a CHIMP retrieval, you also need to download a retrieval model. You can automatically get the latest version of the model from Hugging Face using git-lfs. It is a dependency defined in chimp.yaml and has been installed in the conda environment you just created.

However, you need to update Git hooks (once per user account), via

git lfs install

Now you can fetch the latest model and store it in a directory, e.g. ./chimp_retrieval_models/

git clone https://huggingface.co/simonpf/chimp_smhi chimp_retrieval_models

You can also inspect and download the models manually from

versions before v3: https://rain.atmos.colostate.edu/gprof_nn/chimp/
version v3 and later: https://huggingface.co/simonpf/chimp_smhi

See CHIMP models and results, if you need to know more about the models.

API credentials

Visit API key management to obtain credentials to access the EUMETSAT API.
Set environment variables for API credentials so that they can be picked up by Monkey Wrench:

export EUMETSAT_API_LOGIN=<login>
export EUMETSAT_API_PASSWORD=<password>

You need to replace <login> and <password> with your actual credentials. Note that this needs to be done in every new shell instance unless added to your shell profile.