README.md 1.29 KB
Newer Older
1
2
# User guide for pyicon

nbruegge's avatar
nbruegge committed
3
4
5
6
Pyicon is a python post-processing and visualization toolbox for ICON with a focus on ocean data. The three main features of pyicon are:

* a number of functions to facilitate the every-day script-based plotting of ICON data
* an interactive (ncview-like) plotting GUI for Jupyter notebook
Nils Brüggemann's avatar
Nils Brüggemann committed
7
* a monitoring suite for ICON ocean simulations which combines dedicated diagnostic plots of an ICON simulation on a website
nbruegge's avatar
nbruegge committed
8
9
10

Pyicon is developed within the DFG-project TRR181 - Energy Transfers in Atmosphere and Ocean.

11
The pyicon documentation can be found here: [documentation](https://m300602.gitlab-pages.dkrz.de/pyicon/)
12

13
Pyicon is hosted at: (https://gitlab.dkrz.de/m300602/pyicon/)
14

Aaron Spring's avatar
Aaron Spring committed
15
## Quick start for `pyicon` on Mistral
16
17
18
19
20
21
22
23
24
25
26
27

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
Aaron Spring's avatar
Aaron Spring committed
28
29
30
31
32
33
34
35
36
```

## Quick start for `pyicon` locally

Install `cartopy` before install `pyicon`: `conda install -c conda-forge xarray cartopy dask matplotlib`

```bash
pip install git+https://gitlab.dkrz.de/m300602/pyicon.git
```