GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — update docs index and ref. api · PRMS-Python/PRMS-Python@5498d4c

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

docs
- build
  - doctrees
  - html
    - _modules
      - index.html
      - prms_python
        data.html
        optimizer.html
        parameters.html
        scenario.html
        util.html
    - _sources
    - _static
      - alabaster.css
    - api.html
    - cli.html
    - genindex.html
    - index.html
    - objects.inv
    - search.html
    - searchindex.js
    - tutorial.html
- source
prms_python

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎docs/build/doctrees/api.doctree‎`

Copy file name to clipboard

52 KB

Binary file not shown.

Collapse file

`‎docs/build/doctrees/cli.doctree‎`

Copy file name to clipboard

295 Bytes

Binary file not shown.

Collapse file

`‎docs/build/doctrees/environment.pickle‎`

Copy file name to clipboard

3.83 KB

Binary file not shown.

Collapse file

`‎docs/build/doctrees/index.doctree‎`

Copy file name to clipboard

2.19 KB

Binary file not shown.

Collapse file

`‎docs/build/doctrees/tutorial.doctree‎`

Copy file name to clipboard

-149 Bytes

Binary file not shown.

Collapse file

`‎docs/build/html/_modules/index.html‎`

Copy file name to clipboardExpand all lines: docs/build/html/_modules/index.html

+5-2Lines changed: 5 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`<div class="document">`
`26`	`26`	`<div class="documentwrapper">`
`27`	`27`	`<div class="bodywrapper">`
	`28`	`+`
	`29`	`+`
`28`	`30`	`<div class="body" role="main">`
`29`	`31`
`30`	`32`	`<h1>All modules for which code is available</h1>`
`@@ -36,6 +38,7 @@ <h1>All modules for which code is available</h1>`
`36`	`38`	`</ul>`
`37`	`39`
`38`	`40`	`</div>`
	`41`	`+`
`39`	`42`	`</div>`
`40`	`43`	`</div>`
`41`	`44`	`<div class="sphinxsidebar" role="navigation" aria-label="main navigation">`
`@@ -97,8 +100,8 @@ <h3>Quick search</h3>`
`97`	`100`	`©2016, John Volk and Matthew Turner.`
`98`	`101`
`99`	`102`	`\|`
`100`		`- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>`
`101`		`- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>`
	`103`	`+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>`
	`104`	`+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>`
`102`	`105`
`103`	`106`	`</div>`
`104`	`107`

Collapse file

`‎docs/build/html/_modules/prms_python/data.html‎`

Copy file name to clipboardExpand all lines: docs/build/html/_modules/prms_python/data.html

+74-36Lines changed: 74 additions & 36 deletions

Large diffs are not rendered by default.

Collapse file

`‎docs/build/html/_modules/prms_python/optimizer.html‎`

Copy file name to clipboardExpand all lines: docs/build/html/_modules/prms_python/optimizer.html

+11-8Lines changed: 11 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`<div class="document">`
`26`	`26`	`<div class="documentwrapper">`
`27`	`27`	`<div class="bodywrapper">`
	`28`	`+`
	`29`	`+`
`28`	`30`	`<div class="body" role="main">`
`29`	`31`
`30`	`32`	`<h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>`
`@@ -126,7 +128,7 @@ <h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>`
`126`	`128`	`<span class="bp">self</span><span class="o">.</span><span class="n">statvar_name</span> <span class="o">=</span> <span class="kc">None</span>`
`127`	`129`	`<span class="bp">self</span><span class="o">.</span><span class="n">arb_outputs</span> <span class="o">=</span> <span class="p">[]</span>`
`128`	`130`
`129`		`- <span class="k">def</span> <span class="nf">monte_carlo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reference_path</span><span class="p">,</span> <span class="n">param_names</span><span class="p">,</span> <span class="n">statvar_name</span><span class="p">,</span> \`
	`131`	`+<div class="viewcode-block" id="Optimizer.monte_carlo"><a class="viewcode-back" href="../../api.html#prms_python.Optimizer.monte_carlo">[docs]</a> <span class="k">def</span> <span class="nf">monte_carlo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reference_path</span><span class="p">,</span> <span class="n">param_names</span><span class="p">,</span> <span class="n">statvar_name</span><span class="p">,</span> \`
`130`	`132`	`<span class="n">stage</span><span class="p">,</span> <span class="n">n_sims</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">'uniform'</span><span class="p">,</span> <span class="n">mu_factor</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>\`
`131`	`133`	`<span class="n">noise_factor</span><span class="o">=</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">nproc</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>`
`132`	`134`	`<span class="sd">'''</span>`
`@@ -225,9 +227,9 @@ <h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>`
`225`	`227`	`<span class="n">ensure_ascii</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>`
`226`	`228`
`227`	`229`	`<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="si">{0}</span><span class="se">\n</span><span class="s1">Output information sent to </span><span class="si">{1}</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span>\`
`228`		`- <span class="nb">format</span><span class="p">(</span><span class="s1">'-'</span> <span class="o">*</span> <span class="mi">80</span><span class="p">,</span> <span class="n">json_outfile</span><span class="p">))</span>`
	`230`	`+ <span class="nb">format</span><span class="p">(</span><span class="s1">'-'</span> <span class="o">*</span> <span class="mi">80</span><span class="p">,</span> <span class="n">json_outfile</span><span class="p">))</span></div>`
`229`	`231`
`230`		`- <span class="k">def</span> <span class="nf">plot_optimization</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">freq</span><span class="o">=</span><span class="s1">'daily'</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">'time_series'</span><span class="p">,</span>\`
	`232`	+<div class="viewcode-block" id="Optimizer.plot_optimization"><a class="viewcode-back" href="../../api.html#prms_python.Optimizer.plot_optimization">[docs]</a> <span class="k">def</span> <span class="nf">plot_optimization</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">freq</span><span class="o">=</span><span class="s1">'daily'</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">'time_series'</span><span class="p">,</span>\
`231`	`233`	`<span class="n">plot_vars</span><span class="o">=</span><span class="s1">'both'</span><span class="p">,</span> <span class="n">plot_1to1</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">return_fig</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>\`
`232`	`234`	`<span class="n">n_plots</span><span class="o">=</span><span class="mi">4</span><span class="p">):</span>`
`233`	`235`	`<span class="sd">"""</span>`
`@@ -364,7 +366,7 @@ <h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>`
`364`	`366`	`<span class="n">fig</span><span class="o">.</span><span class="n">delaxes</span><span class="p">(</span><span class="n">axs</span><span class="p">[</span><span class="n">n</span><span class="p">])</span>`
`365`	`367`
`366`	`368`	`<span class="k">if</span> <span class="n">return_fig</span><span class="p">:</span>`
`367`		`- <span class="k">return</span> <span class="n">fig</span></div>`
	`369`	`+ <span class="k">return</span> <span class="n">fig</span></div></div>`
