-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscenario.html
More file actions
709 lines (572 loc) · 59.5 KB
/
Copy pathscenario.html
File metadata and controls
709 lines (572 loc) · 59.5 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
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
<!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.scenario — 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.scenario</h1><div class="highlight"><pre>
<span></span><span class="sd">'''</span>
<span class="sd">scenario.py -- holds ``Scenario`` and ``ScenarioSeries`` classes for PRMS </span>
<span class="sd">managing parameter-based model scenarios that may be used for hypotheses</span>
<span class="sd">testing.</span>
<span class="sd">'''</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">multiprocessing</span> <span class="k">as</span> <span class="nn">mp</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">shutil</span>
<span class="kn">import</span> <span class="nn">uuid</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span>
<span class="kn">from</span> <span class="nn">.parameters</span> <span class="k">import</span> <span class="n">modify_params</span><span class="p">,</span> <span class="n">Parameters</span>
<span class="kn">from</span> <span class="nn">.data</span> <span class="k">import</span> <span class="n">Data</span>
<span class="kn">from</span> <span class="nn">.util</span> <span class="k">import</span> <span class="n">load_statvar</span>
<span class="kn">from</span> <span class="nn">.simulation</span> <span class="k">import</span> <span class="n">Simulation</span>
<div class="viewcode-block" id="ScenarioSeries"><a class="viewcode-back" href="../../api.html#prms_python.ScenarioSeries">[docs]</a><span class="k">class</span> <span class="nc">ScenarioSeries</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create and manage a series of model runs where parameters are modified. </span>
<span class="sd"> </span>
<span class="sd"> First initialize the series with an optional title and description. </span>
<span class="sd"> Then to build the series the user provides a list of dictionaries with </span>
<span class="sd"> parameter-function key-value pairs, and optionally a title and </span>
<span class="sd"> description for each dictionary defining the individual scenario.</span>
<span class="sd"> The ScenarioSeries' ``build`` method creates a file structure under</span>
<span class="sd"> the series directory (``scenarios_dir``) where each subdirectory is </span>
<span class="sd"> named with a :mod:`uuid` which can be later matched to its title using </span>
<span class="sd"> the metadata in ``scenario_dir/series_metadata.json`` (see :mod:`json`). </span>
<span class="sd"> In the future we may add a way for the user to access the results of </span>
<span class="sd"> the scenario simulations directly through the ``ScenarioSeries`` </span>
<span class="sd"> instance, but for now the results are written to disk. Therefore each </span>
<span class="sd"> scenario's title metadata can be used to refer to which parmaters were </span>
<span class="sd"> modified and how for post-processing and analysis. One could also use </span>
<span class="sd"> the description metadata for this purpose. </span>
<span class="sd"> Arguments:</span>
<span class="sd"> base_dir (str): path to base inputs; 'control', 'parameters',</span>
<span class="sd"> and 'data' must be present there</span>
<span class="sd"> scenarios_dir (str): directory where scenario data will be written</span>
<span class="sd"> to; will be overwritten or created if it does not exist</span>
<span class="sd"> Keyword Arguments:</span>
<span class="sd"> title (str, optional): title of the ScenarioSeries instance</span>
<span class="sd"> description (str, optional): description of the ScenarioSeries </span>
<span class="sd"> instance</span>
<span class="sd"> Attributes:</span>
<span class="sd"> metadata (dict): dictionary with title, description, and UUID map</span>
<span class="sd"> dictionary for individiual ``Scenario`` output directories, </span>
<span class="sd"> the UUID dictionary (``uuid_title_map``)is left empty until </span>
<span class="sd"> calling :meth:`ScenarioSeries.build`.</span>
<span class="sd"> scenarios (list): empty list that will be filled with ``Scenario``s</span>
<span class="sd"> after defining them by calling :meth:`ScenarioSeries.build`.</span>
<span class="sd"> Example:</span>
<span class="sd"> There are three steps to both ``Scenario`` and ScenarioSeries,</span>
<span class="sd"> first we initialize the object</span>
<span class="sd"> >>> series = ScenarioSeries(</span>
<span class="sd"> base_dir = 'dir_with_input_files',</span>
<span class="sd"> scenarios_dir = 'dir_to_run_series',</span>
<span class="sd"> title = 'title_for_group_of_scenarios',</span>
<span class="sd"> description = 'description_for_scenarios'</span>
<span class="sd"> )</span>
<span class="sd"> </span>
<span class="sd"> The next step is to "build" the ``ScenarioSeries`` by calling the </span>
<span class="sd"> :meth:`ScenarioSeries.build` method which defines which parameters</span>
<span class="sd"> to modify, how to modify them, and then performs the modification</span>
<span class="sd"> which readies the series to be "run" (the last step). See the</span>
<span class="sd"> :meth:`ScenarioSeries.build` method for the next step example. </span>
<span class="sd"> </span>
<span class="sd"> Also see :ref:`scenario_and_scenarioseries_tutorial` for full example</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_dir</span><span class="p">,</span> <span class="n">scenarios_dir</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">description</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">base_dir</span> <span class="o">=</span> <span class="n">base_dir</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scenarios_dir</span> <span class="o">=</span> <span class="n">scenarios_dir</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">scenarios_dir</span><span class="p">):</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">scenarios_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">scenarios_dir</span><span class="p">)</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">copytree</span><span class="p">(</span><span class="n">base_dir</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">scenarios_dir</span><span class="p">,</span> <span class="s1">'base_inputs'</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">uuid_title_map</span><span class="o">=</span><span class="p">{})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scenarios</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">outputs</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="ScenarioSeries.from_parameters_iter"><a class="viewcode-back" href="../../api.html#prms_python.ScenarioSeries.from_parameters_iter">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_parameters_iter</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">base_directory</span><span class="p">,</span> <span class="n">parameters_iter</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">description</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">'''</span>
<span class="sd"> Alternative way to initialize and build a ``ScenarioSeries`` in one</span>
<span class="sd"> step.</span>
<span class="sd"> Create and build a ``ScenarioSeries`` by including the param-keyed-</span>
<span class="sd"> function-valued dictionary (``parameters_iter``) that is otherwise </span>
<span class="sd"> passed in :meth:`ScenarioSeries.build`. </span>
<span class="sd"> Arguments:</span>
<span class="sd"> base_directory (str): directory that contains model input files</span>
<span class="sd"> parameters_iter (list of dicts): list of dictionaries for each</span>
<span class="sd"> ``Scenario`` as described in :class:`Scenario` and </span>
<span class="sd"> :meth:`ScenarioSeries.build`.</span>
<span class="sd"> title (str): title for group of scenarios</span>
<span class="sd"> description (str): description for group of scenarios</span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> '''</span>
<span class="n">series</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">base_directory</span><span class="p">,</span> <span class="n">base_directory</span><span class="p">,</span>
<span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">)</span>
<span class="k">for</span> <span class="n">parameters</span> <span class="ow">in</span> <span class="n">parameters_iter</span><span class="p">:</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">parameters</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span> <span class="k">if</span> <span class="s1">'title'</span> <span class="ow">in</span> <span class="n">parameters</span> <span class="k">else</span> <span class="kc">None</span>
<span class="n">uu</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
<span class="n">series</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">'uuid_title_map'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">uu</span><span class="p">:</span> <span class="n">title</span><span class="p">})</span>
<span class="n">scenario_dir</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><span class="p">(</span><span class="n">series</span><span class="o">.</span><span class="n">scenarios_dir</span><span class="p">,</span> <span class="n">uu</span><span class="p">)</span>
<span class="n">scenario</span> <span class="o">=</span> <span class="n">Scenario</span><span class="p">(</span><span class="n">series</span><span class="o">.</span><span class="n">base_dir</span><span class="p">,</span> <span class="n">scenario_dir</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">)</span>
<span class="n">scenario</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
<span class="n">series</span><span class="o">.</span><span class="n">scenarios</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">scenario</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">series</span><span class="o">.</span><span class="n">scenarios_dir</span><span class="p">,</span> <span class="s1">'series_metadata.json'</span><span class="p">),</span> <span class="s1">'w'</span>
<span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">series</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span></div>
<span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenarios</span><span class="p">)</span>
<div class="viewcode-block" id="ScenarioSeries.build"><a class="viewcode-back" href="../../api.html#prms_python.ScenarioSeries.build">[docs]</a> <span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">scenarios_list</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Build the scenarios from a list of scenario definitions in dicitonary</span>
<span class="sd"> form. </span>
<span class="sd"> </span>
<span class="sd"> Each element of ``scenarios_list`` can have any number of parameters</span>
<span class="sd"> as keys with a function for each value. The other two acceptable keys</span>
<span class="sd"> are ``title`` and ``description`` which will be passed on to each </span>
<span class="sd"> individual Scenario's metadata in ``series_metadata.json`` for future </span>
<span class="sd"> lookups. The ``build`` method also creates a file structure that uses</span>
<span class="sd"> UUID values as individiual ``Scenario`` subdirectories as shown below.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> scenarios_list (list): list of dictionaries with key-value</span>
<span class="sd"> pairs being parameter-function definition pairs or</span>
<span class="sd"> title-title string or description-description string.</span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> Examples:</span>
<span class="sd"> Following the initialization of a ``ScenarioSeries`` instance as</span>
<span class="sd"> shown the example docstring there, we "build" the series by </span>
<span class="sd"> defining a list of param named-keyed function-valued </span>
<span class="sd"> dictionaries. This example uses arbitrary functions on two </span>
<span class="sd"> PRMS parameters *snowinfil_max* and *snow_adj*,</span>
<span class="sd"> >>> def _function1(x): #Note, function must start with underscore</span>
<span class="sd"> return x * 0.5</span>
<span class="sd"> >>> def _function2(x):</span>
<span class="sd"> return x + 5</span>
<span class="sd"> >>> dic1 = {'snowinfil_max': _function1, 'title': 'scenario1'}</span>
<span class="sd"> >>> dic2 = {'snowinfil_max': _function2, </span>
<span class="sd"> 'snow_adj': function1,</span>
<span class="sd"> 'title': 'scenario2',</span>
<span class="sd"> 'description': 'we adjusted two snow parameters'</span>
<span class="sd"> }</span>
<span class="sd"> >>> example_scenario_list = [dic1, dic2]</span>
<span class="sd"> >>> # now we can build the series</span>
<span class="sd"> >>> series.build(example_scenario_list)</span>
<span class="sd"> In this example that follows from :class:`ScenarioSeries` example the</span>
<span class="sd"> file structure that is created by the ``build`` method is as follows::</span>
<span class="sd"> dir_to_run_series</span>
<span class="sd"> ├── 670d6352-2852-400a-997e-7b12ba34f0b0</span>
<span class="sd"> │ ├── control</span>
<span class="sd"> │ ├── data</span>
<span class="sd"> │ └── parameters</span>
<span class="sd"> ├── base_inputs</span>
<span class="sd"> │ ├── control</span>
<span class="sd"> │ ├── data</span>
<span class="sd"> │ └── parameters</span>
<span class="sd"> ├── ee9526a9-8fe6-4e88-b357-7dfd7111208a</span>
<span class="sd"> │ ├── control</span>
<span class="sd"> │ ├── data</span>
<span class="sd"> │ └── parameters</span>
<span class="sd"> └── series_metadata.json</span>
<span class="sd"> As shown the build method has copied the original inputs from the </span>
<span class="sd"> ``base_dir`` given on initialization of ``ScenarioSeries`` to a new</span>
<span class="sd"> subdirectory of the ``scenarios_dir``, it also applied the </span>
<span class="sd"> modifications to the parameters for both scenarios above and move the</span>
<span class="sd"> input files to their respective directories. At this stage the </span>
<span class="sd"> ``metadata`` will not have updated the UUID map dictionary to each</span>
<span class="sd"> scenarios subdirectory because they have not yet been run. See the </span>
<span class="sd"> :meth:`ScenarioSeries.run` method for further explanation including</span>
<span class="sd"> the final file structure and metadata file contents. </span>
<span class="sd"> """</span>
<span class="n">title</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">description</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">scenarios_list</span><span class="p">:</span>
<span class="k">if</span> <span class="s1">'title'</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span>
<span class="k">del</span> <span class="n">s</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span>
<span class="k">if</span> <span class="s1">'description'</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="n">description</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span>
<span class="k">del</span> <span class="n">s</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span>
<span class="n">uu</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">'uuid_title_map'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">uu</span><span class="p">:</span> <span class="n">title</span><span class="p">})</span>
<span class="n">scenario_path</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><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenarios_dir</span><span class="p">,</span> <span class="n">uu</span><span class="p">)</span>
<span class="c1"># create Scenario</span>
<span class="n">scenario</span> <span class="o">=</span> <span class="n">Scenario</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">base_dir</span><span class="p">,</span> <span class="n">scenario_path</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span>
<span class="p">)</span>
<span class="c1"># s now only contains parameter keys and function references vals</span>
<span class="n">scenario</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scenarios</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">scenario</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenarios_dir</span><span class="p">,</span> <span class="s1">'series_metadata.json'</span><span class="p">),</span> <span class="s1">'w'</span>
<span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span></div>
<div class="viewcode-block" id="ScenarioSeries.run"><a class="viewcode-back" href="../../api.html#prms_python.ScenarioSeries.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prms_exec</span><span class="o">=</span><span class="s1">'prms'</span><span class="p">,</span> <span class="n">nproc</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Run a "built" ``ScenarioSeries`` and make final updates</span>
<span class="sd"> to file structure and metadata. </span>
<span class="sd"> Keyword Arguments:</span>
<span class="sd"> prms_exec (str): name of PRMS executable on $PATH or path to</span>
<span class="sd"> executable. Default = 'prms'</span>
<span class="sd"> nproc (int or None): number of processceors available to </span>
<span class="sd"> parallelize PRMS simulations, if None (default) then use</span>
<span class="sd"> half of what the :mod:`multiprocessing` detects on the</span>
<span class="sd"> machine.</span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> Examples:</span>
<span class="sd"> This example starts where the example ends in </span>
<span class="sd"> :meth:`ScenarioSeries.build`, calling ``run`` will run the</span>
<span class="sd"> models for all scenarios and then update the file structure </span>
<span class="sd"> as well as create individual ``Scenario`` metadata files as such::</span>
<span class="sd"> dir_to_run_series</span>
<span class="sd"> ├── 5498c21d-d064-45f4-9912-044734fd230e</span>
<span class="sd"> │ ├── inputs</span>
<span class="sd"> │ │ ├── control</span>
<span class="sd"> │ │ ├── data</span>
<span class="sd"> │ │ └── parameters</span>
<span class="sd"> │ ├── metadata.json</span>
<span class="sd"> │ └── outputs</span>
<span class="sd"> │ ├── prms_ic.out</span>
<span class="sd"> │ ├── prms.out</span>
<span class="sd"> │ └── statvar.dat</span>
<span class="sd"> ├── 9d28ec5a-b570-4abb-8000-8dac113cbed3</span>
<span class="sd"> │ ├── inputs</span>
<span class="sd"> │ │ ├── control</span>
<span class="sd"> │ │ ├── data</span>
<span class="sd"> │ │ └── parameters</span>
<span class="sd"> │ ├── metadata.json</span>
<span class="sd"> │ └── outputs</span>
<span class="sd"> │ ├── prms_ic.out</span>
<span class="sd"> │ ├── prms.out</span>
<span class="sd"> │ └── statvar.dat</span>
<span class="sd"> ├── base_inputs</span>
<span class="sd"> │ ├── control</span>
<span class="sd"> │ ├── data</span>
<span class="sd"> │ └── parameters</span>
<span class="sd"> └── series_metadata.json</span>
<span class="sd"> As we can see the file structure follows the combined structures </span>
<span class="sd"> as defined by :class:`Simulation` and :class:`Scenario`. The content</span>
<span class="sd"> of the top-level metadata file ``series_metadata.json`` is as such::</span>
<span class="sd"> {</span>
<span class="sd"> "title": "title_for_group_of_scenarios",</span>
<span class="sd"> "description": "description_for_scenarios",</span>
<span class="sd"> "uuid_title_map": {</span>
<span class="sd"> "5498c21d-d064-45f4-9912-044734fd230e": "scenario1",</span>
<span class="sd"> "9d28ec5a-b570-4abb-8000-8dac113cbed3": "scenario2"</span>
<span class="sd"> }</span>
<span class="sd"> }</span>
<span class="sd"> </span>
<span class="sd"> Therefore one can use the :mod:`json` file to track between UUID's and </span>
<span class="sd"> individual scenario titles. The json files are read as a Python</span>
<span class="sd"> dictionary which makes them particularly convenient. The contents of</span>
<span class="sd"> an individual scenarios ``metadata.json`` file included a string</span>
<span class="sd"> representation of the function(s) that were applied to the </span>
<span class="sd"> paramter(s)::</span>
<span class="sd"> {</span>
<span class="sd"> "description": null,</span>
<span class="sd"> "end_datetime": "2018-09-03T00:00:40.793817",</span>
<span class="sd"> "mod_funs_dict": {</span>
<span class="sd"> "snowinfil_max": "def _function1(x):</span>
<span class="sd"> return x * 0.5"</span>
<span class="sd"> },</span>
<span class="sd"> "start_datetime": "2018-09-03T00:00:30.421353",</span>
<span class="sd"> "title": "scenario1"</span>
<span class="sd"> }</span>
<span class="sd"> Note:</span>
<span class="sd"> As shown, it is important to give appropriate scenario titles when</span>
<span class="sd"> building a ``ScenarioSeries`` dictionary in order to later </span>
<span class="sd"> understand how parameters were modified in each scenario. If not</span>
<span class="sd"> one would have to rely on the individual ``metadata.json`` files</span>
<span class="sd"> in each scenario directory which may be more cumbersome.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">nproc</span><span class="p">:</span>
<span class="n">nproc</span> <span class="o">=</span> <span class="n">mp</span><span class="o">.</span><span class="n">cpu_count</span><span class="p">()</span><span class="o">//</span><span class="mi">2</span>
<span class="n">pool</span> <span class="o">=</span> <span class="n">mp</span><span class="o">.</span><span class="n">Pool</span><span class="p">(</span><span class="n">processes</span><span class="o">=</span><span class="n">nproc</span><span class="p">)</span>
<span class="n">pool</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="n">_scenario_runner</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">scenarios</span><span class="p">)</span></div></div>
<span class="c1"># multiprocessing req the function be def'd at root scope so it's picklable</span>
<span class="k">def</span> <span class="nf">_scenario_runner</span><span class="p">(</span><span class="n">scenario</span><span class="p">,</span> <span class="n">prms_exec</span><span class="o">=</span><span class="s1">'prms'</span><span class="p">):</span>
<span class="n">scenario</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">prms_exec</span><span class="o">=</span><span class="n">prms_exec</span><span class="p">)</span>
<div class="viewcode-block" id="Scenario"><a class="viewcode-back" href="../../api.html#prms_python.Scenario">[docs]</a><span class="k">class</span> <span class="nc">Scenario</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Container for the process in which one modifies input parameters then</span>
<span class="sd"> runs a simulation while tracking metadata. </span>
<span class="sd"> </span>
<span class="sd"> Metadata includes a title and description, if provided, plus start/end </span>
<span class="sd"> datetime, and parameter names of parameters that were modified including </span>
<span class="sd"> string representations of the Python modification functions that were </span>
<span class="sd"> applied to each parameter. The metadata file is in :mod:`json` format</span>
<span class="sd"> making it conveniently read as a Python dictionary.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> base_dir (str): path to directory that contains initial *control*, </span>
<span class="sd"> *parameter*, and *data* files to be used for ``Scenario``. </span>
<span class="sd"> The *parameters* file in ``base_dir`` will not be modifed </span>
<span class="sd"> instead will be copied to ``scenario_dir`` and them modified.</span>
<span class="sd"> scenario_dir (str): directory path to bundle inputs and outputs</span>
<span class="sd"> title (str, optional): title of ``Scenario``, if given will be </span>
<span class="sd"> added to ``Scenario.metadata`` attribute as well as the </span>
<span class="sd"> ``metadata.json`` file in ``scenario_dir`` written after </span>
<span class="sd"> calling the :func:`Scenario.build()` and :func:`Scenario.run()` </span>
<span class="sd"> methods.</span>
<span class="sd"> description (str, optional): description of ``Scenario``, also</span>
<span class="sd"> is added to ``Scenario.metadata`` as ``title``.</span>
<span class="sd"> Attributes:</span>
<span class="sd"> metadata (:class:`scenario.ScenarioMetadata`): a dictionary-like </span>
<span class="sd"> class in :mod:`prms_python.scenario` that tracks ``Scenario`` and </span>
<span class="sd"> ``ScenarioSeries`` imformation including user-defined parameter </span>
<span class="sd"> modifications and descriptions, and file structure. </span>
<span class="sd"> Examples:</span>
<span class="sd"> This example is kept simple for clarity, here we adjust a </span>
<span class="sd"> single PRMS parameter *tmin_lapse* by using a single arbitrary</span>
<span class="sd"> mathematical function. We use the example PRMS model included</span>
<span class="sd"> with PRMS-Python for this example,</span>
<span class="sd"> >>> input_dir = 'PRMS-Python/test/data/models/lbcd'</span>
<span class="sd"> >>> scenario_directory = 'scenario_testing'</span>
<span class="sd"> >>> title = 'Scenario example'</span>
<span class="sd"> >>> desc = 'adjust tmin_lapse using sine wave function'</span>
<span class="sd"> >>> # create Scenario instance</span>
<span class="sd"> >>> scenario_obj = Scenario</span>
<span class="sd"> ( </span>
<span class="sd"> base_dir=input_dir, </span>
<span class="sd"> scenario_dir=scenario_directory, </span>
<span class="sd"> title=title, </span>
<span class="sd"> description=desc</span>
<span class="sd"> )</span>
<span class="sd"> </span>
<span class="sd"> Next we need to build a dictionary to modify, in this case</span>
<span class="sd"> *tmin_lapse*, here we use a vectorized sine function </span>
<span class="sd"> >>> # build the modification function and dictionary</span>
<span class="sd"> >>> def a_func(arr):</span>
<span class="sd"> return 4 + np.sin(np.linspace(0,2*np.pi,num=len(arr)))</span>
<span class="sd"> >>> # make dictionary with parameter names as keys and modification</span>
<span class="sd"> >>> # function as values</span>
<span class="sd"> >>> param_mod_dic = dict(tmin_lapse=a_func) </span>
<span class="sd"> >>> scenario_obj.build(param_mod_funs=param_mod_dic)</span>
<span class="sd"> After building a ``Scenario`` instance the input files are </span>
<span class="sd"> copied to ``scenario_dir`` which was assigned 'scenario_testing'::</span>
<span class="sd"> scenario_testing</span>
<span class="sd"> ├── control</span>
<span class="sd"> ├── data</span>
<span class="sd"> └── parameters</span>
<span class="sd"> </span>
<span class="sd"> </span>
<span class="sd"> After calling ``build`` the input files from ``input_dir`` were </span>
<span class="sd"> first copied to ``scenario_dir`` and then the functions in </span>
<span class="sd"> ``param_mod_dic`` are applied the the parameters names (key)</span>
<span class="sd"> in ``param_mod_dic``. To run the ``Scenario`` use the the ``run``</span>
<span class="sd"> method</span>
<span class="sd"> </span>
<span class="sd"> >>> scenario_obj.run()</span>
<span class="sd"> Now the simulation is run and the ``metadata.json`` file is created,</span>
<span class="sd"> the final file structure will be similar to this::</span>
<span class="sd"> scenario_testing </span>
<span class="sd"> ├── inputs</span>
<span class="sd"> │ ├── control</span>
<span class="sd"> │ ├── data</span>
<span class="sd"> │ └── parameters</span>
<span class="sd"> ├── metadata.json</span>
<span class="sd"> └── outputs</span>
<span class="sd"> ├── prms_ic.out</span>
<span class="sd"> ├── prms.out</span>
<span class="sd"> └── statvar.dat</span>
<span class="sd"> </span>
<span class="sd"> Finally, here is what is contained in ``metadata.json`` for this example </span>
<span class="sd"> which is also updates in the :attr:`Scenario.metadata`</span>
<span class="sd"> >>> scenario_obj.metadata</span>
<span class="sd"> {</span>
<span class="sd"> 'title': 'Scenario example', </span>
<span class="sd"> 'description': 'adjust tmin_lapse using sine wave function', </span>
<span class="sd"> 'start_datetime': '2018-09-01T19:20:21.723003', </span>
<span class="sd"> 'end_datetime': '2018-09-01T19:20:31.117004', </span>
<span class="sd"> 'mod_funs_dict': {</span>
<span class="sd"> 'tmin_lapse': 'def parab(arr):</span>
<span class="sd"> return 4 + np.sin(np.linspace(0,2*np.pi,num=len(arr)))' </span>
<span class="sd"> }</span>
<span class="sd"> }</span>
<span class="sd"> As shown the metadata retirieved the parameter modification function</span>
<span class="sd"> as a string representation of the exact Python function(s) used for </span>
<span class="sd"> modifying the user-defined parameter(s). </span>
<span class="sd"> Note:</span>
<span class="sd"> The main differentiator between :class:`Scenario` and </span>
<span class="sd"> :class:`ScenarioSeries` is that ``Scenario`` is designed for modifying</span>
<span class="sd"> one or more parameters of a **single** *parameters* file whereas</span>
<span class="sd"> ``ScenarioSeries`` is designed for modifying and tracking the </span>
<span class="sd"> modification of one or more parameters in **multiple** PRMS </span>
<span class="sd"> *parameters* files, therefore resulting in multiple PRMS simulations. </span>
<span class="sd"> </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_dir</span><span class="p">,</span> <span class="n">scenario_dir</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">description</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="n">title</span>
<span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="n">description</span>
<span class="bp">self</span><span class="o">.</span><span class="n">base_dir</span> <span class="o">=</span> <span class="n">base_dir</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span> <span class="o">=</span> <span class="n">scenario_dir</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">ScenarioMetadata</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__simulation_ready</span> <span class="o">=</span> <span class="kc">False</span>
<div class="viewcode-block" id="Scenario.build"><a class="viewcode-back" href="../../api.html#prms_python.Scenario.build">[docs]</a> <span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">param_mod_funs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Take a user-defined dictionary with param names as keys and Python</span>
<span class="sd"> functions as values, copy the original input files as given when</span>
<span class="sd"> initializing a :class:`Scenario` instance to the ``simulation_dir``</span>
<span class="sd"> then apply the functions in the user-defined dictionary to the </span>
<span class="sd"> parameters there. The ``build`` method must be called before running </span>
<span class="sd"> the ``Scenario`` (calling :func:`Scenario.run()` ). </span>
<span class="sd"> Keyword Arguments:</span>
<span class="sd"> param_mod_funs (dict): dictionary with parameter names as keys</span>
<span class="sd"> and Python functions as values to apply to the names (key)</span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> Example:</span>
<span class="sd"> see :class:`Scenario` for a full example.</span>
<span class="sd"> Note:</span>
<span class="sd"> If the ``scenario_dir`` that was assigned for the current </span>
<span class="sd"> instance already exists, it will be overwritten when ``build``</span>
<span class="sd"> is invoked. </span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param_mod_funs</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="c1"># create scenario_dir that will be used as Simulation input dir</span>
<span class="k">if</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="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">):</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">)</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_dir</span><span class="p">,</span> <span class="s1">'control'</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span>
<span class="p">)</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_dir</span><span class="p">,</span> <span class="s1">'data'</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span>
<span class="p">)</span>
<span class="n">old_params_path</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><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">base_dir</span><span class="p">,</span> <span class="s1">'parameters'</span><span class="p">)</span>
<span class="n">new_params_path</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><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">,</span> <span class="s1">'parameters'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">param_mod_funs</span><span class="p">:</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">old_params_path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">modify_params</span><span class="p">(</span><span class="n">old_params_path</span><span class="p">,</span> <span class="n">new_params_path</span><span class="p">,</span> <span class="n">param_mod_funs</span><span class="p">)</span>
<span class="n">param_mod_funs_metadata</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">param_name</span><span class="p">:</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getsource</span><span class="p">(</span><span class="n">param_mod_fun</span><span class="p">)</span>
<span class="k">for</span> <span class="n">param_name</span><span class="p">,</span> <span class="n">param_mod_fun</span> <span class="ow">in</span> <span class="n">param_mod_funs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="p">}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">'mod_funs_dict'</span><span class="p">]</span> <span class="o">=</span> <span class="n">param_mod_funs_metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">simulation</span> <span class="o">=</span> <span class="n">Simulation</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">simulation</span> <span class="o">=</span> <span class="n">Simulation</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__simulation_ready</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Scenario.run"><a class="viewcode-back" href="../../api.html#prms_python.Scenario.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prms_exec</span><span class="o">=</span><span class="s1">'prms'</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Run the PRMS simulation for a *built* ``Scenario`` instance.</span>
<span class="sd"> Keyword Arguments: </span>
<span class="sd"> prms_exec (str): name of PRMS executable on $PATH or path to </span>
<span class="sd"> executable</span>
<span class="sd"> </span>
<span class="sd"> Returns:</span>
<span class="sd"> None</span>
<span class="sd"> Examples:</span>
<span class="sd"> see :class:`Scenario` for full example</span>
<span class="sd"> Raises:</span>
<span class="sd"> RuntimeError: if the :func:`Scenario.build` method has not yet</span>
<span class="sd"> been called.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">__simulation_ready</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
<span class="s1">'Scenario has not yet been prepared: run build_scenario first'</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">'start_datetime'</span><span class="p">]</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="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">prms_exec</span><span class="o">=</span><span class="n">prms_exec</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">'end_datetime'</span><span class="p">]</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="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">scenario_dir</span><span class="p">,</span> <span class="s1">'metadata.json'</span><span class="p">))</span></div></div>
<span class="k">class</span> <span class="nc">ScenarioMetadata</span><span class="p">:</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">title</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">start_datetime</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">end_datetime</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">mod_funs_dict</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">start_datetime</span><span class="o">=</span><span class="n">start_datetime</span><span class="p">,</span>
<span class="n">end_datetime</span><span class="o">=</span><span class="n">end_datetime</span><span class="p">,</span>
<span class="n">mod_funs_dict</span><span class="o">=</span><span class="n">mod_funs_dict</span><span class="p">)</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="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</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="bp">self</span><span class="o">.</span><span class="n">metadata_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata_dict</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">()</span>
<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">output_path</span><span class="p">):</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">output_path</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">metadata_dict</span><span class="p">,</span> <span class="n">ensure_ascii</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>\
<span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
</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>