Skip to content

Commit b703e48

Browse files
committed
added variables maxdischarge: maximimum discharge of a day (of all substeps)
and avgdischarge of a day (of all substeps) Some changes in the documentation
1 parent b42d3f8 commit b703e48

22 files changed

+681
-72
lines changed

Toolkit/documentation/10_zambezi.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
.. raw:: html
2+
3+
<pre style="font-size: 0.7em;">
4+
Todo en la tierra se encrespó, la zarza
5+
clavó y el hilo verde
6+
mordía, el pétalo cayó cayendo
7+
hasta que única flor fue la caída
8+
Pablo Neruda Agua
9+
</pre>
10+
11+
112
#######################
213
**10. Example Zambezi**
314
#######################

Toolkit/documentation/13_glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ I
200200
=
201201

202202
**IIASA**
203-
International Institute for Applied Systems Analysis - Austrian research institute that developed and maintains CWatM.
203+
International Institute for Applied Systems Analysis - Research institute based in Austria that developed and maintains CWatM.
204204

205205
**Infiltration**
206206
Process of water entering soil from the surface. Rate depends on soil properties, moisture content, and surface conditions.

Toolkit/documentation/1_introduction.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
.. raw:: html
2+
3+
<pre style="font-size: 0.7em;">
4+
Per correr miglior acque alza le vel
5+
omai la navicella del mio ingegno
6+
Dante Alighieri, Purgatorio, 1-2
7+
</pre>
8+
9+
110

211
###################
312
**1. Introduction**

Toolkit/documentation/2_news.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
.. raw:: html
2+
3+
<pre style="font-size: 0.7em;">
4+
La mar es el origen de todas lasaguas,
5+
y el corazon del hombre, el origen de
6+
todas los males
7+
Miguel de Cervantes, Don Quijote
8+
</pre>
9+
110

211
###########
312
**2. NEWS**

Toolkit/documentation/3_modeldesign.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
.. raw:: html
2+
3+
<pre style="font-size: 0.7em;">
4+
A lake is the landscape's most beautiful
5+
and expressive feature. It is Earth's eye;
6+
looking into which the beholder measures
7+
the depth of his own nature
8+
Henry David Thoreau, Walden
9+
</pre>
10+
111
################################
212
**3. The Community Water Model**
313
################################

Toolkit/documentation/4_UsingCwatM.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
.. raw:: html
2+
3+
<pre style="font-size: 0.7em;">
4+
古池や
5+
蛙飛びこむ
6+
水の音
7+
Matsuo Bashō
8+
</pre>
9+
110

211
##################
312
**4. Using CWatM**
@@ -22,6 +31,9 @@ Guillaumot, L., Smilovic, M., Burek, P., de Bruijn, J., Greve, P., Kahil, T., an
2231

2332
Burek, P., Smilovic, M., Guillaumot, L., de Bruijn, J., Greve, P., Satoh, Y., Islaam, A., Virgen-Urcelay, A., Tang, T., Kahil, T., and Wada, Y.: Community Water Model CWatM Manual, Laxenburg, Austria, IIASA Report, 2020.
2433

34+
If you use CWatM with wastewater or with pySnowClim (publication soon) please cite those publications, too.
35+
36+
Fridman, D., Smilovic, M., Burek, P., Tramberend, S., and Kahil, T.: Wastewater matters: incorporating wastewater treatment and reuse into a process-based hydrological model (CWatM v1.08), Geosci. Model Dev., 18, 3735–3754, https://doi.org/10.5194/gmd-18-3735-2025
2537

2638

2739
Downloading CWatM
@@ -53,20 +65,20 @@ OGGM
5365

5466
"OGGM is an open source modelling framework for glaciers. The model can simulate past and future mass-balance, volume and geometry of (almost) any glacier in the world in a fully automated and extensible workflow. OGGM is modular and supports novel modelling workflows: it loves to be remixed and reused! OGGM also brings together a vibrant and friendly community of scientists, modellers and educators." https://oggm.org/ (24/10/25)
5567