`368`	`370`
`369`	`371`	`<span class="k">def</span> <span class="nf">_create_metafile_name</span><span class="p">(</span><span class="n">out_dir</span><span class="p">,</span> <span class="n">opt_title</span><span class="p">,</span> <span class="n">stage</span><span class="p">):</span>`
`370`	`372`	`<span class="sd">"""</span>`
`@@ -789,7 +791,7 @@ <h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>`
`789`	`791`
`790`	`792`	`<span class="k">return</span> <span class="n">ret</span>`
`791`	`793`
`792`		`- <span class="k">def</span> <span class="nf">archive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remove_sims</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">remove_meta</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">metric_freq</span><span class="o">=</span><span class="s1">'daily'</span><span class="p">):</span>`
	`794`	+<div class="viewcode-block" id="OptimizationResult.archive"><a class="viewcode-back" href="../../api.html#prms_python.OptimizationResult.archive">[docs]</a> <span class="k">def</span> <span class="nf">archive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remove_sims</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">remove_meta</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">metric_freq</span><span class="o">=</span><span class="s1">'daily'</span><span class="p">):</span>
`793`	`795`	`<span class="sd">"""</span>`
`794`	`796`	`<span class="sd"> Create archive directory to hold json files that contain </span>`
`795`	`797`	`<span class="sd"> information of adjusted parameters, model output, and performance </span>`
`@@ -895,12 +897,13 @@ <h1>Source code for prms_python.optimizer</h1><div class="highlight"><pre>`
`895`	`897`	`<span class="k">try</span><span class="p">:</span>`
`896`	`898`	`<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">meta_file</span><span class="p">)</span>`
`897`	`899`	`<span class="k">except</span><span class="p">:</span>`
`898`		`- <span class="k">continue</span></div>`
	`900`	`+ <span class="k">continue</span></div></div>`
`899`	`901`
`900`	`902`
`901`	`903`	`</pre></div>`
`902`	`904`
`903`	`905`	`</div>`
	`906`	`+`
`904`	`907`	`</div>`
`905`	`908`	`</div>`
`906`	`909`	`<div class="sphinxsidebar" role="navigation" aria-label="main navigation">`
`@@ -964,8 +967,8 @@ <h3>Quick search</h3>`
`964`	`967`	`©2016, John Volk and Matthew Turner.`
`965`	`968`
`966`	`969`	`\|`
`967`		`- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>`
`968`		`- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>`
	`970`	`+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>`
	`971`	`+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>`
