Skip to content
Snippets Groups Projects
Commit 794ee2a0 authored by Nils Brüggemann's avatar Nils Brüggemann Committed by Fraser William Goldsworth
Browse files

README.md: Mentioned new installation option vie pypi.

parent 9722831b
No related branches found
No related tags found
1 merge request!42Draft: cartopy projections
...@@ -14,7 +14,14 @@ Pyicon is hosted at: (https://gitlab.dkrz.de/m300602/pyicon/) ...@@ -14,7 +14,14 @@ Pyicon is hosted at: (https://gitlab.dkrz.de/m300602/pyicon/)
## Quick start for pyicon ## Quick start for pyicon
Download pyicon with git: You can install pyicon via pip:
```bash
pip install pyicon-diagnostics
```
However, if you want to use the most recent development version, it is advisable to
download pyicon with git:
```bash ```bash
git clone git@gitlab.dkrz.de:m300602/pyicon.git git clone git@gitlab.dkrz.de:m300602/pyicon.git
...@@ -27,10 +34,11 @@ cd pyicon ...@@ -27,10 +34,11 @@ cd pyicon
pip install -e ./ pip install -e ./
``` ```
To assure that all necessary requirements are met, install them e.g. by If you notice that some requirements were not met by the installation, you can
also use conda to install the requirements:
```bash ```bash
conda env create -f ci/requirements_py39.yml conda env create -f ci/requirements_latest.yml
``` ```
or on DKRZ's super computer Levante use or on DKRZ's super computer Levante use
...@@ -40,6 +48,12 @@ module load python3/2023.01-gcc-11.2.0 ...@@ -40,6 +48,12 @@ module load python3/2023.01-gcc-11.2.0
pip install healpy pip install healpy
``` ```
To update pyicon, you only need to enter the pyicon directory update the git repository via
```bash
git pull
```
## Quick start for pyicon @DWD (Confluence, only intern) ## Quick start for pyicon @DWD (Confluence, only intern)
https://ninjoservices.dwd.de/wiki/display/KUQ/pyICON+for+ICON+with+NWP+physics https://ninjoservices.dwd.de/wiki/display/KUQ/pyICON+for+ICON+with+NWP+physics
...@@ -58,4 +72,4 @@ pip install git+https://gitlab.dkrz.de/m300602/pyicon.git ...@@ -58,4 +72,4 @@ pip install git+https://gitlab.dkrz.de/m300602/pyicon.git
``` ```
## Developing ## Developing
When adding new functions, make sure to document them with a docstring. This should detail what the function does, the arguments and what type of objects it returns. Examples are encouraged. We use so-called "numpy" style docstrings which are then automatically rendered into the sphinx documentation. A guide to numpy style docstrings is available [here](https://numpydoc.readthedocs.io/en/latest/format.html) and they even produce some nice [examples](https://numpydoc.readthedocs.io/en/latest/example.html#example). When adding new functions, make sure to document them with a docstring. This should detail what the function does, the arguments and what type of objects it returns. Examples are encouraged. We use so-called "numpy" style docstrings which are then automatically rendered into the sphinx documentation. A guide to numpy style docstrings is available [here](https://numpydoc.readthedocs.io/en/latest/format.html) and they even produce some nice [examples](https://numpydoc.readthedocs.io/en/latest/example.html#example).
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment