Skip to content

Commit 3f6c6a9

Browse files
authored
Add extras and readme (#13)
* improved the readme * niceties to the other files in this repo
1 parent 52d3d33 commit 3f6c6a9

File tree

5 files changed

+88
-15
lines changed

5 files changed

+88
-15
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
11
# eWaterCycle Projects
22

33
This repository collect projects that showcase how eWaterCycle works, including student projects.
4+
5+
The intended way to look at this repository is by using the [teachbook](https://www.ewatercycle.org/projects/main/intro.html).
6+
7+
We have projects from different levels of education, including:
8+
- Bachelor of Science (BSc) projects
9+
- Master of Science (MSc) projects
10+
- PhD/PostDoc/Research projects
11+
12+
## Table of Contents
13+
- [Bachelor of Science (BSc) Projects](https://www.ewatercycle.org/projects/main/thesis_projects/BSc/overview_BSc_thesis_projects.html)
14+
- [Master of Science (MSc) Projects](https://www.ewatercycle.org/projects/main/thesis_projects/MSc/overview_MSc_thesis_projects.html)
15+
- [Research Projects](https://www.ewatercycle.org/projects/main/thesis_projects/Research/overview_research_projects.html)
16+
- [Tutorials](https://www.ewatercycle.org/projects/main/tutorials_examples/intro_tutorials_examples.html)
17+
- [References](https://www.ewatercycle.org/projects/main/references.html)
18+
19+
Projects counter:
20+
- BSc projects: 4
21+
- MSc projects: 0
22+
- PhD/PostDoc/Research projects: 1
23+
24+
## eWaterCycle
25+
26+
The [eWaterCycle](https://ewatercycle.readthedocs.io/en/latest/index.html) Python package brings together many components from the eWaterCycle project.
27+
An overall goal of this project is to make hydrological modelling fully reproducible, open, and FAIR.
28+
29+
Typically, the eWaterCycle platform is deployed on a system that can be accessed through the browser via JupyterHub, and comes preconfigured with readily available parameter sets, meteorological forcing data, model images, etcetera.
30+
This makes it possible for researchers to quickly run an experiment without the hassle of installing a model or creating suitable input data.
31+
To learn more about the system setup, read our [System setup](https://ewatercycle.readthedocs.io/en/latest/system_setup.html) page.

book/_toc.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,7 @@ parts:
110110
sections:
111111
- file: tutorials_examples/1_HBV_Caravan_ERA5/example_model_run_HBV.ipynb
112112
- file: tutorials_examples/2_HBV_PCRGlobWB_ERA5/example_model_run_pcrglobwb.ipynb
113-
- caption: References and credits
113+
- caption: Credits
114114
chapters:
115-
- file: references.md
116115
- file: changelog.md
117116
- file: credits.md

book/changelog.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
# Changelog
22

3-
## `<date>` [`<release name>`](<`link to release on GitHub>`)
4-
- `<Added/modified/deleted>` [](`<relative link to changed file>`)
3+
[//]: # ( ## `<date>` [`<release name>`](<`link to release on GitHub>`)
4+
[//]: # (- `<Added/modified/deleted>` [](`<relative link to changed file>`)
5+
6+
### March 2025
7+
- updated the projects page, making it ready for new projects
8+
- added eWaterCycle paper
9+
10+
### April 2025
11+
- added Bachelor report of Ischa Hollemans
12+
- added Bachelor report of Thirza van Esch

book/credits.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
1-
(credits)=
21
# Credits and License
32

4-
You can refer to this book as:
53

6-
> `<editors>` (`<year>`) _`<title>`_. `<url to github repo>`
4+
> `Rolf Hut` (`2022-present`) _`Developping eWaterCycle`_.
5+
>
6+
> `Mark Melotto` (`2025-present`) _`Maintaining eWaterCycle`_.
77
88
The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors.
99

10-
You can refer to individual chapters or pages within this book as:
1110

12-
> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>`
13-
14-
We anticipate that the content of this book will change significantly. Therefore, we recommend using the source code directly with the citation above that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. However, we make no guarantee, so if it is important for you to reference a specific location within the book. For example:
11+
## How the book is made
1512

16-
> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>` (`./book/intro/` chapter, accessed November, 2024).
13+
This book is created using open source tools: it is a JupyterBook that is written using Markdown and Jupyter notebooks.
14+
Additional tooling is used from the [TeachBooks initiative](https://teachbooks.io/) to enhance the editing and reading experience.
15+
The files are stored on a [public GitHub repository](https://github.com/eWaterCycle/projects/tree/main).
16+
The website can be viewed at https://www.ewatercycle.org/projects/main/intro.html.
17+
View the repository README file or contact the authors for additional information.
1718

18-
## How the book is made
19+
- Mark Melotto: [email protected]
20+
- Rolf Hut: [email protected]
1921

20-
This book is created using open source tools: it is a JupyterBook that is written using Markdown and Jupyter notebooks. Additional tooling is used from the [TeachBooks initiative](https://teachbooks.io/) to enhance the editing and reading experience. The files are stored on a [public GitHub repository](`<link to GitHub repo>`). The website can be viewed at `<link to book website url>`. View the repository README file or contact the authors for additional information.
2122

22-
(editor)=
2323
## About the Editors
2424

25+
A cool origin story.
26+
2527
### Acknowledgements
28+
29+
eScienceCenter team
30+
All the students that have used the eWaterCycle platform for their thesis projects.

book/credits_old.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Credits and License
2+
3+
You can refer to this book as:
4+
5+
> `Mark Melotto` (`2025`) _`Maintaining eWaterCycle`_.
6+
7+
The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors.
8+
9+
You can refer to individual chapters or pages within this book as:
10+
11+
> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>`
12+
13+
We anticipate that the content of this book will change significantly. Therefore, we recommend using the source code directly with the citation above that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. However, we make no guarantee, so if it is important for you to reference a specific location within the book. For example:
14+
15+
> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>` (`./book/intro/` chapter, accessed November, 2024).
16+
17+
## How the book is made
18+
19+
This book is created using open source tools: it is a JupyterBook that is written using Markdown and Jupyter notebooks.
20+
Additional tooling is used from the [TeachBooks initiative](https://teachbooks.io/) to enhance the editing and reading experience.
21+
The files are stored on a [public GitHub repository](https://github.com/eWaterCycle/projects/tree/main).
22+
The website can be viewed at https://www.ewatercycle.org/projects/main/intro.html.
23+
View the repository README file or contact the authors for additional information.
24+
25+
- Mark Melotto: [email protected]
26+
- Rolf Hut: [email protected]
27+
28+
29+
## About the Editors
30+
31+
### Acknowledgements
32+
33+
All the students that have used the eWaterCycle platform for their thesis projects.

0 commit comments

Comments
 (0)