Skip to content
Snippets Groups Projects

added jupyter as dependency

Merged added jupyter as dependency
11-carsten_todo_documentation_-11_poetryinreadme into dev
Merged Carsten Hinz requested to merge 11-carsten_todo_documentation_-11_poetryinreadme into dev
Viewing commit 6f7abab7
Prev
Show latest version
1 file
+ 5
− 5
Compare changes
  • Side-by-side
  • Inline
README.md
+ 5
− 5
@@ -27,7 +27,7 @@ Clone the project from its git repository:
```
git clone https://gitlab.jsc.fz-juelich.de/esde/toar-public/toargridding.git
```
With git we need to checkout the development branch. Therefore we need to change to the project directory first:
With git we need to checkout the development branch (dev). Therefore we need to change to the project directory first:
```
cd toargridding
git checkout dev
@@ -40,7 +40,7 @@ After installing poetry, you can simply install all required dependencies for th
```
poetry install
```
This also leads to a creation of a virtual enviorment.Virtual enviorment are designed to ensure, that different projects do not interfere with their dependencies.
This also creates a virtual enviorment, which ensures that different projects do not interfere with their dependencies.
To run a jupyter notebook in the virtual enviorment execute
```
poetry run jupyter notebook
@@ -53,7 +53,7 @@ poetry run python [/path/to/scriptname.py]
# How does this tool work?
This tool has two main parts. The first handles requests to the TOAR database and the analysis of the data.
The second part is the gridding, which is performed offline
The second part is the gridding, which is performed offline.
## Request to TOAR Database with Statistical Analysis
@@ -90,8 +90,8 @@ Provides an example on how to download data, apply gridding and save the results
The AnalysisServiceDownload caches already obtained data on the local machine.
This allows different griddings without the necessity to repeat the request to the TOARDB and subsequent download.
In total two requests are executed.
The example uses a dictionary to pass additional arguments to the request to the TAOR database (here: station category from TOAR).
In total two requests are executed by requesting different different statistical quantities (mean & dma8epax).
The example uses a dictionary to pass additional arguments to the request to the TAOR database (here: station category from TOAR 1).
A detailed list can be found at https://toar-data.fz-juelich.de/api/v2/#stationmeta
```