`969`	`972`
`970`	`973`	`</div>`
`971`	`974`

Collapse file

`‎docs/build/html/_modules/prms_python/parameters.html‎`

Copy file name to clipboardExpand all lines: docs/build/html/_modules/prms_python/parameters.html

+37-18Lines changed: 37 additions & 18 deletions

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`<div class="document">`
`26`	`26`	`<div class="documentwrapper">`
`27`	`27`	`<div class="bodywrapper">`
	`28`	`+`
	`29`	`+`
`28`	`30`	`<div class="body" role="main">`
`29`	`31`
`30`	`32`	`<h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`@@ -48,9 +50,18 @@ <h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`48`	`50`
`49`	`51`	`<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>`
`50`	`52`	`<span class="sd">'''</span>`
`51`		`-<span class="sd"> Disk-based representation of a PRMS parameter file. For the sake of</span>`
	`53`	+<span class="sd"> Disk-based representation of a PRMS parameter file. The ``Parameters``</span>
	`54`	`+<span class="sd"> object has the following instance attributes:</span>`
	`55`	`+`
	`56`	+<span class="sd"> :ivar base_file: initial value: ``base_file``</span>
	`57`	+<span class="sd"> :ivar base_file_reader: initial value: ``open(base_file)``</span>
	`58`	+<span class="sd"> :ivar dimensions: initial value: ``collections.OrderedDict`` returned from ``self.__read_base(base_file)`` </span>
	`59`	+<span class="sd"> :ivar base_params: initial value: ``list()`` returned from ``self.__read_base(base_file)``</span>
	`60`	+<span class="sd"> :ivar param_arrays: initial value: empty ``dict()`` </span>
	`61`	`+`
	`62`	`+<span class="sd"> For the sake of</span>`
`52`	`63`	<span class="sd"> memory efficiency, we only load parameters from ``base_file`` that get</span>
`53`		`-<span class="sd"> modifified through item assignment, for example</span>`
	`64`	`+<span class="sd"> modified through item assignment, for example</span>`
