Skip to content

Commit 5ddce46

Browse files
ThibHllnThibHlln
committed
update docs html
1 parent c91a462 commit 5ddce46

39 files changed

+622
-47
lines changed

‎docs/_sources/api/classes/smartpy.SMART.rst.txt

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Methods
1616
:template: method.rst
1717

1818
~smartpy.SMART.simulate
19+
~smartpy.SMART.write_output_files
1920
~smartpy.SMART.get_simulation_array
2021
~smartpy.SMART.get_evaluation_array
2122

‎docs/_sources/api/methods/smartpy.SMART.write_output_files.rst.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
smartpy.SMART.write_output_files
2+
================================
3+
4+
.. currentmodule:: hydroeval
5+
.. default-role:: obj
6+
7+
.. automethod:: smartpy.SMART.write_output_files

‎docs/_sources/tutorial/montecarlo_experiment.rst.txt

+6-2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ The configuration of the sampling is done as follows:
5555
settings_filename='ExampleDaily.sttngs'
5656
)
5757
58+
.. seealso:: `smartpy.montecarlo.LHS`
59+
5860
.. note::
5961

6062
The configuration of the SMART model itself, unlike for the single
@@ -122,6 +124,8 @@ with one parameter set at a time using one process) can be done as follows:
122124
lhs.run(compression=False)
123125
124126
127+
.. seealso:: `smartpy.montecarlo.LHS.run`
128+
125129
Simulating in parallel
126130
``````````````````````
127131

@@ -170,8 +174,8 @@ the parameter sets are elicited as satisfactory:
170174
streamflow simulations on the "calibration" and the "evaluation" periods
171175
obtained from the sampling and conditioning steps, respectively.
172176

173-
More information about these three approaches can be found in the
174-
:doc:`../api_reference`.
177+
.. seealso:: `smartpy.montecarlo.GLUE`, `smartpy.montecarlo.Best`,
178+
`smartpy.montecarlo.Total`
175179

176180
The remainder of this tutorial is based on the `Best` approach.
177181

‎docs/_sources/tutorial/single_experiment.rst.txt

+9-1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ the performance of the simulation.
4646
gauged_area_m2=175.97e6
4747
)
4848
49+
.. seealso:: `smartpy.SMART`
50+
4951

