final touches: fixed many cells, made clarifications, deleted files n… (

#31) * final touches: fixed many cells, made clarifications, deleted files no longer needed. did run into a major bug in case 2, which will be addressed in a seperate issue. * Remove lisflood version fix cell, no longer needed * Ran Case2 from start to finish * removed spin up from notebook 1. This makes notebook one run the same year and basin as notebook 2. Co-authored-by: Stefan Verhoeven <[email protected]> Co-authored-by: Stefan Verhoeven <[email protected]>
eWaterCycle · Sep 30, 2021 · 7626ea4 · 7626ea4
1 parent fd49561
commit 7626ea4
Show file tree

Hide file tree

Showing 29 changed files with 236 additions and 15,776 deletions.
diff --git a/Case1_Marrmot_Merrimack_ESMValTool.ipynb b/Case1_Marrmot_Merrimack_ESMValTool.ipynb
diff --git a/Case2_wflow_LISFlood_merrimack_inc_ESMValtool.ipynb b/Case2_wflow_LISFlood_merrimack_inc_ESMValtool.ipynb
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# technicalPaperExampleNotebooks
-a collection of Jupyter notebooks used in the technical eWaterCycle paper
+# ewatercycle examples
+![image](https://github.com/eWaterCycle/ewatercycle/raw/main/docs/examples/logo.png)
+A collection of Jupyter notebooks accompanying the publication `The eWaterCycle platform for Open and FAIR Hydrological collaboration` (link follows). eWaterCycle is a platform for conducting computational hydrological research. See this video (link follows) for a short overview of the platform and its capabilities. See the publication for more details on the design choices made when building the platform. Finaly, see the [eWaterCycle package repository](https://doi.org/10.5281/zenodo.5119389) for the code behind the platform
+
+This repo contains five notebooks with use cases of computational hydrological research that illustrate the capabillities of the eWaterCycle platform. Those use cases are:
+
+1. a 'Hello world' use case demonstrating how a model is setup-up, how forcingdata is created using ESMValTool and how a model is run. The calculated river discharge is compared against GRDC observations. 
+2. a model comparison notebook where two (distributed) models are run for the same catchment and the generated discharge is compared against GRDC observations.
+3. a model coupling notebook where the output from one model is used as input for another model. Note that the models are written in different programming languages, but the hydrologist conducting the experiment can work from the (python) eWaterCycle environment.
+4. an experiment where the state of the model is changed during runtime. Each timestep the model state is altered to correct the calculated evaporation based on (Fluxnet) observed evaporation.
+5. A model calibration study where a model is run in parallel many times to calibrate its parameters based on observations. 
+
+The eWaterCycle platform, including the models used in the notebooks of this repository, can be installed on any sufficiently advanced computer. See the installation instructions for the [eWaterCycle package repository](https://doi.org/10.5281/zenodo.5119389). Currently no publicly accessable machine is available where any scientist can work on the eWaterCycle platform without having to install it themselves. This might change with future funding oppertunities (in which case this page will also be updated).
+
+More examples, for more different models, can be found in the
+[eWaterCycle documentation](https://ewatercycle.readthedocs.io).
+
+## License
+
+Copyright (c) 2021, Netherlands eScience Center & Delft University of
+Technology
+
+Apache Software License 2.0
diff --git a/case0HelloWorldHydrograph.png b/case0HelloWorldHydrograph.png
diff --git a/case1HelloWorldsHydrograph.png b/case1HelloWorldsHydrograph.png
diff --git a/case2CouplingModels.png b/case2CouplingModels.png
diff --git a/figures/Case3_ForcePCRGlobWithAdditionalDataHydrograph.png b/figures/Case3_ForcePCRGlobWithAdditionalDataHydrograph.png
diff --git a/figures/Case3_ForcePCRGlobWithAdditionalDataMap.png b/figures/Case3_ForcePCRGlobWithAdditionalDataMap.png
diff --git a/figures/case1_HelloWorldHydrograph.png b/figures/case1_HelloWorldHydrograph.png
diff --git a/figures/case2_HelloWorldsHydrograph.png b/figures/case2_HelloWorldsHydrograph.png
diff --git a/notebooksToWorkOutSmallSteps/.\..\modelrunCase2Full.pckl b/notebooksToWorkOutSmallSteps/.\..\modelrunCase2Full.pckl