56-
Sarah Hanus, University of Zurich, Switzerland, linked OGGM and CWatM:
68+
Sarah Hanus, University of Zurich, Switzerland, linked OGGM and CWatM (you run OGGM and postprocess the results with the tools from L. Schuster and S. Hanus and then you can load it into CWatM)
5769

5870
Hanus, S., Schuster, L., Burek, P., Maussion, F., Wada, Y., and Viviroli, D.: Coupling a large-scale glacier and hydrological model (OGGM v1.5.3 and CWatM V1.08) – towards an improved representation of mountain water resources in global assessments, Geosci. Model Dev., 17, 5123–5144, https://doi.org/10.5194/gmd-17-5123-2024
5971

6072
pySnowClim
6173
----------
6274

63-
Abby C. Lute and Aranildo Lima and her/his team coupled CWatM with a sophisticated energy-balanced snow model:
75+
Abby C. Lute, Aranildo Lima, Raj Shrestha and their team coupled CWatM with a sophisticated energy-balanced snow model:
6476

6577
Lute, A. C., Abatzoglou, J., and Link, T.: SnowClim v1.0: high-resolution snow model and data for the western United States, Geosci. Model Dev., 15, 5045–5071, https://doi.org/10.5194/gmd-15-5045-202
6678

67-
You now can choose if you want to use SnowClimPy or the degree-day approach.
79+
You now can choose if you want to use pySnowClim or the degree-day approach.
6880

69-
.. note:: 24/10/25 Works but still testing
81+
.. attention:: 1/11/25 Works but still testing
7082

7183

7284

@@ -79,7 +91,7 @@ Fork our code from https://github.com/iiasa/CWatM and create your own branch.
7991

8092
.. note:: a good documention on this has: https://pandas.pydata.org/pandas-docs/stable/development/contributing.html and https://docs.oggm.org/en/stable/contributing.html
8193

82-
We also have a pyTest framework
94+
We also have a pytest framework. See the :ref:`Testing framework <rst_testing>` for more information.
8395

8496
.. _license:
8597

Toolkit/documentation/52_settingsfile.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ StepInit indicate the date(s) when initial conditions are saved::
159159
Calibration
160160
************
161161

162-
Any parameter can be used for calibration, but we used those which are most effective. Please have a look at :ref:`rst_calibration`
162+
Any parameter can be used for calibration, but we used those which are most effective. See the :ref:`Calibration <rst_calibration>` for more information.
163163

164164
Calibration value can be a number (because it is not calibrated yet).
165165

Toolkit/documentation/57_reproduce.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
#######
3-
Recover
4-
#######
2+
###################
3+
Recover former runs
4+
###################
55

66
.. contents::
77
:depth: 3

Toolkit/documentation/58_tricks.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Tips and Tricks
88

99
Here we collect some tricks which may mentioned on other pages of the documentation, but are overseen and might be helpful.
1010

11+
Settings file
12+
=============
13+
1114
Notepad++ for settingsfile
1215
---------------------------
1316

@@ -31,9 +34,12 @@ of the basin and the upstream area
3134
.. note::
3235

3336
| If you start with a basin defined by the outlet of a basin e.g. 6.25 51.75
34-
| You can generate a new mask map for the following runs by:
35-
| **savebasinmap = True** in [OPTIONS]
36-
| a basin.tif is generated in the output folder, which you can copy and use next time as:
37+
| You can generate a new mask map for the following runs by adding in:
38+
| [OPTIONS]
39+
| **savebasinmap = True**
40+
41+
| a basin.tif and an upstream area map are generated in the output folder, which you can copy and use next time as:
42+
3743
| **MaskMap = your_directory/basin.tif**
3844
3945
Placeholder in settingsfile

Toolkit/documentation/5_howto.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
.. raw:: html
2+
3+
<pre style="font-size: 0.7em;">
4+
Des Menschen Seele gleicht dem Wasser:
5+
Vom Himmel kommt es, zum Himmel steigt es,
6+
und wieder nieder zur Erde muss es,
7+
ewig wechselnd
8+
Johann W. von Goethe
9+
Gesang der Geister über dem Wasser
10+
</pre>
11+
12+
113

214
#####################################
315
**5. HOW-TO-GUIDE** Problem oriented

0 commit comments

Comments
 (0)