5052
Giving parameter values to the model instance
5153
'''''''''''''''''''''''''''''''''''''''''''''
@@ -83,6 +85,9 @@ directly provide them as a dictionary, as follows:
8385
}
8486
)
8587
88+
.. seealso:: `smartpy.parameters.Parameters.set_parameters_with_file`,
89+
`smartpy.parameters.Parameters.set_parameters_with_dict`
90+
8691

8792
Defining the initial conditions
8893
'''''''''''''''''''''''''''''''
@@ -149,6 +154,8 @@ instance attributes.
149154
150155
sm.simulate(sm.parameters.values)
151156
157+
.. seealso:: `smartpy.SMART.simulate`
158+
152159

153160
Retrieving the outputs
154161
----------------------
@@ -176,6 +183,7 @@ be done using the following instruction:
176183
177184
sm.write_output_files(which='both')
178185
186+
.. seealso:: `smartpy.SMART.write_output_files`
179187

180188
The *which* argument can take the value 'modelled', 'observed', or 'both',
181189
to write the simulated streamflow series, the observed streamflow series,
@@ -218,7 +226,7 @@ suggested solution is as follows:
218226
219227
Now that the arrays have no missing value, but still the same length,
220228
they can be compared using any objective function. A suggested approach
221-
is to use the `hydroeval` Python package (https://thibhlln.github.io/hydroeval)
229+
is to use the `hydroeval` Python package (`<https://thibhlln.github.io/hydroeval>`_)
222230
to get access to some of the most commonly used objective functions in hydrology:
223231

224232
.. code-block:: python

‎docs/api/attributes/smartpy.SMART.parameters.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -365,7 +370,7 @@ <h1>smartpy.SMART.parameters<a class="headerlink" href="#smartpy-smart-parameter
365370
<div class="footer-item">
366371
<p class="sphinx-version">
367372
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
368-
Last updated on Feb 02, 2022.<br>
373+
Last updated on Feb 03, 2022.<br>
369374
</p>
370375
</div>
371376
</div>

‎docs/api/attributes/smartpy.parameters.Parameters.names.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -365,7 +370,7 @@ <h1>smartpy.parameters.Parameters.names<a class="headerlink" href="#smartpy-para
365370
<div class="footer-item">
366371
<p class="sphinx-version">
367372
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
368-
Last updated on Feb 02, 2022.<br>
373+
Last updated on Feb 03, 2022.<br>
369374
</p>
370375
</div>
371376
</div>

‎docs/api/attributes/smartpy.parameters.Parameters.ranges.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -365,7 +370,7 @@ <h1>smartpy.parameters.Parameters.ranges<a class="headerlink" href="#smartpy-par
365370
<div class="footer-item">
366371
<p class="sphinx-version">
367372
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
368-
Last updated on Feb 02, 2022.<br>
373+
Last updated on Feb 03, 2022.<br>
369374
</p>
370375
</div>
371376
</div>

‎docs/api/attributes/smartpy.parameters.Parameters.values.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -365,7 +370,7 @@ <h1>smartpy.parameters.Parameters.values<a class="headerlink" href="#smartpy-par
365370
<div class="footer-item">
366371
<p class="sphinx-version">
367372
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
368-
Last updated on Feb 02, 2022.<br>
373+
Last updated on Feb 03, 2022.<br>
369374
</p>
370375
</div>
371376
</div>

‎docs/api/classes/smartpy.SMART.html

+11-3
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -432,10 +437,13 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
432437
<tr class="row-odd"><td><p><a class="reference internal" href="../methods/smartpy.SMART.simulate.html#smartpy.SMART.simulate" title="smartpy.SMART.simulate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">simulate</span></code></a></p></td>
433438
<td><p>Run model simulation over period configuration at instantiation.</p></td>
434439
</tr>
435-
<tr class="row-even"><td><p><a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html#smartpy.SMART.get_simulation_array" title="smartpy.SMART.get_simulation_array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_simulation_array</span></code></a></p></td>
440+
<tr class="row-even"><td><p><a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html#smartpy.SMART.write_output_files" title="smartpy.SMART.write_output_files"><code class="xref py py-obj docutils literal notranslate"><span class="pre">write_output_files</span></code></a></p></td>
441+
<td><p>Record the discharge time series in output file(s).</p></td>
442+
</tr>
443+
<tr class="row-odd"><td><p><a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html#smartpy.SMART.get_simulation_array" title="smartpy.SMART.get_simulation_array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_simulation_array</span></code></a></p></td>
436444
<td><p>Retrieve the simulated discharge time series as an array.</p></td>
437445
</tr>
438-
<tr class="row-odd"><td><p><a class="reference internal" href="../methods/smartpy.SMART.get_evaluation_array.html#smartpy.SMART.get_evaluation_array" title="smartpy.SMART.get_evaluation_array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_evaluation_array</span></code></a></p></td>
446+
<tr class="row-even"><td><p><a class="reference internal" href="../methods/smartpy.SMART.get_evaluation_array.html#smartpy.SMART.get_evaluation_array" title="smartpy.SMART.get_evaluation_array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_evaluation_array</span></code></a></p></td>
439447
<td><p>Retrieve the observed discharge time series as an array.</p></td>
440448
</tr>
441449
</tbody>
@@ -479,7 +487,7 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
479487
<div class="footer-item">
480488
<p class="sphinx-version">
481489
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
482-
Last updated on Feb 02, 2022.<br>
490+
Last updated on Feb 03, 2022.<br>
483491
</p>
484492
</div>
485493
</div>

‎docs/api/classes/smartpy.montecarlo.Best.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -533,7 +538,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
533538
<div class="footer-item">
534539
<p class="sphinx-version">
535540
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
536-
Last updated on Feb 02, 2022.<br>
541+
Last updated on Feb 03, 2022.<br>
537542
</p>
538543
</div>
539544
</div>

‎docs/api/classes/smartpy.montecarlo.GLUE.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,11 @@
172172
smartpy.SMART.simulate
173173
</a>
174174
</li>
175+
<li class="toctree-l2">
176+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
177+
smartpy.SMART.write_output_files
178+
</a>
179+
</li>
175180
<li class="toctree-l2">
176181
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
177182
smartpy.SMART.get_simulation_array
@@ -549,7 +554,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
549554
<div class="footer-item">
550555
<p class="sphinx-version">
551556
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
552-
Last updated on Feb 02, 2022.<br>
557+
Last updated on Feb 03, 2022.<br>
553558
</p>
554559
</div>
555560
</div>

‎docs/api/classes/smartpy.montecarlo.LHS.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -462,7 +467,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
462467
<div class="footer-item">
463468
<p class="sphinx-version">
464469
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
465-
Last updated on Feb 02, 2022.<br>
470+
Last updated on Feb 03, 2022.<br>
466471
</p>
467472
</div>
468473
</div>

‎docs/api/classes/smartpy.montecarlo.Total.html

+14-6
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -348,12 +353,15 @@ <h1>Total<a class="headerlink" href="#total" title="Permalink to this headline">
348353
<dl class="py class">
349354
<dt class="sig sig-object py" id="smartpy.montecarlo.Total">
350355
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">smartpy.montecarlo.</span></span><span class="sig-name descname"><span class="pre">Total</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">catchment</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">out_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parallel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'seq'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_sim</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings_filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decompression_csv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#smartpy.montecarlo.Total" title="Permalink to this definition"><span class="fa fa-link"></a></dt>
351-
<dd><p>Total is the available to run an existing sample of parameter sets
356+
<dd><p>Total is available to run an existing sample of parameter sets
352357
on a different period, without any conditioning.</p>
353-
<p>Note that a sampling must have already been performed prior to using
354-
this functionality, and the unconditioned sample is then used to run
355-
the model on a different simulation period than the sampling simulation
356-
period.</p>
358+
<div class="admonition important">
359+
<p class="admonition-title">Important</p>
360+
<p>A sampling must have already been performed prior to using this
361+
functionality, and the unconditioned sample is then used to run
362+
the model on a different simulation period than the sampling
363+
simulation period.</p>
364+
</div>
357365
<p><strong>Instantiation</strong></p>
358366
<dl class="field-list">
359367
<dt class="field-odd">Parameters</dt>
@@ -475,7 +483,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
475483
<div class="footer-item">
476484
<p class="sphinx-version">
477485
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
478-
Last updated on Feb 02, 2022.<br>
486+
Last updated on Feb 03, 2022.<br>
479487
</p>
480488
</div>
481489
</div>

‎docs/api/classes/smartpy.parameters.Parameters.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="../methods/smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="../methods/smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -416,7 +421,7 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
416421
<div class="footer-item">
417422
<p class="sphinx-version">
418423
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
419-
Last updated on Feb 02, 2022.<br>
424+
Last updated on Feb 03, 2022.<br>
420425
</p>
421426
</div>
422427
</div>

‎docs/api/methods/smartpy.SMART.get_evaluation_array.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2">
175180
<a class="reference internal" href="smartpy.SMART.get_simulation_array.html">
176181
smartpy.SMART.get_simulation_array
@@ -371,7 +376,7 @@ <h1>smartpy.SMART.get_evaluation_array<a class="headerlink" href="#smartpy-smart
371376
<div class="footer-item">
372377
<p class="sphinx-version">
373378
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
374-
Last updated on Feb 02, 2022.<br>
379+
Last updated on Feb 03, 2022.<br>
375380
</p>
376381
</div>
377382
</div>

‎docs/api/methods/smartpy.SMART.get_simulation_array.html

+7-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<link rel="index" title="Index" href="../../genindex.html" />
4040
<link rel="search" title="Search" href="../../search.html" />
4141
<link rel="next" title="smartpy.SMART.get_evaluation_array" href="smartpy.SMART.get_evaluation_array.html" />
42-
<link rel="prev" title="smartpy.SMART.simulate" href="smartpy.SMART.simulate.html" />
42+
<link rel="prev" title="smartpy.SMART.write_output_files" href="smartpy.SMART.write_output_files.html" />
4343
<meta name="viewport" content="width=device-width, initial-scale=1" />
4444
<meta name="docsearch:language" content="en" />
4545

@@ -171,6 +171,11 @@
171171
smartpy.SMART.simulate
172172
</a>
173173
</li>
174+
<li class="toctree-l2">
175+
<a class="reference internal" href="smartpy.SMART.write_output_files.html">
176+
smartpy.SMART.write_output_files
177+
</a>
178+
</li>
174179
<li class="toctree-l2 current active">
175180
<a class="current reference internal" href="#">
176181
smartpy.SMART.get_simulation_array
@@ -370,7 +375,7 @@ <h1>smartpy.SMART.get_simulation_array<a class="headerlink" href="#smartpy-smart
370375
<div class="footer-item">
371376
<p class="sphinx-version">
372377
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 4.2.0.
373-
Last updated on Feb 02, 2022.<br>
378+
Last updated on Feb 03, 2022.<br>
374379
</p>
375380
</div>
376381
</div>

0 commit comments

Comments
 (0)