-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmanagement_modules.html
1256 lines (1171 loc) · 105 KB
/
management_modules.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>management_modules package — 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="17. Forum" href="forum.html" />
<link rel="prev" title="hydrological_modules package" href="hydrological_modules.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"><a class="reference internal" href="setup.html">4. Setup of the model</a></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 current"><a class="reference internal" href="sourcecode.html">16. Source code</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="sourcecode.html#source-code-on-github">Source code on Github</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="sourcecode.html#id1">Source code</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="sourcecode.html#modules-of-cwatm">Modules of CWatM</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="sourcecode.html#source-code-description">Source code description</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="run_cwatm.html">run_cwatm</a></li>
<li class="toctree-l4"><a class="reference internal" href="cwatm_model.html">cwatm_model module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cwatm_dynamic.html">cwatm_dynamic module</a></li>
<li class="toctree-l4"><a class="reference internal" href="cwatm_initial.html">cwatm_initial module</a></li>
<li class="toctree-l4"><a class="reference internal" href="hydrological_modules.html">hydrological_modules package</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">management_modules package</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="sourcecode.html#download-manual-as-pdf">Download Manual as pdf</a></li>
<li class="toctree-l2"><a class="reference internal" href="sourcecode.html#global-dataset">Global dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="sourcecode.html#contact-cwatm">Contact CWatM</a></li>
<li class="toctree-l2"><a class="reference internal" href="sourcecode.html#remarks">Remarks</a></li>
</ul>
</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"><a href="sourcecode.html"><span class="section-number">16. </span>Source code</a></li>
<li class="breadcrumb-item active">management_modules package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/management_modules.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="management-modules-package">
<h1>management_modules package<a class="headerlink" href="#management-modules-package" title="Permalink to this heading"></a></h1>
<section id="data-management">
<h2>Data management<a class="headerlink" href="#data-management" title="Permalink to this heading"></a></h2>
<section id="data-handling-module">
<h3>data_handling module<a class="headerlink" href="#data-handling-module" title="Permalink to this heading"></a></h3>
<p><strong>Managing data and data handling</strong></p>
<span class="target" id="module-cwatm.management_modules.data_handling"></span><dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.cbinding">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">cbinding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inBinding</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#cbinding"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.cbinding" title="Permalink to this definition"></a></dt>
<dd><p>Check if variable in settings file has a counterpart in the source code</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>inBinding</strong> – parameter in settings file</p>
</dd>
</dl>
<p>Not tested because you need to change the name eg PrecipiationMaps = … -> Precipitation = …</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.checkMeteo_Wordclim">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">checkMeteo_Wordclim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meteodata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wordclimdata</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#checkMeteo_Wordclim"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.checkMeteo_Wordclim" title="Permalink to this definition"></a></dt>
<dd><p>reads the map attributes of meteo dataset and wordclima dataset
and compare if it has the same map extend</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>nmeteodata</strong> – name of the meteo netcdf file</p></li>
<li><p><strong>wordlclimdata</strong> – cname of the wordlclim netcdf file</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if meteo and wordclim has the same mapextend</p>
</dd>
</dl>
<p>:raises if map extend is different <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMFileError()</span></code></p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.checkOption">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">checkOption</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inBinding</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#checkOption"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.checkOption" title="Permalink to this definition"></a></dt>
<dd><p>Check if option in settings file has a counterpart in the source code</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>inBinding</strong> – parameter in settings file</p>
</dd>
</dl>
<p>Not tested because you need to change the name eg gridSizeUserDefined = True -> gridSizeUser = True</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.compressArray">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">compressArray</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'None'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zeros</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#compressArray"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.compressArray" title="Permalink to this definition"></a></dt>
<dd><p>Compress 2D array with missing values to 1D array without missing values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>map</strong> – in map</p></li>
<li><p><strong>name</strong> – filename of the map</p></li>
<li><p><strong>zeros</strong> – add zeros (default= 0) if values of map are to big or too small</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Compressed 1D array</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.decompress">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">decompress</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">map</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#decompress"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.decompress" title="Permalink to this definition"></a></dt>
<dd><p>Decompress 1D array without missing values to 2D array with missing values</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>map</strong> – numpy 1D array as input</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>2D array for displaying</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.divideValues">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">divideValues</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#divideValues"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.divideValues" title="Permalink to this definition"></a></dt>
<dd><p>returns the result of a division that possibly involves a zero</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – </p></li>
<li><p><strong>y</strong> – divisor</p></li>
<li><p><strong>default</strong> – return value if y =0</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>result of <span class="math">x/y</span> or default if y = 0</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.getmeta">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">getmeta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">varname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alternative</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#getmeta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.getmeta" title="Permalink to this definition"></a></dt>
<dd><p>get the meta data information for the netcdf output from the global
variable metaNetcdfVar</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>key</strong> – key</p></li>
<li><p><strong>varname</strong> – variable name e.g. self.var.Precipitation</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>metadata information</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.loadmap">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">loadmap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lddflag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#loadmap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.loadmap" title="Permalink to this definition"></a></dt>
<dd><p>load a static map either value or pc raster map or netcdf</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – name of map</p></li>
<li><p><strong>lddflag</strong> – if True the map is used as a ldd map</p></li>
<li><p><strong>compress</strong> – if True the return map will be compressed</p></li>
<li><p><strong>local</strong> – if True the map is local and will be not cut</p></li>
<li><p><strong>cut</strong> – if True the map will be not cut</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>1D numpy array of map</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.loadsetclone">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">loadsetclone</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#loadsetclone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.loadsetclone" title="Permalink to this definition"></a></dt>
<dd><p>load the maskmap and set as clone</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> – name of mask map, can be a file or - row col cellsize xupleft yupleft -</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>new mask map</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.mapattrNetCDF">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">mapattrNetCDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#mapattrNetCDF"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.mapattrNetCDF" title="Permalink to this definition"></a></dt>
<dd><p>get the 4 corners of a netcdf map to cut the map
defines the rectangular of the mask map inside the netcdf map
calls function <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.data_handling.readCoord()</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – name of the netcdf file</p></li>
<li><p><strong>check</strong> – checking if netcdffile exists</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>cut1,cut2,cut3,cut4</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>if cell size is different</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMError()</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.mapattrNetCDFMeteo">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">mapattrNetCDFMeteo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#mapattrNetCDFMeteo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.mapattrNetCDFMeteo" title="Permalink to this definition"></a></dt>
<dd><p>get the map attributes like col, row etc from a netcdf map
and define the rectangular of the mask map inside the netcdf map
calls function <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.data_handling.readCoordNetCDF()</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – name of the netcdf file</p></li>
<li><p><strong>check</strong> – checking if netcdffile exists</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>cut0,cut1,cut2,cut3,cut4,cut5,cut6,cut7</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.mapattrTiff">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">mapattrTiff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nf2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#mapattrTiff"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.mapattrTiff" title="Permalink to this definition"></a></dt>
<dd><p>map attributes of a geotiff file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>nf2</strong> – </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>cut0,cut1,cut2,cut3</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.maskfrompoint">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">maskfrompoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mask2D</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xleft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yup</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#maskfrompoint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.maskfrompoint" title="Permalink to this definition"></a></dt>
<dd><p>load a static map either value or pc raster map or netcdf</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mask2D</strong> – 2D array of new mask</p></li>
<li><p><strong>xleft</strong> – left lon coordinate</p></li>
<li><p><strong>yup</strong> – upper lat coordinate</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>new mask map</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.metaNetCDF">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">metaNetCDF</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#metaNetCDF"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.metaNetCDF" title="Permalink to this definition"></a></dt>
<dd><p>get the map metadata from precipitation netcdf maps</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.multinetdf">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">multinetdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">meteomaps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startcheck</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'dateBegin'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#multinetdf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.multinetdf" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>meteomaps</strong> – list of meteomaps to define start and end time</p></li>
<li><p><strong>startcheck</strong> – date of beginning simulation</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p></p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>if no map stack in meteo map folder</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMFileError()</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readCalendar">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readCalendar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readCalendar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readCalendar" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readCoord">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readCoord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readCoord"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readCoord" title="Permalink to this definition"></a></dt>
<dd><p>get the meta data information for the netcdf output from the global
variable metaNetcdfVar</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> – name of the netcdf file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>latitude, longitude, cell size, inverse cell size</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readCoordNetCDF">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readCoordNetCDF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readCoordNetCDF"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readCoordNetCDF" title="Permalink to this definition"></a></dt>
<dd><p>reads the map attributes col, row etc from a netcdf map</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – name of the netcdf file</p></li>
<li><p><strong>check</strong> – checking if netcdffile exists</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>latitude, longitude, cell size, inverse cell size</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>if no netcdf map can be found</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMFileError()</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readmeteodata">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readmeteodata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'None'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addZeros</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zeros</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mapsscale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readmeteodata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readmeteodata" title="Permalink to this definition"></a></dt>
<dd><p>load stack of maps 1 at each timestamp in netcdf format</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – file name</p></li>
<li><p><strong>date</strong> – </p></li>
<li><p><strong>value</strong> – if set the name of the parameter is defined</p></li>
<li><p><strong>addZeros</strong> – </p></li>
<li><p><strong>zeros</strong> – default value</p></li>
<li><p><strong>mapsscale</strong> – if meteo maps have the same extend as the other spatial static m</p></li>
<li><p><strong>buffering</strong> – if buffer should be applied before cutting the map to the mask extent</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Compressed 1D array of meteo data</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>if data is wrong</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMError()</span></code></p></li>
<li><p><strong>if meteo netcdf file cannot be opened</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMFileError()</span></code></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readnetcdf2">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readnetcdf2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namebinding</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useDaily</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'daily'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'None'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addZeros</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cut</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zeros</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">meteo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usefilename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readnetcdf2"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readnetcdf2" title="Permalink to this definition"></a></dt>
<dd><p>load stack of maps 1 at each timestamp in netcdf format</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namebinding</strong> – file name in settings file</p></li>
<li><p><strong>date</strong> – </p></li>
<li><p><strong>useDaily</strong> – if True daily values are used</p></li>
<li><p><strong>value</strong> – if set the name of the parameter is defined</p></li>
<li><p><strong>addZeros</strong> – </p></li>
<li><p><strong>cut</strong> – if True the map is clipped to mask map</p></li>
<li><p><strong>zeros</strong> – default value</p></li>
<li><p><strong>meteo</strong> – if map are meteo maps</p></li>
<li><p><strong>usefilename</strong> – if True filename is given False: filename is in settings file</p></li>
<li><p><strong>compress</strong> – True - compress data to 1D</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Compressed 1D array of netcdf stored data</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>if netcdf file cannot be opened</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMFileError()</span></code></p></li>
<li><p><strong>if netcdf file is not</strong><strong> of </strong><strong>the size</strong><strong> of </strong><strong>mask map</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMWarning()</span></code></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readnetcdfInitial">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readnetcdfInitial</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readnetcdfInitial"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readnetcdfInitial" title="Permalink to this definition"></a></dt>
<dd><p>load initial condition from netcdf format</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – file name</p></li>
<li><p><strong>value</strong> – netcdf variable name</p></li>
<li><p><strong>default</strong> – (optional) if no variable is found a warning is given and value is set to default</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Compressed 1D array of netcdf stored data</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>if netcdf file is not</strong><strong> of </strong><strong>the size</strong><strong> of </strong><strong>mask map</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMError()</span></code></p></li>
<li><p><strong>if varibale name is not included in the netcdf file</strong> – <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMWarning()</span></code></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.readnetcdfWithoutTime">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">readnetcdfWithoutTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'None'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#readnetcdfWithoutTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.readnetcdfWithoutTime" title="Permalink to this definition"></a></dt>
<dd><p>load maps in netcdf format (has no time format)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namebinding</strong> – file name in settings file</p></li>
<li><p><strong>value</strong> – (optional) netcdf variable name. If not given -> last variable is taken</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Compressed 1D array of netcdf stored data</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.report">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">valueIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#report"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.report" title="Permalink to this definition"></a></dt>
<dd><p>For debugging: Save the 2D array as .map or .tif</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – Filename of the map</p></li>
<li><p><strong>valueIn</strong> – 1D or 2D array in</p></li>
<li><p><strong>compr</strong> – (optional) array is 1D (default) or 2D</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li></li>
</ul>
</p>
</dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Example</span><span class="p">:</span>
<span class="o">></span> <span class="n">report</span><span class="p">(</span><span class="n">c</span><span class="p">:</span><span class="o">/</span><span class="n">temp</span><span class="o">/</span><span class="n">ksat1</span><span class="o">.</span><span class="n">map</span><span class="p">,</span> <span class="n">self_</span><span class="o">.</span><span class="n">var_</span><span class="o">.</span><span class="n">ksat1</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.returnBool">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">returnBool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inBinding</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#returnBool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.returnBool" title="Permalink to this definition"></a></dt>
<dd><p>Test if parameter is a boolean and return an error message if not, and the boolean if everything is ok</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>inBinding</strong> – parameter in settings file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean of inBinding</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.setmaskmapAttr">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">setmaskmapAttr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">col</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">row</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#setmaskmapAttr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.setmaskmapAttr" title="Permalink to this definition"></a></dt>
<dd><p>Definition of cell size, coordinates of the meteo maps and maskmap</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – upper left corner x</p></li>
<li><p><strong>y</strong> – upper left corner y</p></li>
<li><p><strong>col</strong> – number of cols</p></li>
<li><p><strong>row</strong> – number of rows</p></li>
<li><p><strong>cell</strong> – cell size</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.valuecell">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">valuecell</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coordx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coordstr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">returnmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#valuecell"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.valuecell" title="Permalink to this definition"></a></dt>
<dd><p>to put a value into a raster map -> invert of cellvalue, map is converted into a numpy array first</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>coordx</strong> – x,y or lon/lat coordinate</p></li>
<li><p><strong>coordstr</strong> – String of coordinates</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>1D array with new value</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.writeIniNetcdf">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">writeIniNetcdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">netfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">varlist</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputlist</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#writeIniNetcdf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.writeIniNetcdf" title="Permalink to this definition"></a></dt>
<dd><p>write variables to netcdf init file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>netfile</strong> – file name</p></li>
<li><p><strong>varlist</strong> – list of variable to be written in the netcdf file</p></li>
<li><p><strong>inputlist</strong> – stack of 1D arrays</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.data_handling.writenetcdf">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.data_handling.</span></span><span class="sig-name descname"><span class="pre">writenetcdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">netfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">varunits</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputmap</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeStamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posCnt</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flagTime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nrdays</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dateunit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/data_handling.html#writenetcdf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.data_handling.writenetcdf" title="Permalink to this definition"></a></dt>
<dd><p>write a netcdf stack</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>netfile</strong> – file name</p></li>
<li><p><strong>prename</strong> – 1st part of variable name with tell which variable e.g. discharge</p></li>
<li><p><strong>addname</strong> – part of the variable name with tells about the timestep e.g. daily, monthly</p></li>
<li><p><strong>varunits</strong> – unit of the variable</p></li>
<li><p><strong>inputmap</strong> – 1D array to be put as netcdf</p></li>
<li><p><strong>timeStamp</strong> – time</p></li>
<li><p><strong>posCnt</strong> – calculate nummer of the indece for time</p></li>
<li><p><strong>flag</strong> – to indicate if the file is new -> netcdf header has to be written,or simply appending data</p></li>
<li><p><strong>flagtime</strong> – to indicate the variable is time dependend (not a single array!)</p></li>
<li><p><strong>nrdays</strong> – (optional) if indicate number of days are set in the time variable (makes files smaller!)</p></li>
<li><p><strong>dateunit</strong> – (optional) dateunit indicate if the timestep in netcdf is days, month or years</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>flag: to indicate if the file is set up</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="timestep-module">
<h3>timestep module<a class="headerlink" href="#timestep-module" title="Permalink to this heading"></a></h3>
<p><strong>Managing time</strong></p>
<span class="target" id="module-cwatm.management_modules.timestep"></span><dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.Calendar">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">Calendar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errorNo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#Calendar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.Calendar" title="Permalink to this definition"></a></dt>
<dd><p>Get the date from CalendarDayStart in the settings xml
Reformatting the date till it fits to datetime</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input</strong> – string from the settingsfile should be somehow a date</p></li>
<li><p><strong>errorNo</strong> – 0: check startdate, enddate 1: check startinit</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>a datetime date</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.addmonths">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">addmonths</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">d</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#addmonths"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.addmonths" title="Permalink to this definition"></a></dt>
<dd><p>Adds months to a date</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>d</strong> – date</p></li>
<li><p><strong>x</strong> – month to add</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>date with added months</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.checkifDate">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">checkifDate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spinup</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#checkifDate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.checkifDate" title="Permalink to this definition"></a></dt>
<dd><p>Checks if start date is earlier than end date etc
And set some date variables</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>start</strong> – start date</p></li>
<li><p><strong>end</strong> – end date</p></li>
<li><p><strong>spinup</strong> – date till no output is generated = warming up time</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>a list of date variable in: dateVar</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.ctbinding">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">ctbinding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inBinding</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#ctbinding"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.ctbinding" title="Permalink to this definition"></a></dt>
<dd><p>Check if variable in settings file has a counterpart in source code</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>x</strong> – variable in settings file to be tested</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li></li>
</ul>
</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>if variable is not found send an error: <code class="xref py py-meth docutils literal notranslate"><span class="pre">management_modules.messages.CWATMError()</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.date2indexNew">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">date2indexNew</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nctime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">calendar</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">select</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'nearest'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#date2indexNew"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.date2indexNew" title="Permalink to this definition"></a></dt>
<dd><p>The original netCDF4 library cannot handle month and years
Replace: date2index
This one checks for days, month and years
And set some date variables</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>date</strong> – date</p></li>
<li><p><strong>nctime</strong> – time unit of the netcdf file</p></li>
<li><p><strong>select</strong> – (optional) which date is selected, default: nearest</p></li>
<li><p><strong>name</strong> – (optional) name of th dataset</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>index</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.date2str">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">date2str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#date2str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.date2str" title="Permalink to this definition"></a></dt>
<dd><p>Convert date to string of date e.g. 27/12/2018
:param date: date as (datetime)
:return: date string</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.datenum">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">datenum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#datenum"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.datenum" title="Permalink to this definition"></a></dt>
<dd><p>converts date to a int number based on the calender and unit of the netcdf file
:param date:
:return: number of the date</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.datetoInt">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">datetoInt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dateIn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">both</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#datetoInt"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.datetoInt" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the integer of a date from a reference date</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dateIn</strong> – date</p></li>
<li><p><strong>begin</strong> – reference date</p></li>
<li><p><strong>both</strong> – if set to True both the int and the string of the date are returned</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>integer value of a date, starting from begin date</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.datetosaveInit">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">datetosaveInit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">initdates</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#datetosaveInit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.datetosaveInit" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the save init dates</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>initdates</strong> – one or several dates</p></li>
<li><p><strong>begin</strong> – reference date</p></li>
<li><p><strong>end</strong> – end date</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>integer value of a dates, starting from begin date</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.numdate">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">numdate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#numdate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.numdate" title="Permalink to this definition"></a></dt>
<dd><p>converts int into date based on the calender and unit of the netcdf file
:param num: number of the day
:param add: addition to date in days
:return: date</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.timemeasure">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">timemeasure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loops</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#timemeasure"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.timemeasure" title="Permalink to this definition"></a></dt>
<dd><p>Measuring of the time for each subroutine</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – name of the subroutine</p></li>
<li><p><strong>loops</strong> – if it it called several times this is added to the name</p></li>
<li><p><strong>update</strong> – </p></li>
<li><p><strong>sample</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>add a string to the time measure string: timeMesString</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.timestep.timestep_dynamic">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.timestep.</span></span><span class="sig-name descname"><span class="pre">timestep_dynamic</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/timestep.html#timestep_dynamic"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.timestep.timestep_dynamic" title="Permalink to this definition"></a></dt>
<dd><p>Dynamic part of setting the date
Current date is increasing, checking if beginning of month, year</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>a list of date variable in: dateVar</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="configuration-module">
<h3>configuration module<a class="headerlink" href="#configuration-module" title="Permalink to this heading"></a></h3>
<p><strong>Loading and parsing of the settings file</strong></p>
<span class="target" id="module-cwatm.management_modules.configuration"></span><dl class="py class">
<dt class="sig sig-object py" id="cwatm.management_modules.configuration.ExtParser">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.configuration.</span></span><span class="sig-name descname"><span class="pre">ExtParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/configuration.html#ExtParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.configuration.ExtParser" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></p>
<p>addition to the parser to replace placeholders</p>
<p class="rubric">Example</p>
<p>PathRoot = C:/work
MaskMap = $(FILE_PATHS:PathRoot)/data/areamaps/area.tif</p>
<dl class="py method">
<dt class="sig sig-object py" id="cwatm.management_modules.configuration.ExtParser.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vars</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/configuration.html#ExtParser.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.configuration.ExtParser.get" title="Permalink to this definition"></a></dt>
<dd><p>def get(self, section, option, raw=False, vars=None
placeholder replacement</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>section</strong> – section part of the settings file</p></li>
<li><p><strong>option</strong> – option part of the settings file</p></li>
<li><p><strong>raw</strong> – </p></li>
<li><p><strong>vars</strong> – </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.configuration.parse_configuration">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.configuration.</span></span><span class="sig-name descname"><span class="pre">parse_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settingsFileName</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/configuration.html#parse_configuration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.configuration.parse_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Parse settings file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>settingsFileName</strong> – name of the settings file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>parameters in list: binding, options in list: option</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cwatm.management_modules.configuration.read_metanetcdf">
<span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.configuration.</span></span><span class="sig-name descname"><span class="pre">read_metanetcdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metaxml</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/configuration.html#read_metanetcdf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.configuration.read_metanetcdf" title="Permalink to this definition"></a></dt>
<dd><p>Read the metadata for netcdf output files
unit, long name, standard name and additional information</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>metaxml</strong> – file mit information for netcdf files (metadata)</p></li>
<li><p><strong>name</strong> – file name information</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List with metadata information: metaNetcdfVar</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="management-modules-messages-module">
<h3>management_modules.messages module<a class="headerlink" href="#management-modules-messages-module" title="Permalink to this heading"></a></h3>
<p><strong>Error handling - giving out messages</strong></p>
<span class="target" id="module-cwatm.management_modules.messages"></span><dl class="py exception">
<dt class="sig sig-object py" id="cwatm.management_modules.messages.CWATMDirError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.messages.</span></span><span class="sig-name descname"><span class="pre">CWATMDirError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/messages.html#CWATMDirError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.messages.CWATMDirError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cwatm.management_modules.messages.CWATMError" title="cwatm.management_modules.messages.CWATMError"><code class="xref py py-class docutils literal notranslate"><span class="pre">CWATMError</span></code></a></p>
<p>The error handling class
prints out an error</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Warning</strong> – class CWATMError</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>prints out a message about file error</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="cwatm.management_modules.messages.CWATMError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.messages.</span></span><span class="sig-name descname"><span class="pre">CWATMError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/messages.html#CWATMError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.messages.CWATMError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Warning</span></code></p>
<p>The error handling class
prints out an error</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Warning</strong> – class CWATMError</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>prints out a message about an error</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="cwatm.management_modules.messages.CWATMFileError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.messages.</span></span><span class="sig-name descname"><span class="pre">CWATMFileError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/messages.html#CWATMFileError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.messages.CWATMFileError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cwatm.management_modules.messages.CWATMError" title="cwatm.management_modules.messages.CWATMError"><code class="xref py py-class docutils literal notranslate"><span class="pre">CWATMError</span></code></a></p>
<p>The error handling class
prints out an error</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Warning</strong> – class CWATMError</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>prints out a message about file error</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="cwatm.management_modules.messages.CWATMRunInfo">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.messages.</span></span><span class="sig-name descname"><span class="pre">CWATMRunInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outputS</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/messages.html#CWATMRunInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.messages.CWATMRunInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Warning</span></code></p>
<p>prints out an error</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Warning</strong> – class warning</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>prints out a message</p>
</dd>
</dl>
<dl class="simple">
<dt>Warning</dt><dd><p>warning given with a header and a message from the subroutine</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="cwatm.management_modules.messages.CWATMWarning">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.messages.</span></span><span class="sig-name descname"><span class="pre">CWATMWarning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/messages.html#CWATMWarning"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.messages.CWATMWarning" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Warning</span></code></p>
<p>the error handling class
prints out an error</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Warning</strong> – class warning</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>prints out a message</p>
</dd>
</dl>
</dd></dl>
<p><strong>Handling output of CWatM</strong></p>
</section>
<section id="module-cwatm.management_modules.output">
<span id="management-modules-output-module"></span><h3>management_modules.output module<a class="headerlink" href="#module-cwatm.management_modules.output" title="Permalink to this heading"></a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="cwatm.management_modules.output.outputTssMap">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cwatm.management_modules.output.</span></span><span class="sig-name descname"><span class="pre">outputTssMap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cwatm/management_modules/output.html#outputTssMap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cwatm.management_modules.output.outputTssMap" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Output of time series and map</p>
<p><strong>Global variables</strong></p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Variable [self.var]</p></th>
<th class="head"><p>Description</p></th>
<th class="head"><p>Unit</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>dirUp</p></td>
<td><p>river network in upstream direction</p></td>
<td><p>–</p></td>
</tr>
<tr class="row-odd"><td><p>cellArea</p></td>
<td><p>Area of cell</p></td>
<td><p>m2</p></td>
</tr>