Merge branch '11-carsten_todo_documentation_-11_poetryinreadme' into 'dev'

added jupyter as dependency

See merge request !1

README.md

@@ -27,23 +27,33 @@ 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
 ```
 
-## Installing Dependencies
+## Installing Dependencies and Setting up Virtual Enviorment
 
-The handling of required packages is done with poetry. So run poetry in the project directory:
+The handling of required packages is done with poetry (https://python-poetry.org/).
+After installing poetry, you can simply install all required dependencies for this project by runing poetry in the project directory:
 ```
 poetry install
 ```
+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
+```
+and to run a script use
+```
+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 
 
@@ -80,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
 
 ```

pyproject.toml

@@ -20,6 +20,7 @@ ipykernel = "^6.26.0"
 compliance-checker = "^5.1.0"
 cartopy = "^0.22.0"
 ruff = "^0.1.13"
+jupyter = "^1.0.0"
 
 [build-system]
 requires = ["poetry-core"]