diff --git a/README.md b/README.md index 3c6137a7dc4336081ca499552dea31212acdd334..95adfdb4c2aa3596c2eb805c42013bb5418e5e13 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,17 @@ The pyicon documentation can be found here: [documentation](https://m300602.gitl Pyicon is hosted at: (https://gitlab.dkrz.de/m300602/pyicon/) +## Quick start for pyicon on Mistral + +Once you have to download pyicon by git: + +```bash +git clone git@gitlab.dkrz.de:m300602/pyicon.git +``` + +After that you have to load the correct python environment and make sure that pyicon is in your search path each time you want to use it. +The easiest way is to use the following script: + +```bash +source /path/to/pyicon/tools/conda_act_mistral_pyicon_env.sh +``` \ No newline at end of file