From 49529439317f878b71fbf7591cc9bb9c8f8b7412 Mon Sep 17 00:00:00 2001
From: Carsten Hinz <c.hinz@fz-juelich.de>
Date: Tue, 7 May 2024 11:53:45 +0200
Subject: [PATCH] added running of jupyter with poetry added tests subdirectory

---
 README.md | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 434036d..82a98dd 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,13 @@ poetry install
 
 # Example
 
-There are at the moment three example provided as jupyter notebooks (https://jupyter.org/):
+There are at the moment three example provided as jupyter notebooks (https://jupyter.org/).
+
+Running them with the python environment produced by peotry can be done by
+```
+poetry run jupyter notebook
+```
+
 ##  High level function
 ```
 tests/produce_data.ipynb 
@@ -53,20 +59,20 @@ This allows different griddings without the necessity to repeat the request to t
 
 ## Retrieving data
 ```
-get_sample_data.ipynb 
+tests/get_sample_data.ipynb 
 ```
 Downloads data from the TOAR database. The extracted data are written to disc. No further processing or gridding is done. 
 
 ## Retrieving data
 ```
-get_sample_data_manual.ipynb 
+tests/get_sample_data_manual.ipynb 
 ```
 Downloads data from the TOAR database with a manual creation of the request to the TOAR database.
 This example does not perform any gridding.
 
 ## Retriving data and visualization
 ```
-quality_controll.ipynb
+tests/quality_controll.ipynb
 ```
 Notebook for downloading and visualization of data. 
 The data are downloaded and reused for subsequent executions of this notebook.
@@ -75,7 +81,7 @@ The gridding is done on the downloaded data. Gridded data are not saved to disc.
 ## Benchmarks Requests to TOAR Database
 
 ```
-benchmark.py
+tests/benchmark.py
 ```
 This script requests datasets with different durations (days to month) from the TOAR Database and saves them to disc.
 It reports the duration for the different requests.
-- 
GitLab