-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathsetup.html
2176 lines (2147 loc) · 158 KB
/
setup.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>4. Setup of the model — Community Water Model</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="_static/iiasa.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="5. Tutorial" href="tutorial.html" />
<link rel="prev" title="3. Publication" href="publication.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Community Water Model
<img src="_static/IIASA_logo_white.png" class="logo" alt="Logo"/>
</a>
<div class="version">
1.0.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="modeldesign.html">2. Model Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="publication.html">3. Publication</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">4. Setup of the model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#setup-python-version">Setup python version</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#python">Python</a></li>
<li class="toctree-l3"><a class="reference internal" href="#external-libraries">External libraries</a></li>
<li class="toctree-l3"><a class="reference internal" href="#installing">Installing</a></li>
<li class="toctree-l3"><a class="reference internal" href="#c-libraries">C++ libraries</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#pre-compiled-c-libraries">Pre-compiled C++ libraries</a></li>
<li class="toctree-l4"><a class="reference internal" href="#compiling-a-version">Compiling a version</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#error-and-exeption-handling">Error and exeption handling</a></li>
<li class="toctree-l3"><a class="reference internal" href="#test-the-python-version">Test the Python version</a></li>
<li class="toctree-l3"><a class="reference internal" href="#run-the-python-version">Run the Python version</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#flags">Flags</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#netcdf-meta-data">NetCDF meta data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#test-the-data">Test the data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#settings-file">Settings file</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#components-of-the-settings-file">Components of the settings file</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#general-flags">General flags</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id4">NetCDF meta data</a></li>
<li class="toctree-l4"><a class="reference internal" href="#path-of-data-output">Path of data, output</a></li>
<li class="toctree-l4"><a class="reference internal" href="#defining-the-modeling-area">Defining the modeling area</a></li>
<li class="toctree-l4"><a class="reference internal" href="#defining-the-time">Defining the time</a></li>
<li class="toctree-l4"><a class="reference internal" href="#initial-conditions">Initial conditions</a></li>
<li class="toctree-l4"><a class="reference internal" href="#output">Output</a></li>
<li class="toctree-l4"><a class="reference internal" href="#reading-information">Reading information</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#sections-of-information">Sections of information</a></li>
<li class="toctree-l3"><a class="reference internal" href="#complete-settings-file">Complete settings file</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id5">NetCDF meta data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#output-meta-netcdf-information">Output Meta NetCDF information</a></li>
<li class="toctree-l3"><a class="reference internal" href="#name-and-location-of-the-netcdf-meta-data-file">Name and location of the NetCDF meta data file</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#initialisation">Initialisation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#example-of-soil-moisture">Example of soil moisture</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cold-start">Cold start</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#set-up-a-cold-start-in-the-settingsfile">Set up a cold start in the settingsfile</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#storing-initial-variables">Storing initial variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="#warm-start">Warm start</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id6">Set up a cold start in the settingsfile</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#rst-initialcondition">Initial conditions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#model-output">Model Output</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#time-depending-and-non-depending-output-maps">Time depending and non depending output maps</a></li>
<li class="toctree-l3"><a class="reference internal" href="#or-time-series-at-specified-points">Or time series at specified points</a></li>
<li class="toctree-l3"><a class="reference internal" href="#output-variables">Output variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="#daily-monthly-at-the-end-or-average">Daily, monthly - at the end or average</a></li>
<li class="toctree-l3"><a class="reference internal" href="#time-series-as-point-infomation-or-catchment-sum-or-average">Time series as point infomation or catchment sum or average</a></li>
<li class="toctree-l3"><a class="reference internal" href="#most-important-output-variables-a-selection">Most important output variables - a selection</a></li>
<li class="toctree-l3"><a class="reference internal" href="#output-variables-starting-a-list">Output variables - starting a list</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">5. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="errorHandling.html">6. Error handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="listVariables.html">7. List of output variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">8. Demo of the model</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">9. The Model Itself</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">10. Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="calibration.html">11. Calibration tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="calibration_tutorial.html">12. Calibration tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="resolution.html">13. Increasing resolution</a></li>
<li class="toctree-l1"><a class="reference internal" href="zambezi.html">14. Example Zambezi</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">15. License and download info</a></li>
<li class="toctree-l1"><a class="reference internal" href="sourcecode.html">16. Source code</a></li>
<li class="toctree-l1"><a class="reference internal" href="forum.html">17. Forum</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Community Water Model</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active"><span class="section-number">4. </span>Setup of the model</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/setup.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="setup-of-the-model">
<h1><a class="toc-backref" href="#id8" role="doc-backlink"><span class="section-number">4. </span>Setup of the model</a><a class="headerlink" href="#setup-of-the-model" title="Permalink to this heading"></a></h1>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#setup-of-the-model" id="id8">Setup of the model</a></p>
<ul>
<li><p><a class="reference internal" href="#setup-python-version" id="id9">Setup python version</a></p>
<ul>
<li><p><a class="reference internal" href="#python" id="id10">Python</a></p></li>
<li><p><a class="reference internal" href="#external-libraries" id="id11">External libraries</a></p></li>
<li><p><a class="reference internal" href="#installing" id="id12">Installing</a></p></li>
<li><p><a class="reference internal" href="#c-libraries" id="id13">C++ libraries</a></p>
<ul>
<li><p><a class="reference internal" href="#pre-compiled-c-libraries" id="id14">Pre-compiled C++ libraries</a></p></li>
<li><p><a class="reference internal" href="#compiling-a-version" id="id15">Compiling a version</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#error-and-exeption-handling" id="id16">Error and exeption handling</a></p></li>
<li><p><a class="reference internal" href="#test-the-python-version" id="id17">Test the Python version</a></p></li>
<li><p><a class="reference internal" href="#run-the-python-version" id="id18">Run the Python version</a></p>
<ul>
<li><p><a class="reference internal" href="#flags" id="id19">Flags</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#netcdf-meta-data" id="id20">NetCDF meta data</a></p></li>
<li><p><a class="reference internal" href="#test-the-data" id="id21">Test the data</a></p></li>
<li><p><a class="reference internal" href="#settings-file" id="id22">Settings file</a></p>
<ul>
<li><p><a class="reference internal" href="#components-of-the-settings-file" id="id23">Components of the settings file</a></p>
<ul>
<li><p><a class="reference internal" href="#general-flags" id="id24">General flags</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id25">NetCDF meta data</a></p></li>
<li><p><a class="reference internal" href="#path-of-data-output" id="id26">Path of data, output</a></p></li>
<li><p><a class="reference internal" href="#defining-the-modeling-area" id="id27">Defining the modeling area</a></p></li>
<li><p><a class="reference internal" href="#defining-the-time" id="id28">Defining the time</a></p></li>
<li><p><a class="reference internal" href="#initial-conditions" id="id29">Initial conditions</a></p></li>
<li><p><a class="reference internal" href="#output" id="id30">Output</a></p></li>
<li><p><a class="reference internal" href="#reading-information" id="id31">Reading information</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#sections-of-information" id="id32">Sections of information</a></p></li>
<li><p><a class="reference internal" href="#complete-settings-file" id="id33">Complete settings file</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#id5" id="id34">NetCDF meta data</a></p>
<ul>
<li><p><a class="reference internal" href="#output-meta-netcdf-information" id="id35">Output Meta NetCDF information</a></p></li>
<li><p><a class="reference internal" href="#name-and-location-of-the-netcdf-meta-data-file" id="id36">Name and location of the NetCDF meta data file</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#initialisation" id="id37">Initialisation</a></p>
<ul>
<li><p><a class="reference internal" href="#example-of-soil-moisture" id="id38">Example of soil moisture</a></p></li>
<li><p><a class="reference internal" href="#cold-start" id="id39">Cold start</a></p>
<ul>
<li><p><a class="reference internal" href="#set-up-a-cold-start-in-the-settingsfile" id="id40">Set up a cold start in the settingsfile</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#storing-initial-variables" id="id41">Storing initial variables</a></p></li>
<li><p><a class="reference internal" href="#warm-start" id="id42">Warm start</a></p>
<ul>
<li><p><a class="reference internal" href="#id6" id="id43">Set up a cold start in the settingsfile</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#rst-initialcondition" id="id44">Initial conditions</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#model-output" id="id45">Model Output</a></p>
<ul>
<li><p><a class="reference internal" href="#time-depending-and-non-depending-output-maps" id="id46">Time depending and non depending output maps</a></p></li>
<li><p><a class="reference internal" href="#or-time-series-at-specified-points" id="id47">Or time series at specified points</a></p></li>
<li><p><a class="reference internal" href="#output-variables" id="id48">Output variables</a></p></li>
<li><p><a class="reference internal" href="#daily-monthly-at-the-end-or-average" id="id49">Daily, monthly - at the end or average</a></p></li>
<li><p><a class="reference internal" href="#time-series-as-point-infomation-or-catchment-sum-or-average" id="id50">Time series as point infomation or catchment sum or average</a></p></li>
<li><p><a class="reference internal" href="#most-important-output-variables-a-selection" id="id51">Most important output variables - a selection</a></p></li>
<li><p><a class="reference internal" href="#output-variables-starting-a-list" id="id52">Output variables - starting a list</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<section id="setup-python-version">
<span id="rst-setupdoc"></span><h2><a class="toc-backref" href="#id9" role="doc-backlink">Setup python version</a><a class="headerlink" href="#setup-python-version" title="Permalink to this heading"></a></h2>
<section id="python">
<h3><a class="toc-backref" href="#id10" role="doc-backlink">Python</a><a class="headerlink" href="#python" title="Permalink to this heading"></a></h3>
<p>CWatM requires having <a class="reference external" href="https://www.python.org/downloads/">Python</a>.
Downloading Python and the required Python packages is covered in our <a class="reference external" href="https://youtu.be/l3OW9b32SVo">YouTube tutorial</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>CWatM is tested for Python 3.7+. We recommend using the most recent release.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>a 64-bit version is necessary. This is generally the download default.</p>
</div>
</section>
<section id="external-libraries">
<h3><a class="toc-backref" href="#id11" role="doc-backlink">External libraries</a><a class="headerlink" href="#external-libraries" title="Permalink to this heading"></a></h3>
<p>These five Python packages are needed:</p>
<ol class="arabic simple">
<li><p><a class="reference external" href="http://www.numpy.org">NumPy</a></p></li>
<li><p><a class="reference external" href="https://www.scipy.org">SciPy</a></p></li>
<li><p><a class="reference external" href="https://pypi.python.org/pypi/netCDF4">netCDF4</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/pandas">pandas</a></p></li>
</ol>
<p>These four libraries can be installed with pip, conda, or downloaded at <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs">Unofficial Windows Binaries for Python Extension Packages</a></p>
<ol class="arabic simple" start="5">
<li><p><a class="reference external" href="http://www.gdal.org">GDAL</a></p></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<div class="line-block">
<div class="line"><strong>Troublemaker GDAL</strong></div>
<div class="line">Installing GDAL via pip can be troublesome. We recommend downloading the library from</div>
<div class="line"><a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs">Unofficial Windows Binaries for Python Extension Packages</a></div>
<div class="line">as GDAL-3.0.4-cp311-cp311m-win_amd64.whl (depending on your Python version) and installing as:</div>
<div class="line">pip install C:/Users/XXXXX/Downloads/GDAL-3.0.4-cp37-cp37m-win_amd64.whl</div>
<div class="line"><br /></div>
<div class="line">Sometimes problems occur if you have installed GDAL separately (or a software did, like QGIS)</div>
</div>
</div>
<p>These additional packages are used for the post-processing Notebooks (in CWatM/Toolkit)</p>
<ul class="simple">
<li><p><a class="reference external" href="https://pypi.org/project/notebook/">Jupyter Notebook</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/plotly/">plotly</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/XlsxWriter/">XlsxWriter</a></p></li>
</ul>
<p>These additional packages are used for CWatM-MODFLOW</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.usgs.gov/software/flopy-python-package-creating-running-and-post-processing-modflow-based-models">FloPy</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/xmipy">xmipy</a></p></li>
</ul>
</section>
<section id="installing">
<h3><a class="toc-backref" href="#id12" role="doc-backlink">Installing</a><a class="headerlink" href="#installing" title="Permalink to this heading"></a></h3>
<p>CWatM can be cloned through our <a class="reference external" href="https://github.com/iiasa/CWatM">CWatM GitHub repository</a>.</p>
<p>For those new to GitHub, we recommend using <a class="reference external" href="https://desktop.github.com/">GitHub desktop</a>.</p>
<p>Getting CWatM with GitHub desktop is covered in our <a class="reference external" href="https://youtu.be/9JMBwo4eESk">YouTube tutorial</a>.</p>
<p>Input data to run CWatM at 30 arcminutes (~50 km x 50km) are available through our
<a class="reference external" href="https://github.com/iiasa/CWatM-Earth-30min">CWatM-Earth-30min GitHub repository</a>.</p>
</section>
<section id="c-libraries">
<h3><a class="toc-backref" href="#id13" role="doc-backlink">C++ libraries</a><a class="headerlink" href="#c-libraries" title="Permalink to this heading"></a></h3>
<p>For the computational time demanding parts e.g. routing, CWatM comes with a C++ library. A pre-compiled version is included for Windows and Linux. Normally, you don’t have to do anything and the pre-compiled version should just work.</p>
<section id="pre-compiled-c-libraries">
<h4><a class="toc-backref" href="#id14" role="doc-backlink">Pre-compiled C++ libraries</a><a class="headerlink" href="#pre-compiled-c-libraries" title="Permalink to this heading"></a></h4>
<div class="line-block">
<div class="line"><strong>Windows and CYGWIN_NT-6.1</strong></div>
<div class="line">a compiled version is provided and CWatM is detecting automatically which system is running and which compiled version is needed</div>
</div>
<div class="line-block">
<div class="line"><strong>Linux</strong></div>
<div class="line">For Cygwin linux a compiled version <em>t5cyg.so</em> is provided in <em>../cwatm/hydrological_modules/routing_reservoirs/</em> for version CYGWIN_NT-6.1.</div>
<div class="line">If you use another cygwin version please compile it by yourself and name it <em>t5_linux.so</em></div>
</div>
<p>For Linux Ubuntu a compiled version is provided as <em>t5_linux.so</em>. The file is in <em>../cwatm/hydrological_modules/routing_reservoirs/</em></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you use another Linux version or the compiled version is not working or you have a compiler which produce faster executables please compile a version on your own.</p>
</div>
</section>
<section id="compiling-a-version">
<h4><a class="toc-backref" href="#id15" role="doc-backlink">Compiling a version</a><a class="headerlink" href="#compiling-a-version" title="Permalink to this heading"></a></h4>
<p>C++ sourcecode is in <em>../cwatm/hydrological_modules/routing_reservoirs/t5.cpp</em></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A compiled version is already provided for Windows and Linux.</p>
</div>
<p><strong>Windows</strong></p>
<p>A compiled version is provided, but maybe you have a faster compiler than the “Minimalist GNU for Windows” or “Microsoft Visual Studio 14.0” we used.</p>
<p>To compile with g++:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span>\<span class="n">g</span><span class="o">++</span> <span class="o">-</span><span class="n">c</span> <span class="o">-</span><span class="n">fPIC</span> <span class="o">-</span><span class="n">Ofast</span> <span class="n">t5</span><span class="o">.</span><span class="n">cpp</span> <span class="o">-</span><span class="n">o</span> <span class="n">t5</span><span class="o">.</span><span class="n">o</span>
<span class="o">..</span>\<span class="n">g</span><span class="o">++</span> <span class="o">-</span><span class="n">shared</span> <span class="o">-</span><span class="n">Ofast</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">soname</span><span class="p">,</span><span class="n">t5</span><span class="o">.</span><span class="n">so</span> <span class="o">-</span><span class="n">o</span> <span class="n">t5</span><span class="o">.</span><span class="n">so</span> <span class="n">t5</span><span class="o">.</span><span class="n">o</span>
</pre></div>
</div>
<p>To compile with Microsoft Visual Studio 14.0:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">call</span> <span class="s2">"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC</span><span class="se">\b</span><span class="s2">in</span><span class="se">\a</span><span class="s2">md64/vcvars64.bat"</span>
<span class="n">cl</span> <span class="o">/</span><span class="n">LD</span> <span class="o">/</span><span class="n">O2</span> <span class="n">t5</span><span class="o">.</span><span class="n">cpp</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<dl>
<dt>We used Visual Studio, because it seems to be computational faster</dt><dd><div class="line-block">
<div class="line">the libray used with Windows is named <em>t5.dll</em>, if you generate a libray <em>t5.so</em> the filename in <strong>../cwatm/management_modules/globals.py</strong> has to be changed!</div>
</div>
</dd>
</dl>
</div>
<p><strong>Linux</strong></p>
<p>To compile with g++:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">..</span>\<span class="n">g</span><span class="o">++</span> <span class="o">-</span><span class="n">c</span> <span class="o">-</span><span class="n">fPIC</span> <span class="o">-</span><span class="n">Ofast</span> <span class="n">t5</span><span class="o">.</span><span class="n">cpp</span> <span class="o">-</span><span class="n">o</span> <span class="n">t5_linux</span><span class="o">.</span><span class="n">o</span>
<span class="o">..</span>\<span class="n">g</span><span class="o">++</span> <span class="o">-</span><span class="n">shared</span> <span class="o">-</span><span class="n">Ofast</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">soname</span><span class="p">,</span><span class="n">t5_linux</span><span class="o">.</span><span class="n">so</span> <span class="o">-</span><span class="n">o</span> <span class="n">t5_linux</span><span class="o">.</span><span class="n">so</span> <span class="n">t5_linux</span><span class="o">.</span><span class="n">o</span>
<span class="ow">or</span>
<span class="o">..</span>\<span class="n">g</span><span class="o">++</span> <span class="o">-</span><span class="n">c</span> <span class="o">-</span><span class="n">Ofast</span> <span class="n">t5</span><span class="o">.</span><span class="n">cpp</span> <span class="o">-</span><span class="n">o</span> <span class="n">t5_linux</span><span class="o">.</span><span class="n">o</span>
<span class="o">..</span>\<span class="n">g</span><span class="o">++</span> <span class="o">-</span><span class="n">shared</span> <span class="o">-</span><span class="n">Ofast</span> <span class="o">-</span><span class="n">Wl</span><span class="p">,</span><span class="o">-</span><span class="n">soname</span><span class="p">,</span><span class="n">t5_linux</span><span class="o">.</span><span class="n">so</span> <span class="o">-</span><span class="n">o</span> <span class="n">t5_linux</span><span class="o">.</span><span class="n">so</span> <span class="n">t5_linux</span><span class="o">.</span><span class="n">o</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Please rename your compiled version to t5_linux.so! At the moment the file t5_linux.so is compiled with Ubuntu Linux</p>
</div>
</section>
</section>
<section id="error-and-exeption-handling">
<h3><a class="toc-backref" href="#id16" role="doc-backlink">Error and exeption handling</a><a class="headerlink" href="#error-and-exeption-handling" title="Permalink to this heading"></a></h3>
<p>We try to make our program behave properly when encountering unexpected conditions. Therefore we caption a number of possible wrong inputs.</p>
<p>If you get an output with an error number please look at <a class="reference internal" href="errorHandling.html#rst-error"><span class="std std-ref">Error handling</span></a></p>
</section>
<section id="test-the-python-version">
<h3><a class="toc-backref" href="#id17" role="doc-backlink">Test the Python version</a><a class="headerlink" href="#test-the-python-version" title="Permalink to this heading"></a></h3>
<p>From a terminal inside the CWatM folder, Run from the command line:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_cwatm</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>The output should be:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Running</span> <span class="n">under</span> <span class="n">platform</span><span class="p">:</span> <span class="n">Windows</span> <span class="o">**</span><span class="p">(</span><span class="ow">or</span> <span class="n">Linux</span> <span class="n">etc</span><span class="p">)</span><span class="o">**</span>
<span class="n">CWatM</span> <span class="o">-</span> <span class="n">Community</span> <span class="n">Water</span> <span class="n">Model</span>
<span class="n">Authors</span><span class="p">:</span> <span class="o">...</span>
<span class="n">Version</span><span class="p">:</span> <span class="o">...</span>
<span class="n">Date</span><span class="p">:</span> <span class="o">...</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If python is not set in the environment path, the full path of python has to be used</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>We are using run_cwatm.py inside the main repository (CWatM\run_cwatm.py), not one folder deeper (CWatM\cwatm\run_cwatm.py).</p>
</div>
</section>
<section id="run-the-python-version">
<h3><a class="toc-backref" href="#id18" role="doc-backlink">Run the Python version</a><a class="headerlink" href="#run-the-python-version" title="Permalink to this heading"></a></h3>
<p>Run from the command line:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_cwatm</span><span class="o">.</span><span class="n">py</span> <span class="n">settingsfile</span> <span class="n">flags</span>
</pre></div>
</div>
<p>example (from inside the CWatM folder):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_cwatm</span><span class="o">.</span><span class="n">py</span> <span class="n">settings</span><span class="o">.</span><span class="n">ini</span>
</pre></div>
</div>
<p>or with more information and an overview of computational runtime:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_cwatm</span><span class="o">.</span><span class="n">py</span> <span class="n">settings</span><span class="o">.</span><span class="n">ini</span> <span class="o">-</span><span class="n">l</span> <span class="o">-</span><span class="n">t</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If python is not set in the environment path, the full path of python has to be used</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The model needs a settings file as an argument. See: <a class="reference internal" href="#rst-settingdoc"><span class="std std-ref">Settings file</span></a></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>it is also possible to use paths with white spaces or dots. An easy way to avoid this is using relative paths, but is is also possible with absolute paths.</p>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"C:/Python 37/python"</span> <span class="s2">"C:/CWatM Hydrologic.modeling/CWatM/run_cwatm.py"</span> <span class="s2">"C:/CWatM Hydrologic.modeling/settings .rhine30min.ini"</span> <span class="o">-</span><span class="n">l</span>
<span class="n">But</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">settingsfile</span> <span class="n">do</span> <span class="ow">not</span> <span class="n">use</span> <span class="n">apostrophe</span> <span class="s2">""</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">:</span>
<span class="n">PathRoot</span> <span class="o">=</span> <span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">CWatM</span> <span class="n">Hydrologic</span><span class="o">.</span><span class="n">modeling</span>
</pre></div>
</div>
<section id="flags">
<h4><a class="toc-backref" href="#id19" role="doc-backlink">Flags</a><a class="headerlink" href="#flags" title="Permalink to this heading"></a></h4>
<p>Flags can be used to change the runtime output on the screen</p>
<p>example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">q</span> <span class="o">--</span><span class="n">quiet</span> <span class="n">output</span> <span class="n">progression</span> <span class="n">given</span> <span class="k">as</span> <span class="o">.</span>
<span class="o">-</span><span class="n">v</span> <span class="o">--</span><span class="n">veryquiet</span> <span class="n">no</span> <span class="n">output</span> <span class="n">progression</span> <span class="ow">is</span> <span class="n">given</span>
<span class="o">-</span><span class="n">l</span> <span class="o">--</span><span class="n">loud</span> <span class="n">output</span> <span class="n">progression</span> <span class="n">given</span> <span class="k">as</span> <span class="n">time</span> <span class="n">step</span><span class="p">,</span> <span class="n">date</span> <span class="ow">and</span> <span class="n">discharge</span>
<span class="o">-</span><span class="n">c</span> <span class="o">--</span><span class="n">check</span> <span class="nb">input</span> <span class="n">maps</span> <span class="ow">and</span> <span class="n">stack</span> <span class="n">maps</span> <span class="n">are</span> <span class="n">checked</span><span class="p">,</span> <span class="n">output</span> <span class="k">for</span> <span class="n">each</span> <span class="nb">input</span> <span class="nb">map</span> <span class="n">BUT</span> <span class="n">no</span> <span class="n">model</span> <span class="n">run</span>
<span class="o">-</span><span class="n">h</span> <span class="o">--</span><span class="n">noheader</span> <span class="o">.</span><span class="n">tss</span> <span class="n">file</span> <span class="n">have</span> <span class="n">no</span> <span class="n">header</span> <span class="ow">and</span> <span class="n">start</span> <span class="n">immediately</span> <span class="k">with</span> <span class="n">the</span> <span class="n">time</span> <span class="n">series</span>
<span class="o">-</span><span class="n">t</span> <span class="o">--</span><span class="n">printtime</span> <span class="n">the</span> <span class="n">computation</span> <span class="n">time</span> <span class="k">for</span> <span class="n">hydrological</span> <span class="n">modules</span> <span class="n">are</span> <span class="n">printed</span>
<span class="o">-</span><span class="n">w</span> <span class="o">--</span><span class="n">warranty</span> <span class="n">copyright</span> <span class="ow">and</span> <span class="n">warranty</span> <span class="n">information</span>
</pre></div>
</div>
</section>
</section>
</section>
<section id="netcdf-meta-data">
<h2><a class="toc-backref" href="#id20" role="doc-backlink">NetCDF meta data</a><a class="headerlink" href="#netcdf-meta-data" title="Permalink to this heading"></a></h2>
<p>The format for spatial data for output data is netCDF.
In the meta data file information can be added e.g. a description of the parameter</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>It is not necessary to change this file! This is an option to put additional information into output maps</p>
</div>
</section>
<section id="test-the-data">
<h2><a class="toc-backref" href="#id21" role="doc-backlink">Test the data</a><a class="headerlink" href="#test-the-data" title="Permalink to this heading"></a></h2>
<div class="line-block">
<div class="line">The model is only as good as the data!</div>
<div class="line">To give out a list of data and to check the data the model can run a check.</div>
</div>
<p>example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">run_cwatm</span> <span class="n">settings1</span><span class="o">.</span><span class="n">ini</span> <span class="o">-</span><span class="n">c</span>
<span class="ow">or</span>
<span class="n">python</span> <span class="n">run_cwatm</span> <span class="n">settings1</span><span class="o">.</span><span class="n">ini</span> <span class="o">-</span><span class="n">c</span> <span class="o">></span> <span class="n">checkdata</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p>A list is created with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Name: Name of the variable
Filename: filename or if the value if it is a fixed value
nonMV: non missing value in 2D map
MV: missing value in 2D map
lon-lat: longitude x latitude of 2D map
CompressV: 2D is compressed to 1D?
MV-comp: missing value in 1D
Zero-comp: Number of 0 in 1D
NonZero: Number of non 0 in 1D
min: minimum in 1D (or 2D)
mean: mean in 1D (or 2D)
max: maximum in 1D (or 2D)
</pre></div>
</div>
<p>example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Name</span> <span class="n">File</span><span class="o">/</span><span class="n">Value</span> <span class="n">nonMV</span> <span class="n">MV</span> <span class="n">lon</span><span class="o">-</span><span class="n">lat</span> <span class="n">Compress</span> <span class="n">MV</span><span class="o">-</span><span class="n">comp</span> <span class="n">Zero</span><span class="o">-</span><span class="n">comp</span> <span class="n">NonZero</span> <span class="nb">min</span> <span class="n">mean</span> <span class="nb">max</span>
<span class="n">MaskMap</span> <span class="n">put5min_netcdf</span><span class="o">/</span><span class="n">areamaps</span><span class="o">/</span><span class="n">rhine5min</span><span class="o">.</span><span class="n">map</span> <span class="mi">5236</span> <span class="mi">0</span> <span class="mi">68</span><span class="n">x77</span> <span class="kc">False</span> <span class="mi">0</span> <span class="mi">2404</span> <span class="mi">2832</span> <span class="mf">0.00</span> <span class="mf">0.54</span> <span class="mf">1.00</span>
<span class="n">Ldd</span> <span class="n">_5min</span><span class="o">/</span><span class="n">input5min_netcdf</span><span class="o">/</span><span class="n">routing</span><span class="o">/</span><span class="n">ldd</span><span class="o">.</span><span class="n">nc</span> <span class="mi">5236</span> <span class="mi">0</span> <span class="mi">68</span><span class="n">x77</span> <span class="kc">False</span> <span class="mi">0</span> <span class="mi">0</span> <span class="mi">5236</span> <span class="mf">1.00</span> <span class="mf">5.34</span> <span class="mf">9.00</span>
<span class="n">Mask</span><span class="o">+</span><span class="n">Ldd</span> <span class="mi">2832</span> <span class="mi">0</span> <span class="mi">68</span><span class="n">x77</span> <span class="kc">True</span> <span class="mi">0</span> <span class="mi">2832</span> <span class="mi">0</span> <span class="mf">0.00</span> <span class="mf">0.00</span> <span class="mf">0.00</span>
<span class="n">CellArea</span> <span class="n">n_netcdf</span><span class="o">/</span><span class="n">landsurface</span><span class="o">/</span><span class="n">topo</span><span class="o">/</span><span class="n">cellarea</span><span class="o">.</span><span class="n">nc</span> <span class="mi">2832</span> <span class="mi">0</span> <span class="mi">68</span><span class="n">x77</span> <span class="kc">True</span> <span class="mi">0</span> <span class="mi">0</span> <span class="mi">2832</span> <span class="mf">5.31E+07</span> <span class="mf">5.63E+07</span> <span class="mf">5.94E+07</span>
<span class="n">precipitation_coversion</span> <span class="mf">86.4</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="mf">86.40</span>
<span class="n">evaporation_coversion</span> <span class="mf">1.00</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="mf">1.00</span>
<span class="n">crop_correct</span> <span class="mf">1.534</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="mf">1.53</span>
<span class="n">NumberSnowLayers</span> <span class="mi">7</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="mf">7.00</span>
<span class="n">GlacierTransportZone</span> <span class="mi">3</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="o">-</span> <span class="mf">3.00</span>
<span class="n">ElevationStD</span> <span class="n">min_netcdf</span><span class="o">/</span><span class="n">landsurface</span><span class="o">/</span><span class="n">topo</span><span class="o">/</span><span class="n">elvstd</span><span class="o">.</span><span class="n">nc</span> <span class="mi">2832</span> <span class="mi">0</span> <span class="mi">68</span><span class="n">x77</span> <span class="kc">True</span> <span class="mi">0</span> <span class="mi">0</span> <span class="mi">2832</span> <span class="mf">0.04</span> <span class="mf">78.67</span> <span class="mf">672.68</span>
<span class="o">...</span>
<span class="o">...</span>
</pre></div>
</div>
</section>
<section id="settings-file">
<span id="rst-settingdoc"></span><h2><a class="toc-backref" href="#id22" role="doc-backlink">Settings file</a><a class="headerlink" href="#settings-file" title="Permalink to this heading"></a></h2>
<p>The settings file is controlling the CWatM run</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="c1">######## ## ## #### ###### ## ##</span><span class="w"></span>
<span class="linenos">2</span><span class="c1">## ## ## ## ## ## #### ####</span><span class="w"></span>
<span class="linenos">3</span><span class="c1">## ## ## ## ## ## ## #### ##</span><span class="w"></span>
<span class="linenos">4</span><span class="c1">## ## ## ## ######## ## ## ## ##</span><span class="w"></span>
<span class="linenos">5</span><span class="c1">## ## #### ## ## ## ## ## ##</span><span class="w"></span>
<span class="linenos">6</span><span class="c1">## #### #### ## ## ## ## ##</span><span class="w"></span>
<span class="linenos">7</span><span class="c1">########## ## ## ## ## ## ## ##</span><span class="w"></span>
<span class="linenos">8</span>
<span class="linenos">9</span><span class="c1"># Community Water Model Version 0.99</span><span class="w"></span>
</pre></div>
</div>
<section id="components-of-the-settings-file">
<h3><a class="toc-backref" href="#id23" role="doc-backlink">Components of the settings file</a><a class="headerlink" href="#components-of-the-settings-file" title="Permalink to this heading"></a></h3>
<section id="general-flags">
<h4><a class="toc-backref" href="#id24" role="doc-backlink">General flags</a><a class="headerlink" href="#general-flags" title="Permalink to this heading"></a></h4>
<p>General flags are set in the first paragraph
For example: If Temperature data are in unit ° Celsius ot Kelvin</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">15</span><span class="k">[OPTIONS]</span><span class="w"></span>
<span class="linenos">16</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">17</span><span class="c1"># OPTION - to switch on/off</span><span class="w"></span>
<span class="linenos">18</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">19</span>
<span class="linenos">20</span><span class="c1"># Data otions</span><span class="w"></span>
<span class="linenos">21</span><span class="c1"># if temperature is stored in Kelvin instead Celsius</span><span class="w"></span>
<span class="linenos">22</span><span class="na">TemperatureInKelvin</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">23</span><span class="c1"># if lat/lon the area has to be user defined = precalculated</span><span class="w"></span>
<span class="linenos">24</span><span class="na">gridSizeUserDefined</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">25</span>
<span class="linenos">26</span><span class="c1">#-----------------------------------------------</span><span class="w"></span>
<span class="linenos">27</span><span class="c1"># Evaporation: calculate pot. evaporation (True) or use precalculated pot.evaporation map stacks (False)</span><span class="w"></span>
<span class="linenos">28</span><span class="na">calc_evaporation</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">29</span>
<span class="linenos">30</span><span class="c1">#-----------------------------------------------</span><span class="w"></span>
<span class="linenos">31</span><span class="c1"># Irrigation and water demand</span><span class="w"></span>
<span class="linenos">32</span>
<span class="linenos">33</span><span class="c1"># if irrigation is included, otherwise paddy and non paddy is put into 'grassland'</span><span class="w"></span>
<span class="linenos">34</span><span class="na">includeIrrigation</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">35</span><span class="c1"># if water demand from irrigation, industry and domestic is included</span><span class="w"></span>
<span class="linenos">36</span><span class="na">includeWaterDemand</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">37</span><span class="c1"># Water allocation</span><span class="w"></span>
<span class="linenos">38</span><span class="c1"># if water demand and availability is calculated for region to compare demand vs. avail</span><span class="w"></span>
<span class="linenos">39</span><span class="na">usingAllocSegments</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">40</span><span class="c1"># limit abstraction to available groundwater (True) include fossil groundwater (False)</span><span class="w"></span>
<span class="linenos">41</span><span class="na">limitAbstraction</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">42</span>
<span class="linenos">43</span><span class="c1"># Environmental Flow</span><span class="w"></span>
<span class="linenos">44</span><span class="na">calc_environflow</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">45</span><span class="na">use_environflow</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">46</span>
<span class="linenos">47</span><span class="c1">#-----------------------------------------------</span><span class="w"></span>
<span class="linenos">48</span><span class="c1"># Soil </span><span class="w"></span>
<span class="linenos">49</span><span class="c1"># use preferential flow, that bypasses the soil matrix and drains directly to the groundwater (not for irrPaddy)</span><span class="w"></span>
<span class="linenos">50</span><span class="na">preferentialFlow</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">51</span><span class="c1"># Capillar rise</span><span class="w"></span>
<span class="linenos">52</span><span class="na">CapillarRise</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">53</span>
<span class="linenos">54</span><span class="c1">#-----------------------------------------------</span><span class="w"></span>
<span class="linenos">55</span><span class="c1"># Routing</span><span class="w"></span>
<span class="linenos">56</span>
<span class="linenos">57</span><span class="c1"># if runoff concentration to the edge of a cell is included</span><span class="w"></span>
<span class="linenos">58</span><span class="na">includeRunoffConcentration</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">59</span><span class="c1"># Waterbodies like lakes and reservoirs</span><span class="w"></span>
<span class="linenos">60</span><span class="na">includeWaterBodies</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">61</span><span class="c1"># kinematic wave routing, if False no routing is calculated</span><span class="w"></span>
<span class="linenos">62</span><span class="na">includeRouting</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">63</span>
<span class="linenos">64</span><span class="c1">#-----------------------------------------------</span><span class="w"></span>
<span class="linenos">65</span><span class="c1"># Inflow from outside of the modelled area</span><span class="w"></span>
<span class="linenos">66</span><span class="na">inflow</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">67</span>
<span class="linenos">68</span><span class="c1"># --- Reporting & Debugging ------------------- ----------------------------------------------</span><span class="w"></span>
<span class="linenos">69</span><span class="c1"># Reporting options</span><span class="w"></span>
<span class="linenos">70</span><span class="na">writeNetcdfStack</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">71</span><span class="na">reportMap</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">72</span><span class="na">reportTss</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
<span class="linenos">73</span><span class="c1"># Checking water balance (for debugging)</span><span class="w"></span>
<span class="linenos">74</span><span class="na">calcWaterBalance</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">75</span><span class="na">sumWaterBalance</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">76</span><span class="c1"># use additional PCRaster GIS commands</span><span class="w"></span>
<span class="linenos">77</span><span class="na">PCRaster</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">78</span>
<span class="linenos">79</span>
<span class="linenos">80</span>
<span class="linenos">81</span>
<span class="linenos">82</span>
<span class="linenos">83</span>
<span class="linenos">84</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">85</span><span class="c1"># DEFINITIONS OF PARAMETERS</span><span class="w"></span>
</pre></div>
</div>
</section>
<section id="id4">
<h4><a class="toc-backref" href="#id25" role="doc-backlink">NetCDF meta data</a><a class="headerlink" href="#id4" title="Permalink to this heading"></a></h4>
<p>The format for spatial data for input and output data is netCDF.
For output data the basic information are given in the settingsfile</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">102</span><span class="k">[NETCDF_ATTRIBUTES]</span><span class="w"></span>
<span class="linenos">103</span><span class="na">institution</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">IIASA</span><span class="w"></span>
<span class="linenos">104</span><span class="na">title</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">Global Water Model - WATCH WDFEI</span><span class="w"></span>
<span class="linenos">105</span><span class="na">metaNetcdfFile</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(FILE_PATHS:PathRoot)/source/metaNetcdf.xml</span><span class="w"></span>
</pre></div>
</div>
<p>For each output file the specific information about units, variable name, displayed variable name is given
in the metaNetcdf.xml. See: <a class="reference internal" href="#rst-metadata"><span class="std std-ref">Output Meta NetCDF information</span></a></p>
</section>
<section id="path-of-data-output">
<h4><a class="toc-backref" href="#id26" role="doc-backlink">Path of data, output</a><a class="headerlink" href="#path-of-data-output" title="Permalink to this heading"></a></h4>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Further on the pathes can be used as placeholders</p>
</div>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">88</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">89</span><span class="k">[FILE_PATHS]</span><span class="w"></span>
<span class="linenos">90</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">91</span><span class="na">PathRoot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">E:/CWATM_rhine</span><span class="w"></span>
<span class="linenos">92</span>
<span class="linenos">93</span><span class="na">PathOut</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(PathRoot)/output</span><span class="w"></span>
<span class="linenos">94</span><span class="na">PathMaps</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(PathRoot)/cwatm_input</span><span class="w"></span>
<span class="linenos">95</span><span class="na">PathMeteo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(PathRoot)/climate</span><span class="w"></span>
</pre></div>
</div>
</section>
<section id="defining-the-modeling-area">
<span id="rst-modelarea"></span><h4><a class="toc-backref" href="#id27" role="doc-backlink">Defining the modeling area</a><a class="headerlink" href="#defining-the-modeling-area" title="Permalink to this heading"></a></h4>
<p>In general the input data are stored and used at global scale.
The modeling area can be defined by:</p>
<ul class="simple">
<li><p>a mask map e.g.: $(FILE_PATHS:PathRoot)/source/rhine30min.tif</p></li>
<li><p>coordinates e.g.: 14 12 0.5 5.0 52.0</p></li>
<li><p>lowest point of a catchment e.g.: 6.25 51.75</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<div class="line-block">
<div class="line">The mask map can be a .tif, PCraster or a netCDF format</div>
<div class="line">The coordinates have the format: Number of Cols, Number of rows, cellsize, upper left corner X, upper left corner Y</div>
<div class="line">The point location (lon lat) will be used to create the catchment upstream of this point</div>
</div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If you use a mask map, make sure you do not use blanks in the file path or name!</p>
</div>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">108</span><span class="c1"># AREA AND OUTLETS</span><span class="w"></span>
<span class="linenos">109</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">110</span><span class="k">[MASK_OUTLET]</span><span class="w"></span>
<span class="linenos">111</span>
<span class="linenos">112</span><span class="c1"># Area mask</span><span class="w"></span>
<span class="linenos">113</span><span class="c1"># A pcraster map, tif or netcdf map e.g. $(FILE_PATHS:PathRoot)/data/areamaps/area_indus.map</span><span class="w"></span>
<span class="linenos">114</span><span class="c1"># or a retancle: Number of Cols, Number of rows, cellsize, upper left corner X, upper left corner Y </span><span class="w"></span>
<span class="linenos">115</span><span class="na">MaskMap</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(FILE_PATHS:PathRoot)/source/rhine30min.tif</span><span class="w"></span>
<span class="linenos">116</span><span class="c1">#MaskMap = 14 12 0.5 5.0 52.0</span><span class="w"></span>
<span class="linenos">117</span>
<span class="linenos">118</span>
<span class="linenos">119</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">120</span><span class="c1"># Station data</span><span class="w"></span>
<span class="linenos">121</span><span class="c1"># either a map e.g. $(FILE_PATHS:PathRoot)/data/areamaps/area3.map</span><span class="w"></span>
<span class="linenos">122</span><span class="c1"># or a location coordinates (X,Y) e.g. 5.75 52.25 9.25 49.75 )</span><span class="w"></span>
<span class="linenos">123</span><span class="c1"># Lobith/Rhine</span><span class="w"></span>
<span class="linenos">124</span><span class="na">Gauges</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">6.25 51.75</span><span class="w"></span>
<span class="linenos">125</span>
<span class="linenos">126</span><span class="c1"># if .tif file for gauges, this is a flag if the file is global or local</span><span class="w"></span>
<span class="linenos">127</span><span class="c1"># e.g. Gauges = $(FILE_PATHS:PathRoot)/data/areamaps/gaugesRhine.tif</span><span class="w"></span>
<span class="linenos">128</span><span class="na">GaugesLocal</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<div class="line-block">
<div class="line">If you start with a basin defined by the outlet of a basin e.g. 6.25 51.75</div>
<div class="line">You can generate a new mask map for the following runs by:</div>
<div class="line"><strong>savebasinmap = True</strong> in [OPTIONS]</div>
<div class="line">a basin.tif is generated in the output folder, which you can copy and use next time as:</div>
<div class="line"><strong>MaskMap = your_directory/basin.tif</strong></div>
</div>
</div>
</section>
<section id="defining-the-time">
<h4><a class="toc-backref" href="#id28" role="doc-backlink">Defining the time</a><a class="headerlink" href="#defining-the-time" title="Permalink to this heading"></a></h4>
<p>The start and end time have to be defined.
Spin-up time is the time for warming up (results will be stored after the spin-up time)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The time can be given as date: dd/mm/yyyy or as relative date: number (but then CalendarDayStart has to be defined)</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Spin-up time can be given as date or number</p>
</div>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">130</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">131</span><span class="k">[TIME-RELATED_CONSTANTS]</span><span class="w"></span>
<span class="linenos">132</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">133</span>
<span class="linenos">134</span><span class="c1"># StepStart has to be a date e.g. 01/06/1990</span><span class="w"></span>
<span class="linenos">135</span><span class="c1"># SpinUp or StepEnd either date or numbers </span><span class="w"></span>
<span class="linenos">136</span><span class="c1"># SpinUp: from this date output is generated (up to this day: warm up)</span><span class="w"></span>
<span class="linenos">137</span>
<span class="linenos">138</span><span class="na">StepStart</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">1/1/1990</span><span class="w"></span>
<span class="linenos">139</span><span class="na">SpinUp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">1/01/1995</span><span class="w"></span>
<span class="linenos">140</span><span class="na">StepEnd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">31/12/2010</span><span class="w"></span>
</pre></div>
</div>
</section>
<section id="initial-conditions">
<h4><a class="toc-backref" href="#id29" role="doc-backlink">Initial conditions</a><a class="headerlink" href="#initial-conditions" title="Permalink to this heading"></a></h4>
<p>Initial conditions can be stored and be loaded in order to initialise a warm start of the model</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Initial conditions are store as one netCDF file with all necessary variables</p>
</div>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">145</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">146</span><span class="k">[INITITIAL CONDITIONS]</span><span class="w"></span>
<span class="linenos">147</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">148</span>
<span class="linenos">149</span><span class="c1"># for a warm start initial variables a loaded</span><span class="w"></span>
<span class="linenos">150</span><span class="c1"># e.g for a start on 01/01/2010 load variable from 31/12/2009</span><span class="w"></span>
<span class="linenos">151</span><span class="na">load_initial</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">152</span><span class="na">initLoad</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(FILE_PATHS:PathRoot)/init/Rhine_19891231.nc</span><span class="w"></span>
<span class="linenos">153</span>
<span class="linenos">154</span><span class="c1"># saving variables from this run, to initiate a warm start next run</span><span class="w"></span>
<span class="linenos">155</span><span class="c1"># StepInit = saving date, can be more than one: 10/01/1973 20/01/1973</span><span class="w"></span>
<span class="linenos">156</span><span class="na">save_initial</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span><span class="w"></span>
<span class="linenos">157</span><span class="na">initSave</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$(FILE_PATHS:PathRoot)/init/Rhine</span><span class="w"></span>
<span class="linenos">158</span><span class="na">StepInit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">31/12/1989 31/12/2010</span><span class="w"></span>
</pre></div>
</div>
<p>StepInit indicate the date(s) when initial conditions are saved:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">StepInit</span> <span class="o">=</span> <span class="mi">31</span><span class="o">/</span><span class="mi">12</span><span class="o">/</span><span class="mi">1989</span>
<span class="n">StepInit</span> <span class="o">=</span> <span class="mi">31</span><span class="o">/</span><span class="mi">12</span><span class="o">/</span><span class="mi">1989</span> <span class="mi">31</span><span class="o">/</span><span class="mi">12</span><span class="o">/</span><span class="mi">2010</span>
<span class="n">StepInit</span> <span class="o">=</span> <span class="mi">31</span><span class="o">/</span><span class="mi">12</span><span class="o">/</span><span class="mi">1989</span> <span class="mi">5</span><span class="n">y</span>
<span class="n">here</span><span class="p">:</span> <span class="n">second</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">StepInit</span> <span class="ow">is</span> <span class="n">indicating</span> <span class="n">a</span> <span class="n">repetition</span> <span class="n">of</span> <span class="n">year</span><span class="p">(</span><span class="n">y</span><span class="p">),</span> <span class="n">month</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> <span class="ow">or</span> <span class="n">day</span><span class="p">(</span><span class="n">d</span><span class="p">),</span>
<span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="mi">2</span><span class="n">y</span> <span class="k">for</span> <span class="n">every</span> <span class="mi">2</span> <span class="n">years</span> <span class="ow">or</span> <span class="mi">6</span><span class="n">m</span> <span class="k">for</span> <span class="n">every</span> <span class="mi">6</span> <span class="n">month</span>
</pre></div>
</div>
</section>
<section id="output">
<span id="rst-outputone"></span><h4><a class="toc-backref" href="#id30" role="doc-backlink">Output</a><a class="headerlink" href="#output" title="Permalink to this heading"></a></h4>
<dl>
<dt>Output can be spatial/time as netCDF4 map stacks</dt><dd><div class="line-block">
<div class="line">and/or time series at specified points</div>
</div>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For additional information see <a class="reference internal" href="#rst-outputtwo"><span class="std std-ref">Model Output</span></a></p>
</div>
<p>Output can be as maps and time series:</p>
<ul class="simple">
<li><p>per day [Daily]</p></li>
<li><p>total month [MonthTot], average month [MonthAvg], end of month [MonthEnd]</p></li>
<li><p>total year [AnnualTot], average year [AnnualAvg], end of year [AnnualEnd]</p></li>
<li><p>total sum [TotalTot], total average [TotalAvg]</p></li>
</ul>
<p>For each of the following sections output can be defined for different variables:</p>
<ul class="simple">
<li><p>Meteo</p></li>
<li><p>Snow</p></li>
<li><p>Soil for different land cover (forest, grassland, irrigated land, paddy irrigated)</p></li>
<li><p>Water demand</p></li>
<li><p>Groundwater</p></li>
<li><p>River routing</p></li>
<li><p>Lakes and reservoirs</p></li>
</ul>
<p><strong>Or</strong> output can be defined in the section <em>[output]</em></p>
<p>An output directory can be defined and for each sort of output the variable(s) can be set:</p>
<div class="line-block">
<div class="line"><em>OUT_</em> defines that this variable(s) are output</div>
<div class="line"><em>MAP_</em> or <em>TSS_</em> defines if it is a spatial map or a time series of point(s)</div>
<div class="line"><em>AreaSum_</em> or <em>AreaAvg_</em> after <em>TSS_</em> defines if the catchment sum of average upstream of the point is calculated</div>
<div class="line"><em>Daily</em> or <em>MonthAvg</em> or .. is specifying the time</div>
<div class="line">The variable is given after the equal sign e.g. * = discharge*</div>
<div class="line">If more than one variable should be used for output, split with <strong>,</strong></div>
<div class="line">E.g. OUT_MAP_Daily = discharge -> daily spatial map of discharge</div>
</div>
<p>As example output for precipitation, temperature and discharge is shown here:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># OUTPUT maps and timeseries
OUT_Dir = $(FILE_PATHS:PathOut)
OUT_MAP_Daily =
OUT_MAP_MonthEnd =
OUT_MAP_MonthTot = Precipitation, Tavg
OUT_MAP_MonthAvg =
OUT_TSS_MonthTot = Precipitation, Tavg # monthly total precipitation and average temperature
OUT_TSS_Daily = discharge # daily discharge
OUT_TSS_MonthEnd = discharge
OUT_TSS_AnnualEnd = discharge
OUT_TSS_AreaSum_Daily = Precipitation # daily sum of precipitation for the upstream catchment
OUT_TSS_AreaAvg_MonthAvg = runoff # monthly average sum of runoff for the upstream catchment
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For each variable the meta data information can be defined in <a class="reference internal" href="#rst-metadata"><span class="std std-ref">Output Meta NetCDF information</span></a></p>
</div>
</section>
<section id="reading-information">
<h4><a class="toc-backref" href="#id31" role="doc-backlink">Reading information</a><a class="headerlink" href="#reading-information" title="Permalink to this heading"></a></h4>
<p>Information will be read in from values in the settings file
Here the value definitions for [SNOW] is shown:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="linenos">279</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">280</span><span class="k">[SNOW]</span><span class="w"></span>
<span class="linenos">281</span><span class="c1">#-------------------------------------------------------</span><span class="w"></span>
<span class="linenos">282</span>
<span class="linenos">283</span><span class="c1"># Number of vertical Snow layers</span><span class="w"></span>
<span class="linenos">284</span><span class="na">NumberSnowLayers</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">7</span><span class="w"></span>
<span class="linenos">285</span><span class="c1"># up to which layer the ice melt is calculated with the middle temperature</span><span class="w"></span>
<span class="linenos">286</span><span class="na">GlacierTransportZone</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">3</span><span class="w"></span>
<span class="linenos">287</span>
<span class="linenos">288</span><span class="c1"># Temperature lapse rate with altitude [deg C / m]</span><span class="w"></span>
<span class="linenos">289</span><span class="na">TemperatureLapseRate</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0.0065 </span><span class="w"></span>
<span class="linenos">290</span><span class="c1"># Multiplier applied to precipitation that falls as snow</span><span class="w"></span>
<span class="linenos">291</span><span class="na">SnowFactor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">1.0</span><span class="w"></span>
<span class="linenos">292</span><span class="c1"># Range [m C-1 d-1] of the seasonal variation, SnowMeltCoef is the average value</span><span class="w"></span>
<span class="linenos">293</span><span class="na">SnowSeasonAdj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0.001</span><span class="w"></span>
<span class="linenos">294</span><span class="c1"># Average temperature at which snow melts</span><span class="w"></span>
<span class="linenos">295</span><span class="na">TempMelt</span><span class="w"> </span><span class="o">=</span><span class="s">1.0</span><span class="w"></span>
<span class="linenos">296</span><span class="c1"># Average temperature below which precipitation is snow</span><span class="w"></span>
<span class="linenos">297</span><span class="na">TempSnow</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">1.0</span><span class="w"></span>
<span class="linenos">298</span><span class="c1"># Snow melt coefficient: default: 4.0 </span><span class="w"></span>
<span class="linenos">299</span><span class="c1"># SRM: 0.0045 m/C/day ( = 4.50 mm/C/day), Kwadijk: 18 mm/C/month (= 0.59 mm/C/day) </span><span class="w"></span>
<span class="linenos">300</span><span class="c1"># See also Martinec et al., 1998.</span><span class="w"></span>
<span class="linenos">301</span>
<span class="linenos">302</span><span class="c1"># use in CALIBRATION -> copied to CALIBRATION</span><span class="w"></span>
<span class="linenos">303</span><span class="c1">#SnowMeltCoef = 0.004</span><span class="w"></span>
<span class="linenos">304</span><span class="na">IceMeltCoef</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0.007</span><span class="w"></span>
<span class="linenos">305</span>
<span class="linenos">306</span><span class="c1">#--------------------------------------------------------------</span><span class="w"></span>
<span class="linenos">307</span><span class="c1"># INITIAL CONDITIONS - Initial snow depth in snow zone 1-7 [mm] - SnowCoverIni</span><span class="w"></span>
<span class="linenos">308</span>
<span class="linenos">309</span><span class="k">[FROST]</span><span class="w"></span>
<span class="linenos">310</span><span class="c1"># Snow water equivalent, (based on snow density of 450 kg/m3) (e.g. Tarboton and Luce, 1996)</span><span class="w"></span>
<span class="linenos">311</span><span class="na">SnowWaterEquivalent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0.45</span><span class="w"></span>
<span class="linenos">312</span><span class="c1"># Daily decay coefficient, (Handbook of Hydrology, p. 7.28)</span><span class="w"></span>
<span class="linenos">313</span><span class="na">Afrost</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0.97</span><span class="w"></span>
<span class="linenos">314</span><span class="c1"># Snow depth reduction coefficient, [cm-1], (HH, p. 7.28)</span><span class="w"></span>
<span class="linenos">315</span><span class="na">Kfrost</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0.57</span><span class="w"></span>
<span class="linenos">316</span><span class="c1"># Degree Days Frost Threshold (stops infiltration, percolation and capillary rise)</span><span class="w"></span>
<span class="linenos">317</span><span class="c1"># Molnau and Bissel found a value 56-85 for NW USA.</span><span class="w"></span>
<span class="linenos">318</span><span class="na">FrostIndexThreshold</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">56</span><span class="w"></span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>TemperatureLapseRate = 0.0065
| for the variable TemperatureLapseRate the value of 0.0065 is set</p>
</div>
<p>Variables can also be defined by spatial maps or map stacks</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>tanslope = $(PathTopo)\tanslope.map
forest_coverFractionNC = $(PathForest)\coverFractionInputForest366days.nc
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>suffix can be .map, but if there is no PCraster map it will look automatically for netCDF .nc</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>in most cases values can be replaced by map</p>
</div>
<div class="line-block">
<div class="line">____________________________________________________________________________________________________________</div>
<div class="line"><br /></div>
</div>
</section>
</section>
<section id="sections-of-information">
<h3><a class="toc-backref" href="#id32" role="doc-backlink">Sections of information</a><a class="headerlink" href="#sections-of-information" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Snow</p></li>
<li><p>Frost</p></li>
<li><p>General information on land cover types</p></li>
<li><p>Soil</p></li>
<li><dl class="simple">
<dt>Information for each of the six land cover types</dt><dd><ul>
<li><p>Forest</p></li>
<li><p>Grassland</p></li>
<li><p>Paddy irrigated area</p></li>
<li><p>Irrigated area</p></li>
<li><p>Sealed area</p></li>
<li><p>Water covered area</p></li>
</ul>
</dd>
</dl>
</li>
<li><p>Interflow</p></li>
<li><p>Groundwater</p></li>
<li><p>Water demand</p></li>
<li><p>Runoff concentration</p></li>
<li><p>Routing</p></li>
<li><p>Lakes and reservoirs</p></li>
<li><p>Inflow</p></li>
</ul>
</section>
<section id="complete-settings-file">
<span id="rst-setting"></span><h3><a class="toc-backref" href="#id33" role="doc-backlink">Complete settings file</a><a class="headerlink" href="#complete-settings-file" title="Permalink to this heading"></a></h3>
<p>Example of a settings file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span># ------------------------------------------------
<span class="linenos"> 2</span>
<span class="linenos"> 3</span>######## ## ## #### ###### ## ##
<span class="linenos"> 4</span>## ## ## ## ## ## #### ####
<span class="linenos"> 5</span>## ## ## ## ## ## ## #### ##
<span class="linenos"> 6</span>## ## ## ## ######## ## ## ## ##
<span class="linenos"> 7</span>## ## #### ## ## ## ## ## ##
<span class="linenos"> 8</span>## #### #### ## ## ## ## ##
<span class="linenos"> 9</span>########## ## ## ## ## ## ## ##
<span class="linenos"> 10</span>
<span class="linenos"> 11</span># Community Water Model Version 0.99
<span class="linenos"> 12</span># SETTINGS FILE
<span class="linenos"> 13</span># ------------------------------------------------
<span class="linenos"> 14</span>
<span class="linenos"> 15</span>
<span class="linenos"> 16</span>[OPTIONS]
<span class="linenos"> 17</span>#-------------------------------------------------------
<span class="linenos"> 18</span># OPTION - to switch on/off
<span class="linenos"> 19</span>#-------------------------------------------------------
<span class="linenos"> 20</span>
<span class="linenos"> 21</span># Data otions
<span class="linenos"> 22</span># if temperature is stored in Kelvin instead Celsius
<span class="linenos"> 23</span>TemperatureInKelvin = True
<span class="linenos"> 24</span># if lat/lon the area has to be user defined = precalculated
<span class="linenos"> 25</span>gridSizeUserDefined = True
<span class="linenos"> 26</span>
<span class="linenos"> 27</span>#-----------------------------------------------
<span class="linenos"> 28</span># Evaporation: calculate pot. evaporation (True) or use precalculated pot.evaporation map stacks (False)
<span class="linenos"> 29</span>calc_evaporation = False
<span class="linenos"> 30</span>
<span class="linenos"> 31</span>#-----------------------------------------------
<span class="linenos"> 32</span># Irrigation and water demand
<span class="linenos"> 33</span>
<span class="linenos"> 34</span># if irrigation is included, otherwise paddy and non paddy is put into 'grassland'
<span class="linenos"> 35</span>includeIrrigation = True
<span class="linenos"> 36</span># if water demand from irrigation, industry and domestic is included
<span class="linenos"> 37</span>includeWaterDemand = False
<span class="linenos"> 38</span># Water allocation
<span class="linenos"> 39</span># if water demand and availability is calculated for region to compare demand vs. avail
<span class="linenos"> 40</span>usingAllocSegments = False
<span class="linenos"> 41</span># limit abstraction to available groundwater (True) include fossil groundwater (False)
<span class="linenos"> 42</span>limitAbstraction = False
<span class="linenos"> 43</span>
<span class="linenos"> 44</span># Environmental Flow
<span class="linenos"> 45</span>calc_environflow = False
<span class="linenos"> 46</span>use_environflow = False
<span class="linenos"> 47</span>
<span class="linenos"> 48</span>#-----------------------------------------------
<span class="linenos"> 49</span># Soil
<span class="linenos"> 50</span># use preferential flow, that bypasses the soil matrix and drains directly to the groundwater (not for irrPaddy)
<span class="linenos"> 51</span>preferentialFlow = False
<span class="linenos"> 52</span># Capillar rise
<span class="linenos"> 53</span>CapillarRise = True
<span class="linenos"> 54</span>
<span class="linenos"> 55</span>#-----------------------------------------------
<span class="linenos"> 56</span># Routing
<span class="linenos"> 57</span>
<span class="linenos"> 58</span># if runoff concentration to the edge of a cell is included
<span class="linenos"> 59</span>includeRunoffConcentration = True
<span class="linenos"> 60</span># Waterbodies like lakes and reservoirs
<span class="linenos"> 61</span>includeWaterBodies = True
<span class="linenos"> 62</span># kinematic wave routing, if False no routing is calculated
<span class="linenos"> 63</span>includeRouting = True
<span class="linenos"> 64</span>
<span class="linenos"> 65</span>#-----------------------------------------------
<span class="linenos"> 66</span># Inflow from outside of the modelled area
<span class="linenos"> 67</span>inflow = False
<span class="linenos"> 68</span>
<span class="linenos"> 69</span># --- Reporting & Debugging ------------------- ----------------------------------------------
<span class="linenos"> 70</span># Reporting options
<span class="linenos"> 71</span>writeNetcdfStack = True
<span class="linenos"> 72</span>reportMap = True
<span class="linenos"> 73</span>reportTss = True
<span class="linenos"> 74</span># Checking water balance (for debugging)
<span class="linenos"> 75</span>calcWaterBalance = False
<span class="linenos"> 76</span>sumWaterBalance = False
<span class="linenos"> 77</span># use additional PCRaster GIS commands
<span class="linenos"> 78</span>PCRaster = False
<span class="linenos"> 79</span>
<span class="linenos"> 80</span>
<span class="linenos"> 81</span>
<span class="linenos"> 82</span>
<span class="linenos"> 83</span>
<span class="linenos"> 84</span>
<span class="linenos"> 85</span>#-------------------------------------------------------
<span class="linenos"> 86</span># DEFINITIONS OF PARAMETERS
<span class="linenos"> 87</span>#-------------------------------------------------------
<span class="linenos"> 88</span>
<span class="linenos"> 89</span>#-------------------------------------------------------
<span class="linenos"> 90</span>[FILE_PATHS]
<span class="linenos"> 91</span>#-------------------------------------------------------
<span class="linenos"> 92</span>PathRoot = E:/CWATM_rhine
<span class="linenos"> 93</span>
<span class="linenos"> 94</span>PathOut = $(PathRoot)/output
<span class="linenos"> 95</span>PathMaps = $(PathRoot)/cwatm_input
<span class="linenos"> 96</span>PathMeteo = $(PathRoot)/climate
<span class="linenos"> 97</span>
<span class="linenos"> 98</span>
<span class="linenos"> 99</span>
<span class="linenos">100</span>
<span class="linenos">101</span>#-------------------------------------------------------
<span class="linenos">102</span>[NETCDF_ATTRIBUTES]
<span class="linenos">103</span>institution = IIASA