`54`	`65`
`55`	`66`	`<span class="sd"> >>> p = Parameters('example_params')</span>`
`56`	`67`	`<span class="sd"> >>> p['jh_coef'] = p['jh_coef']*1.1</span>`
`@@ -59,13 +70,19 @@ <h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`59`	`70`	`<span class="sd"> will read parameter information from the params file to check that</span>`
`60`	`71`	<span class="sd"> ``jh_coef`` is present in the parameter file, read the lines corresponding</span>
`61`	`72`	<span class="sd"> to ``jh_coef`` data and assign the new value as requested. Internally,</span>
`62`		`-<span class="sd"> a reference is kept to only modified parameter data,</span>`
`63`		-<span class="sd"> so when ``p.write(modified_params_file)`` is called, mostly this will copy</span>
`64`		-<span class="sd"> from ``base_file`` to ``modified_params_file``.</span>
	`73`	`+<span class="sd"> a reference is kept to only modified parameter data, so when </span>`
	`74`	+<span class="sd"> ``p.write(modified_params_file)`` is called most copying is from ``base_file``</span>
	`75`	+<span class="sd"> to ``modified_params_file``. When parameters are accessed using the </span>
	`76`	+<span class="sd"> dictionary-like syntax, a ``np.ndarray`` representation of the parameter is </span>
	`77`	+<span class="sd"> returned. As a result ``numpy`` mathematical rules including efficient </span>
	`78`	`+<span class="sd"> vectorization of math applied to arrays can be applied to modify parameters </span>`
	`79`	+<span class="sd"> directly. The ``Parameter`` objects user methods allow for visualization of </span>
	`80`	`+<span class="sd"> most PRMS parameters, function based modification of parameters, and a write </span>`
	`81`	`+<span class="sd"> function that writes the data back to PRMS text format. </span>`
	`82`	`+`
`65`	`83`	`<span class="sd"> '''</span>`
`66`	`84`
`67`	`85`	`<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>`
`68`		`-`
`69`	`86`	`<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>`
`70`	`87`	`<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>`
`71`	`88`	`<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>`
`@@ -133,15 +150,16 @@ <h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`133`	`150`	<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>\
`134`	`151`	`<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>`
`135`	`152`	`<span class="sd">"""</span>`
`136`		`-<span class="sd"> Plot PRMS parameters as time series or 2D spatial grid depending on </span>`
`137`		`-<span class="sd"> parameter dimension. The PRMS parameter file is assumed to represent </span>`
`138`		`-<span class="sd"> a model that was set up on a uniform rectangular grid with the spatial </span>`
	`153`	`+<span class="sd"> Versatile method that plots series or 2D spatial grid depending on </span>`
	`154`	`+<span class="sd"> parameter dimension. The PRMS parameter file is assumed to hold parameters </span>`
	`155`	`+<span class="sd"> for a model that was set up on a uniform rectangular grid with the spatial </span>`
`139`	`156`	`<span class="sd"> index of HRUs starting in the upper left corner and moving left to </span>`
`140`		`-<span class="sd"> right across columns and down rows. </span>`
	`157`	`+<span class="sd"> right across columns and down rows. Default function is to print four</span>`
	`158`	`+<span class="sd"> files, each with plots of varying parameter dimensions as explained </span>`
	`159`	+<span class="sd"> under Kwargs ``which`` and more detailed explanation in the example</span>
	`160`	+<span class="sd"> `Jupyter notebook <https://github.com/PRMS-Python/PRMS-Python/blob/master/notebooks/param_examples.ipynb>`_.</span>
`141`	`161`	`<span class="sd"> </span>`
`142`	`162`	`<span class="sd"> Arguments:</span>`
`143`		`-<span class="sd"> params (prms_python.Parameters): An instance of Parameters that </span>`
`144`		`-<span class="sd"> corresponds with the PRMS parameter file to plot. </span>`
`145`	`163`	`<span class="sd"> nrows (int): The number of rows in the PRMS model grid for plotting </span>`
`146`	`164`	`<span class="sd"> spatial parameters. Function will only work for rectangular </span>`
`147`	`165`	`<span class="sd"> gridded models with HRU indices starting in the upper left cell </span>`
`@@ -152,14 +170,14 @@ <h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`152`	`170`	`<span class="sd"> the function will print 3 multipage pdfs, one for nhru </span>`
`153`	`171`	`<span class="sd"> dimensional parameters, one for nhru by monthly parameters, one </span>`
`154`	`172`	`<span class="sd"> for other parameters of length > 1, and one html file containing</span>`
`155`		`-<span class="sd"> single valued parameters</span>`
	`173`	`+<span class="sd"> single valued parameters.</span>`
	`174`	`+`
`156`	`175`	`<span class="sd"> out_dir (str): path to an output dir, default current directory</span>`
`157`	`176`	`<span class="sd"> xlabel (str): x label for plot(s)</span>`
`158`	`177`	`<span class="sd"> ylabel (str): y label for plot(s)</span>`
`159`	`178`	`<span class="sd"> cbar_label (str): label for colorbar on spatial plot(s)</span>`
`160`	`179`	`<span class="sd"> title (str): plot title</span>`
`161`		`-<span class="sd"> mpl_style (str, list): name or list of names of matplotlib style </span>`
`162`		`-<span class="sd"> sheets to use for plot(s)</span>`
	`180`	`+<span class="sd"> mpl_style (str, list): name or list of names of matplotlib style sheets to use for plot(s).</span>`
`163`	`181`	`<span class="sd"> </span>`
`164`	`182`	`<span class="sd"> Returns: </span>`
`165`	`183`	`<span class="sd"> None</span>`
`@@ -332,7 +350,7 @@ <h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`332`	`350`
`333`	`351`	`<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>`
`334`	`352`	`<span class="sd">"""</span>`
`335`		`-<span class="sd"> Extract dimensions and each dimension length. Run before</span>`
	`353`	`+<span class="sd"> Extract dimensions and each dimension length. Runs before</span>`
`336`	`354`	`<span class="sd"> __make_parameter_dict.</span>`
`337`	`355`	`<span class="sd"> """</span>`
`338`	`356`	`<span class="n">ret</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span>`
`@@ -535,6 +553,7 @@ <h1>Source code for prms_python.parameters</h1><div class="highlight"><pre>`
`535`	`553`	`</pre></div>`
`536`	`554`
`537`	`555`	`</div>`
	`556`	`+`
`538`	`557`	`</div>`
`539`	`558`	`</div>`
`540`	`559`	`<div class="sphinxsidebar" role="navigation" aria-label="main navigation">`
`@@ -598,8 +617,8 @@ <h3>Quick search</h3>`
`598`	`617`	`©2016, John Volk and Matthew Turner.`
`599`	`618`
`600`	`619`	`\|`
`601`		`- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>`
`602`		`- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>`
	`620`	`+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>`
	`621`	`+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>`
`603`	`622`
`604`	`623`	`</div>`
`605`	`624`

0 commit comments

Comments

0 (0)

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.