-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathparameters.html
More file actions
683 lines (565 loc) · 84.1 KB
/
Copy pathparameters.html
File metadata and controls
683 lines (565 loc) · 84.1 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>prms_python.parameters — PRMS-Python v1.0.0</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="../../_static/prms-python-32x.png"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link href='https://fonts.googleapis.com/css?family=Ubuntu+Mono|Pacifico|Open+Sans|Metrophobic' rel='stylesheet' type='text/css'>
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>
<span></span><span class="sd">'''</span>
<span class="sd">parameters.py -- holds ``Parameter`` class with multiple functionality for </span>
<span class="sd">the standard PRMS parameters input file.</span>
<span class="sd">'''</span>
<span class="kn">import</span> <span class="nn">datetime</span><span class="o">,</span> <span class="nn">calendar</span>
<span class="kn">import</span> <span class="nn">io</span><span class="o">,</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">itertools</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">from</span> <span class="nn">matplotlib.backends.backend_pdf</span> <span class="k">import</span> <span class="n">PdfPages</span>
<span class="kn">from</span> <span class="nn">mpl_toolkits.axes_grid1</span> <span class="k">import</span> <span class="n">make_axes_locatable</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">OrderedDict</span>
<span class="n">OPJ</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span>
<div class="viewcode-block" id="Parameters"><a class="viewcode-back" href="../../api.html#prms_python.Parameters">[docs]</a><span class="k">class</span> <span class="nc">Parameters</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Disk-based representation of a PRMS parameter file. </span>
<span class="sd"> </span>
<span class="sd"> For the sake of memory efficiency, we only load parameters from </span>
<span class="sd"> ``base_file`` that get modified through item assignment or accessed directly. </span>
<span class="sd"> Internally, a reference is kept to only previously accessed parameter data, </span>
<span class="sd"> so when ``write`` is called most copying is from ``base_file`` directly. </span>
<span class="sd"> When parameters are accessed or modified using the dictionary-like syntax, </span>
<span class="sd"> a ``np.ndarray`` representation of the parameter is returned. As a result </span>
<span class="sd"> ``numpy`` mathematical rules including efficient vectorization of math applied </span>
<span class="sd"> to arrays can be applied to modify parameters directly. The ``Parameter`` </span>
<span class="sd"> objects user methods allow for visualization of most PRMS parameters, function </span>
<span class="sd"> based modification of parameters, and a write function that writes the data </span>
<span class="sd"> back to PRMS text format. </span>
<span class="sd"> Arguments:</span>
<span class="sd"> base_file (str): path to PRMS parameters file </span>
<span class="sd"> Attributes:</span>
<span class="sd"> base_file (str): path to PRMS parameters file </span>
<span class="sd"> base_file_reader (file): file handle of PRMS parameters file</span>
<span class="sd"> dimensions (:obj:`collections.OrderedDict`): dictionary with </span>
<span class="sd"> parameter dimensions as defined in parameters file loaded on</span>
<span class="sd"> initialization</span>
<span class="sd"> base_params (list of dicts): list of dictionaries of parameter</span>
<span class="sd"> metadata loaded on initialization e.g. name, dimension(s), data </span>
<span class="sd"> type, length of data array, and lines where data starts and ends </span>
<span class="sd"> in file</span>
<span class="sd"> param_arrays (dict): dictionary with parameteter names as keys and</span>
<span class="sd"> ``numpy.array`` and ``numpy.ndarray`` representations of parameter</span>
<span class="sd"> values as keys. Initially empty, uses getter and setter functions.</span>
<span class="sd"> Example:</span>
<span class="sd"> >>> p = Parameters('path/to/a/parameter/file')</span>
<span class="sd"> >>> p['jh_coef'] = p['jh_coef']*1.1</span>
<span class="sd"> >>> p.write('example_modified_params')</span>
<span class="sd"> </span>
<span class="sd"> will read parameter information from the params file to check that</span>
<span class="sd"> *jh_coef* is present in the parameter file, read the lines corresponding</span>
<span class="sd"> to *jh_coef* data and assign the new value as requested. Calling</span>
<span class="sd"> the ``write`` method next will copy all parameters except *jh_coef*</span>
<span class="sd"> to the new parameter file and append the newly modified *jh_coef*</span>
<span class="sd"> to the end of the new file from the modified values stored in the</span>
<span class="sd"> parameter instance ``p``. </span>
<span class="sd"> '''</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_file</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">base_file</span> <span class="o">=</span> <span class="n">base_file</span>
<span class="bp">self</span><span class="o">.</span><span class="n">base_file_reader</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">base_file</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dimensions</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__read_base</span><span class="p">(</span><span class="n">base_file</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<div class="viewcode-block" id="Parameters.write"><a class="viewcode-back" href="../../api.html#prms_python.Parameters.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out_name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Writes current state of ``Parameters`` to disk in PRMS text format</span>
<span class="sd"> To reduce memory usage the ``write`` method copies parameters</span>
<span class="sd"> from the initial ``base_file`` parameter file for all parameters</span>
<span class="sd"> that were never modified. </span>
<span class="sd"> Arguments:</span>
<span class="sd"> out_name (str): path to write ``Parameters`` data to PRMS text</span>
<span class="sd"> format.</span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> """</span>
<span class="n">data_type_dic</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'1'</span><span class="p">:</span> <span class="s1">'int'</span><span class="p">,</span>
<span class="s1">'2'</span><span class="p">:</span> <span class="s1">'float'</span><span class="p">}</span> <span class="c1"># retain PRMS data types</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_file</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">)</span> <span class="k">as</span> <span class="n">base_file</span><span class="p">:</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">out_name</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">out_file</span><span class="p">:</span>
<span class="c1"># write metadata</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'File Auto-generated by PRMS-Python</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="c1"># # write dimensions</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'** Dimensions **</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="c1"># write parameters; pre-sorted by data start line on read</span>
<span class="n">name_is_next</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">params_start</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">write_params_lines</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">base_file</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">params_start</span> <span class="ow">and</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'** Parameters **'</span><span class="p">:</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'** Parameters **</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">params_start</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'####'</span><span class="p">:</span>
<span class="n">name_is_next</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">name_is_next</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="p">:</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'####</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">name</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">name_is_next</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">write_params_lines</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">write_params_lines</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">name_is_next</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">elif</span> <span class="n">write_params_lines</span><span class="p">:</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="c1"># write all parameters that had been accessed and/or modified</span>
<span class="k">for</span> <span class="n">param</span><span class="p">,</span> <span class="n">new_arr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'####</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">param_info</span> <span class="o">=</span> <span class="p">[</span><span class="n">el</span> <span class="k">for</span> <span class="n">el</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_params</span>
<span class="k">if</span> <span class="n">el</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">==</span> <span class="n">param</span><span class="p">]</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">param_info</span><span class="p">[</span><span class="s1">'name'</span><span class="p">])</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">param_info</span><span class="p">[</span><span class="s1">'ndims'</span><span class="p">])</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">dimname</span> <span class="ow">in</span> <span class="n">param_info</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">]:</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">dimname</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">param_info</span><span class="p">[</span><span class="s1">'length'</span><span class="p">])</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">param_info</span><span class="p">[</span><span class="s1">'vartype'</span><span class="p">])</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">writelines</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">a</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span>
<span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">new_arr</span><span class="o">.</span><span class="n">flatten</span><span class="p">()</span><span class="o">.</span>\
<span class="n">astype</span><span class="p">(</span><span class="n">data_type_dic</span><span class="p">[</span><span class="n">param_info</span>\
<span class="p">[</span><span class="s1">'vartype'</span><span class="p">]])])</span></div>
<div class="viewcode-block" id="Parameters.plot"><a class="viewcode-back" href="../../api.html#prms_python.Parameters.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nrows</span><span class="p">,</span> <span class="n">which</span><span class="o">=</span><span class="s1">'all'</span><span class="p">,</span> <span class="n">out_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">xlabel</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>\
<span class="n">ylabel</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">cbar_label</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">mpl_style</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Versatile method that plots most parameters in a standard PRMS parameter</span>
<span class="sd"> file assuming the PRMS model was built on a uniform spatial grid. </span>
<span class="sd"> </span>
<span class="sd"> Plots parameters as line plots for series or 2D spatial grid depending on </span>
<span class="sd"> parameter dimension. The PRMS parameter file is assumed to hold parameters </span>
<span class="sd"> for a model that was set up on a uniform rectangular grid with the spatial </span>
<span class="sd"> index of HRUs starting in the upper left corner and moving left to </span>
<span class="sd"> right across columns and down rows. Default function is to print four</span>
<span class="sd"> files, each with plots of varying parameter dimensions as explained </span>
<span class="sd"> under Kwargs ``which`` and more detailed explanation in the example</span>
<span class="sd"> `Jupyter notebook <https://github.com/PRMS-Python/PRMS-Python/blob/master/notebooks/param_examples.ipynb>`_.</span>
<span class="sd"> </span>
<span class="sd"> Arguments:</span>
<span class="sd"> nrows (int): The number of rows in the PRMS model grid for plotting </span>
<span class="sd"> spatial parameters. Will only work correctly for rectangular gridded models </span>
<span class="sd"> with HRU indices starting in the upper left cell moving left to right </span>
<span class="sd"> across columns and down across rows.</span>
<span class="sd"> </span>
<span class="sd"> Keyword Arguments:</span>
<span class="sd"> which (str): name of PRMS parameter to plot or 'all'. If 'all' then</span>
<span class="sd"> the function will print 3 multipage pdfs, one for nhru </span>
<span class="sd"> dimensional parameters, one for nhru by monthly parameters, one </span>
<span class="sd"> for other parameters of length > 1, and one html file containing</span>
<span class="sd"> single valued parameters.</span>
<span class="sd"> out_dir (str): path to an output dir, default current directory</span>
<span class="sd"> xlabel (str): x label for plot(s)</span>
<span class="sd"> ylabel (str): y label for plot(s)</span>
<span class="sd"> cbar_label (str): label for colorbar on spatial plot(s)</span>
<span class="sd"> title (str): plot title</span>
<span class="sd"> mpl_style (str, list): name or list of names of matplotlib style sheets to </span>
<span class="sd"> use for plot(s).</span>
<span class="sd"> </span>
<span class="sd"> Returns: </span>
<span class="sd"> None</span>
<span class="sd"> Examples:</span>
<span class="sd"> If the plot method is called with the keyword argument ``which`` set</span>
<span class="sd"> to a parameter that has length one, i.e. single valued it will simply</span>
<span class="sd"> print out the value e.g.:</span>
<span class="sd"> >>> p = Parameters('path/to/parameters')</span>
<span class="sd"> >>> p.plot(nrows=10, which='radj_sppt')</span>
<span class="sd"> radj_sppt is single valued with value: 0.4924942352224324</span>
<span class="sd"> The default action is particularly useful which makes four multi-page</span>
<span class="sd"> pdfs of most PRMS parameters where each file contains parameters</span>
<span class="sd"> of different dimensions e.g.:</span>
<span class="sd"> >>> p.plot(nrows=10, which='all', mpl_style='ggplot')</span>
<span class="sd"> will produce the following four files named by parameters of certain</span>
<span class="sd"> dimensions:</span>
<span class="sd"> >>> import os</span>
<span class="sd"> >>> os.listdir(os.getcwd()) # list files in current directory</span>
<span class="sd"> nhru_param_maps.pdf </span>
<span class="sd"> nhru_by_nmonths_param_maps.pdf</span>
<span class="sd"> non_spatial_param_plots.pdf </span>
<span class="sd"> single_valued_params.html</span>
<span class="sd"> </span>
<span class="sd"> """</span>
<span class="n">params</span> <span class="o">=</span> <span class="bp">self</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">Parameters</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'params must be instance of Parameters, not '</span>\
<span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">params</span><span class="p">)))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">out_dir</span><span class="p">:</span>
<span class="n">out_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">out_dir</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">out_dir</span><span class="p">)</span>
<span class="n">nhru</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="s1">'nhru'</span><span class="p">]</span>
<span class="n">ncols</span> <span class="o">=</span> <span class="n">nhru</span> <span class="o">//</span> <span class="n">nrows</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">mpl_style</span><span class="p">:</span>
<span class="n">mpl_style</span> <span class="o">=</span> <span class="s1">'classic'</span>
<span class="n">plt</span><span class="o">.</span><span class="n">style</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="n">mpl_style</span><span class="p">)</span>
<span class="c1"># make pdfs and html of all parameters seperated in 4 files based on dimension</span>
<span class="k">if</span> <span class="n">which</span> <span class="o">==</span> <span class="s1">'all'</span><span class="p">:</span>
<span class="c1">## spatial parameters with dimension of length nhru</span>
<span class="n">p_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span>\
<span class="n">param</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span> <span class="o">==</span> <span class="n">nhru</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">param</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">])</span><span class="o">==</span><span class="mi">1</span><span class="p">]</span>
<span class="k">with</span> <span class="n">PdfPages</span><span class="p">(</span><span class="n">OPJ</span><span class="p">(</span><span class="n">out_dir</span><span class="p">,</span><span class="s1">'nhru_param_maps.pdf'</span><span class="p">))</span> <span class="k">as</span> <span class="n">pdf</span><span class="p">:</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">p_names</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">'</span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">p</span><span class="p">)]</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">nrows</span><span class="p">,</span><span class="n">ncols</span><span class="p">),</span> <span class="n">origin</span><span class="o">=</span><span class="s1">'upper'</span><span class="p">)</span>
<span class="c1"># origin upper- assumes indices of parameters starts in upper left</span>
<span class="n">divider</span> <span class="o">=</span> <span class="n">make_axes_locatable</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
<span class="n">cax</span> <span class="o">=</span> <span class="n">divider</span><span class="o">.</span><span class="n">append_axes</span><span class="p">(</span><span class="s2">"right"</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="s2">"5%"</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mf">0.05</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="n">cax</span><span class="o">=</span><span class="n">cax</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">'</span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">p</span><span class="p">))</span>
<span class="n">ax</span><span class="o">.</span><span class="n">tick_params</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">bottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelleft</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span><span class="n">labelbottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">)</span>
<span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{param}</span><span class="s1"> parameter failed to plot'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param</span><span class="o">=</span><span class="n">p</span><span class="p">))</span>
<span class="c1">## monthly spatial parameters (on plot per month)</span>
<span class="n">p_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span>\
<span class="n">param</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'nhru'</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">param</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">])</span><span class="o">==</span><span class="mi">2</span> <span class="p">]</span>
<span class="k">with</span> <span class="n">PdfPages</span><span class="p">(</span><span class="n">OPJ</span><span class="p">(</span><span class="n">out_dir</span><span class="p">,</span><span class="s1">'nhru_by_nmonths_param_maps.pdf'</span><span class="p">))</span> <span class="k">as</span> <span class="n">pdf</span><span class="p">:</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">p_names</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">12</span><span class="p">):</span> <span class="c1">#month</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">'</span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">p</span><span class="p">)][</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">nrows</span><span class="p">,</span> <span class="n">ncols</span><span class="p">),</span> <span class="n">origin</span><span class="o">=</span><span class="s1">'upper'</span><span class="p">)</span>
<span class="n">divider</span> <span class="o">=</span> <span class="n">make_axes_locatable</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
<span class="n">cax</span> <span class="o">=</span> <span class="n">divider</span><span class="o">.</span><span class="n">append_axes</span><span class="p">(</span><span class="s2">"right"</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="s2">"5%"</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mf">0.05</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="n">cax</span><span class="o">=</span><span class="n">cax</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">'</span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">calendar</span><span class="o">.</span><span class="n">month_name</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">ax</span><span class="o">.</span><span class="n">tick_params</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">bottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelleft</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelbottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">)</span>
<span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{param}</span><span class="s1"> for </span><span class="si">{month}</span><span class="s1"> failed to plot'</span><span class="o">.</span>\
<span class="nb">format</span><span class="p">(</span><span class="n">param</span><span class="o">=</span><span class="n">p</span><span class="p">,</span> <span class="n">month</span><span class="o">=</span><span class="n">calendar</span><span class="o">.</span><span class="n">month_name</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]))</span>
<span class="c1">## non spatial parameters with dimension length > 1 to be plotted as time series</span>
<span class="n">p_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span>\
<span class="p">(</span> <span class="mi">1</span> <span class="o"><</span> <span class="n">param</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span> <span class="o"><=</span> <span class="mi">366</span> <span class="p">)</span>\
<span class="ow">and</span> <span class="n">param</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'nhru'</span> <span class="p">]</span>
<span class="k">with</span> <span class="n">PdfPages</span><span class="p">(</span><span class="n">OPJ</span><span class="p">(</span><span class="n">out_dir</span><span class="p">,</span><span class="s1">'non_spatial_param_plots.pdf'</span><span class="p">))</span> <span class="k">as</span> <span class="n">pdf</span><span class="p">:</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">p_names</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">param_dict</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span> <span class="n">param</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">==</span> <span class="n">p</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="n">params</span><span class="p">[</span><span class="n">p</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="n">param_dict</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlim</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span><span class="o">+</span><span class="mf">0.5</span><span class="p">)</span>
<span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{param}</span><span class="s1"> parameter failed to plot'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param</span><span class="o">=</span><span class="n">p</span><span class="p">))</span>
<span class="c1">## html table of parameters with dimension length = 1 </span>
<span class="n">p_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span> <span class="n">param</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span><span class="p">]</span>
<span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">()</span>
<span class="n">df</span><span class="o">.</span><span class="n">index</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s1">'parameter'</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">p_names</span><span class="p">:</span>
<span class="n">df</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="s1">'value'</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="n">p</span><span class="p">])</span>
<span class="n">df</span><span class="o">.</span><span class="n">to_html</span><span class="p">(</span><span class="n">OPJ</span><span class="p">(</span><span class="n">out_dir</span><span class="p">,</span><span class="s1">'single_valued_params.html'</span><span class="p">))</span>
<span class="c1">################################################################ </span>
<span class="c1"># plot single parameter, in case of nhru by monthly param, </span>
<span class="c1"># save multi-page pdf </span>
<span class="k">else</span><span class="p">:</span>
<span class="n">param_name</span> <span class="o">=</span> <span class="n">which</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="n">which</span><span class="p">]</span>
<span class="k">except</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{param}</span><span class="s1"> is not a valid PRMS parameter'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param</span><span class="o">=</span><span class="n">param_name</span><span class="p">))</span>
<span class="k">return</span>
<span class="n">param_dict</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span> <span class="n">param</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">==</span> <span class="n">param_name</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="c1"># labels for single plots</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">cbar_label</span><span class="p">:</span>
<span class="n">cbar_label</span> <span class="o">=</span> <span class="n">param_name</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">title</span><span class="p">:</span>
<span class="n">title</span> <span class="o">=</span> <span class="s1">''</span>
<span class="c1"># if parameter is not spatial, one dimensional, with length greater than one, plot as line</span>
<span class="k">if</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'ndims'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="p">(</span> <span class="mi">1</span> <span class="o"><</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span> <span class="o"><=</span> <span class="mi">366</span> <span class="p">)</span>\
<span class="ow">and</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'nhru'</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">xlabel</span><span class="p">:</span>
<span class="n">xlabel</span> <span class="o">=</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ylabel</span><span class="p">:</span>
<span class="n">ylabel</span> <span class="o">=</span> <span class="n">param_name</span>
<span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">),</span> <span class="n">params</span><span class="p">[</span><span class="n">param_name</span><span class="p">])</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlim</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span><span class="o">+</span><span class="mf">0.5</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">xlabel</span><span class="p">(</span><span class="n">xlabel</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ylabel</span><span class="p">(</span><span class="n">ylabel</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
<span class="c1"># if spatial and one dimensional, plot</span>
<span class="k">elif</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'ndims'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span> <span class="o">==</span> <span class="n">params</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="s1">'nhru'</span><span class="p">]:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">xlabel</span><span class="p">:</span>
<span class="n">xlabel</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ylabel</span><span class="p">:</span>
<span class="n">ylabel</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="n">param_name</span><span class="p">]</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">nrows</span><span class="p">,</span><span class="n">ncols</span><span class="p">),</span> <span class="n">origin</span><span class="o">=</span><span class="s1">'upper'</span><span class="p">)</span>
<span class="n">divider</span> <span class="o">=</span> <span class="n">make_axes_locatable</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
<span class="n">cax</span> <span class="o">=</span> <span class="n">divider</span><span class="o">.</span><span class="n">append_axes</span><span class="p">(</span><span class="s2">"right"</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="s2">"5%"</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mf">0.05</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="n">cax</span><span class="o">=</span><span class="n">cax</span><span class="p">,</span><span class="n">label</span><span class="o">=</span><span class="n">cbar_label</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">tick_params</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">bottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelleft</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelbottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="n">ylabel</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="n">xlabel</span><span class="p">)</span>
<span class="c1"># spatial monthly parameter</span>
<span class="k">elif</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'nhru'</span> <span class="ow">and</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'nmonths'</span>\
<span class="ow">and</span> <span class="n">param_dict</span><span class="p">[</span><span class="s1">'ndims'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">xlabel</span><span class="p">:</span>
<span class="n">xlabel</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ylabel</span><span class="p">:</span>
<span class="n">ylabel</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">file_name</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{}</span><span class="s1">.pdf'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param_name</span><span class="p">)</span>
<span class="k">with</span> <span class="n">PdfPages</span><span class="p">(</span><span class="n">OPJ</span><span class="p">(</span><span class="n">out_dir</span><span class="p">,</span> <span class="n">file_name</span><span class="p">))</span> <span class="k">as</span> <span class="n">pdf</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">12</span><span class="p">):</span> <span class="c1">#month</span>
<span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
<span class="n">im</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">'</span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param_name</span><span class="p">)][</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">nrows</span><span class="p">,</span><span class="n">ncols</span><span class="p">),</span> <span class="n">origin</span><span class="o">=</span><span class="s1">'upper'</span><span class="p">)</span>
<span class="n">divider</span> <span class="o">=</span> <span class="n">make_axes_locatable</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
<span class="n">cax</span> <span class="o">=</span> <span class="n">divider</span><span class="o">.</span><span class="n">append_axes</span><span class="p">(</span><span class="s2">"right"</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="s2">"5%"</span><span class="p">,</span> <span class="n">pad</span><span class="o">=</span><span class="mf">0.05</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">(</span><span class="n">im</span><span class="p">,</span> <span class="n">cax</span><span class="o">=</span><span class="n">cax</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">'</span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param_name</span><span class="p">,</span> <span class="n">calendar</span><span class="o">.</span><span class="n">month_name</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="n">ylabel</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="n">xlabel</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">tick_params</span><span class="p">(</span><span class="n">left</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">bottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelleft</span><span class="o">=</span><span class="s1">'off'</span><span class="p">,</span> <span class="n">labelbottom</span><span class="o">=</span><span class="s1">'off'</span><span class="p">)</span>
<span class="n">pdf</span><span class="o">.</span><span class="n">savefig</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="n">param_name</span><span class="p">]</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{param}</span><span class="s1"> is single valued with value: </span><span class="si">{v}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">param</span><span class="o">=</span><span class="n">param_name</span><span class="p">,</span> <span class="n">v</span><span class="o">=</span><span class="n">val</span><span class="p">))</span> </div>
<span class="k">def</span> <span class="nf">__read_base</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_file</span><span class="p">):</span>
<span class="s2">"Read base file returning 2-tuple of dimension and params dict"</span>
<span class="n">params_startline</span><span class="p">,</span> <span class="n">dimensions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__make_dimensions_dict</span><span class="p">(</span><span class="n">base_file</span><span class="p">)</span>
<span class="n">base_params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__make_parameter_dict</span><span class="p">(</span><span class="n">base_file</span><span class="p">,</span> <span class="n">params_startline</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">dimensions</span><span class="p">,</span> <span class="n">base_params</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__make_dimensions_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_file</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extract dimensions and each dimension length. Runs before</span>
<span class="sd"> __make_parameter_dict.</span>
<span class="sd"> """</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span>
<span class="n">dim_name</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">dim_len</span> <span class="o">=</span> <span class="mi">0</span>
<span class="c1"># finished = False</span>
<span class="n">found_dim_start</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># while not finished:</span>
<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">l</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_file_reader</span><span class="p">):</span>
<span class="k">if</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'** Dimensions **'</span><span class="p">:</span> <span class="c1"># start of dimensions</span>
<span class="n">found_dim_start</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="s1">'#'</span> <span class="ow">in</span> <span class="n">l</span><span class="p">:</span> <span class="c1"># comments</span>
<span class="k">pass</span>
<span class="k">elif</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'** Parameters **'</span><span class="p">:</span> <span class="c1"># start of parameters</span>
<span class="n">dimlines</span> <span class="o">=</span> <span class="n">idx</span>
<span class="c1"># finished = True</span>
<span class="k">break</span>
<span class="k">elif</span> <span class="n">found_dim_start</span><span class="p">:</span>
<span class="k">if</span> <span class="n">dim_name</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
<span class="n">dim_name</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">dim_len</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">l</span><span class="p">)</span>
<span class="n">ret</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">dim_name</span><span class="p">:</span> <span class="n">dim_len</span><span class="p">})</span>
<span class="n">dim_name</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">return</span> <span class="p">(</span><span class="n">dimlines</span><span class="p">,</span> <span class="n">ret</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__make_parameter_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base_file</span><span class="p">,</span> <span class="n">params_startline</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="n">ret</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">name</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">ndims</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">dimnames</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">length</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">vartype</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">dimnames_read</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">data_startline</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">l</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_file_reader</span><span class="p">):</span>
<span class="k">if</span> <span class="s1">'#'</span> <span class="ow">in</span> <span class="n">l</span><span class="p">:</span>
<span class="c1"># we have a comment; the next lines will be new</span>
<span class="c1"># parameter metadata. No data for the first time through, so</span>
<span class="c1"># we don't want to append an metadata blob with empty values</span>
<span class="k">if</span> <span class="n">name</span><span class="p">:</span>
<span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="nb">dict</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
<span class="n">ndims</span><span class="o">=</span><span class="n">ndims</span><span class="p">,</span>
<span class="n">dimnames</span><span class="o">=</span><span class="n">dimnames</span><span class="p">,</span>
<span class="n">length</span><span class="o">=</span><span class="n">length</span><span class="p">,</span>
<span class="n">vartype</span><span class="o">=</span><span class="n">vartype</span><span class="p">,</span>
<span class="n">data_startline</span><span class="o">=</span><span class="n">data_startline</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="n">name</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">ndims</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">dimnames</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">length</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">vartype</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">dimnames_read</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">name</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># in case old format with integer after name</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">ndims</span><span class="p">:</span>
<span class="n">ndims</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="p">(</span><span class="n">dimnames_read</span> <span class="o">==</span> <span class="n">ndims</span><span class="p">):</span>
<span class="n">dimnames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="n">dimnames_read</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">length</span><span class="p">:</span>
<span class="n">length</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">vartype</span><span class="p">:</span>
<span class="n">vartype</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="c1"># advance one from current position and account for starting</span>
<span class="c1"># to count from zero</span>
<span class="n">data_startline</span> <span class="o">=</span> <span class="n">params_startline</span> <span class="o">+</span> <span class="n">idx</span> <span class="o">+</span> <span class="mi">2</span>
<span class="c1"># need to append one more time since iteration will have stopped after</span>
<span class="c1"># last line</span>
<span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="nb">dict</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
<span class="n">ndims</span><span class="o">=</span><span class="n">ndims</span><span class="p">,</span>
<span class="n">dimnames</span><span class="o">=</span><span class="n">dimnames</span><span class="p">,</span>
<span class="n">length</span><span class="o">=</span><span class="n">length</span><span class="p">,</span>
<span class="n">vartype</span><span class="o">=</span><span class="n">vartype</span><span class="p">,</span>
<span class="n">data_startline</span><span class="o">=</span><span class="n">data_startline</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">ret</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Look up a parameter by its name.</span>
<span class="sd"> Raises:</span>
<span class="sd"> KeyError if parameter name is not valid</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">load_parameter_array</span><span class="p">(</span><span class="n">param_metadata</span><span class="p">):</span>
<span class="n">startline</span> <span class="o">=</span> <span class="n">param_metadata</span><span class="p">[</span><span class="s1">'data_startline'</span><span class="p">]</span>
<span class="n">endline</span> <span class="o">=</span> <span class="n">startline</span> <span class="o">+</span> <span class="n">param_metadata</span><span class="p">[</span><span class="s1">'length'</span><span class="p">]</span> <span class="o">+</span> <span class="mi">1</span>
<span class="n">param_slice</span> <span class="o">=</span> <span class="n">itertools</span><span class="o">.</span><span class="n">islice</span><span class="p">(</span>
<span class="n">io</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_file</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">),</span> <span class="n">startline</span><span class="p">,</span> <span class="n">endline</span>
<span class="p">)</span>
<span class="n">arr</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">genfromtxt</span><span class="p">(</span><span class="n">param_slice</span><span class="p">)</span>
<span class="k">if</span> <span class="n">param_metadata</span><span class="p">[</span><span class="s1">'ndims'</span><span class="p">]</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="n">dimsizes</span> <span class="o">=</span> <span class="p">[</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dimensions</span><span class="p">[</span><span class="n">d</span><span class="p">]</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">param_metadata</span><span class="p">[</span><span class="s1">'dimnames'</span><span class="p">]</span>
<span class="p">]</span>
<span class="n">dimsizes</span><span class="o">.</span><span class="n">reverse</span><span class="p">()</span>
<span class="n">arr</span> <span class="o">=</span> <span class="n">arr</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">dimsizes</span><span class="p">)</span>
<span class="k">return</span> <span class="n">arr</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">param_metadata</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">el</span> <span class="k">for</span> <span class="n">el</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_params</span> <span class="k">if</span> <span class="n">el</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">==</span> <span class="n">key</span>
<span class="p">]</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="n">arr</span> <span class="o">=</span> <span class="n">load_parameter_array</span><span class="p">(</span><span class="n">param_metadata</span><span class="p">)</span>
<span class="c1"># cache the value for future access (but maybe shouldn't?)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">key</span><span class="p">:</span> <span class="n">arr</span><span class="p">})</span>
<span class="k">return</span> <span class="n">arr</span>
<span class="k">def</span> <span class="nf">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="p">:</span>
<span class="n">cur_arr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="o">.</span><span class="n">shape</span> <span class="o">==</span> <span class="n">cur_arr</span><span class="o">.</span><span class="n">shape</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'New array does not match existing'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">param_arrays</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="modify_params"><a class="viewcode-back" href="../../api.html#prms_python.modify_params">[docs]</a><span class="k">def</span> <span class="nf">modify_params</span><span class="p">(</span><span class="n">params_in</span><span class="p">,</span> <span class="n">params_out</span><span class="p">,</span> <span class="n">param_mods</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Given a parameter file in and a dictionary of param_mods, write modified</span>
<span class="sd"> parameters to params_out.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> params_in (str): location on disk of the base parameter file</span>
<span class="sd"> params_out (str): location on disk where the modified parameters will </span>
<span class="sd"> be written</span>
<span class="sd"> Keyword Arguments:</span>
<span class="sd"> param_mods (dict): param name-keyed, param modification function-valued</span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> Example:</span>
<span class="sd"> Below we modify the monthly *jh_coef* parameter by increasing it 10% </span>
<span class="sd"> for every month,</span>
<span class="sd"> </span>
<span class="sd"> >>> params_in = 'models/lbcd/parameters'</span>
<span class="sd"> >>> params_out = 'scenarios/jh_coef_1.1/params'</span>
<span class="sd"> >>> scale_10pct = lambda x: x * 1.1</span>
<span class="sd"> >>> modify_params(params_in, params_out, {'jh_coef': scale_10pct})</span>
<span class="sd"> </span>
<span class="sd"> So param_mods is a dictionary of with keys being parameter names and</span>
<span class="sd"> values a function that operates on a single value. Currently we only</span>
<span class="sd"> accept functions that operate without reference to any other </span>
<span class="sd"> parameters. The function will be applied to every cell, month, or </span>
<span class="sd"> cascade routing rule for which the parameter is defined.</span>
<span class="sd"> '''</span>
<span class="n">p_in</span> <span class="o">=</span> <span class="n">Parameters</span><span class="p">(</span><span class="n">params_in</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">param_mods</span><span class="p">:</span>
<span class="n">p_in</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">param_mods</span><span class="p">[</span><span class="n">k</span><span class="p">](</span><span class="n">p_in</span><span class="p">[</span><span class="n">k</span><span class="p">])</span>
<span class="n">p_in</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">params_out</span><span class="p">)</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="../../index.html">
<img class="logo" src="../../_static/prms-python-200x.png" alt="Logo"/>
</a>
</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=PRMS-Python&repo=docs&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">Tutorial and Recipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html#example-parameter-sensitivity">Example: Parameter sensitivity</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cli.html">Command-Line Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api.html#indices-and-tables">Indices and tables</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, John Volk and Matthew Turner.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
</div>
</body>
</html>