Skip to content

Commit

Permalink
Merge pull request #100 from jmills-ncar/master
Browse files Browse the repository at this point in the history
updated docs
  • Loading branch information
T. Joe Mills authored Jul 25, 2018
2 parents c1c4ff9 + 2d949cd commit a4860de
Show file tree
Hide file tree
Showing 16 changed files with 385 additions and 156 deletions.
Binary file modified doc/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified doc/_build/doctrees/source/wrfhydropy.core.doctree
Binary file not shown.
Binary file modified doc/_build/doctrees/source/wrfhydropy.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions doc/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ <h1>All modules for which code is available</h1>
<li><a href="wrfhydropy/core/job.html">wrfhydropy.core.job</a></li>
<li><a href="wrfhydropy/core/job_tools.html">wrfhydropy.core.job_tools</a></li>
<li><a href="wrfhydropy/core/model.html">wrfhydropy.core.model</a></li>
<li><a href="wrfhydropy/core/namelist.html">wrfhydropy.core.namelist</a></li>
<li><a href="wrfhydropy/core/outputdiffs.html">wrfhydropy.core.outputdiffs</a></li>
<li><a href="wrfhydropy/core/schedulers.html">wrfhydropy.core.schedulers</a></li>
<li><a href="wrfhydropy/core/simulation.html">wrfhydropy.core.simulation</a></li>
Expand Down
256 changes: 160 additions & 96 deletions doc/_build/html/_modules/wrfhydropy/core/job.html

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions doc/_build/html/_sources/source/wrfhydropy.core.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ wrfhydropy.core.model module
:undoc-members:
:show-inheritance:

wrfhydropy.core.namelist module
-------------------------------

.. automodule:: wrfhydropy.core.namelist
:members:
:undoc-members:
:show-inheritance:

wrfhydropy.core.outputdiffs module
----------------------------------

Expand Down
1 change: 1 addition & 0 deletions doc/_build/html/_sources/source/wrfhydropy.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Subpackages
.. toctree::

wrfhydropy.core
wrfhydropy.tests

Module contents
---------------
Expand Down
60 changes: 48 additions & 12 deletions doc/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,14 +257,16 @@ <h2 id="C">C</h2>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.namelist.dict_merge">dict_merge() (in module wrfhydropy.core.namelist)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.outputdiffs.OutputDiffs.diff_counts">diff_counts (wrfhydropy.core.outputdiffs.OutputDiffs attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.outputdiffs.diff_namelist">diff_namelist() (in module wrfhydropy.core.outputdiffs)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain">Domain (class in wrfhydropy.core.domain)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain">Domain (class in wrfhydropy.core.domain)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.simulation.Simulation.domain">domain (wrfhydropy.core.simulation.Simulation attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.domain_config">domain_config (wrfhydropy.core.domain.Domain attribute)</a>
Expand All @@ -285,6 +287,8 @@ <h2 id="E">E</h2>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.namelist.JSONNamelist.get_config">get_config() (wrfhydropy.core.namelist.JSONNamelist method)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.get_git_revision_hash">get_git_revision_hash() (in module wrfhydropy.core.model)</a>
</li>
</ul></td>
Expand All @@ -301,13 +305,21 @@ <h2 id="G">G</h2>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.job.Job.hrldas_namelist">hrldas_namelist (wrfhydropy.core.job.Job attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.hrldas_namelist_patches">hrldas_namelist_patches (wrfhydropy.core.domain.Domain attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model.hrldas_namelists">hrldas_namelists (wrfhydropy.core.model.Model attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.job.Job.hrldas_times">hrldas_times (wrfhydropy.core.job.Job attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.hydro_files">hydro_files (wrfhydropy.core.domain.Domain attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.job.Job.hydro_namelist">hydro_namelist (wrfhydropy.core.job.Job attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.hydro_namelist_patches">hydro_namelist_patches (wrfhydropy.core.domain.Domain attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model.hydro_namelists">hydro_namelists (wrfhydropy.core.model.Model attribute)</a>
</li>
Expand All @@ -328,6 +340,8 @@ <h2 id="J">J</h2>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.job.Job.job_id">job_id (wrfhydropy.core.job.Job attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.simulation.Simulation.jobs">jobs (wrfhydropy.core.simulation.Simulation attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.namelist.JSONNamelist">JSONNamelist (class in wrfhydropy.core.namelist)</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -351,34 +365,32 @@ <h2 id="L">L</h2>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.tests.html#wrfhydropy.tests.test_WrfHydroClasses_public.mk_job_list">mk_job_list() (in module wrfhydropy.tests.test_WrfHydroClasses_public)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model">Model (class in wrfhydropy.core.model)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.simulation.Simulation.model">model (wrfhydropy.core.simulation.Simulation attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model.model_config">model_config (wrfhydropy.core.model.Model attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model.model_config">model_config (wrfhydropy.core.model.Model attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.job.Job.model_end_time">model_end_time (wrfhydropy.core.job.Job attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.job.Job.model_start_time">model_start_time (wrfhydropy.core.job.Job attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.model_version">model_version (wrfhydropy.core.domain.Domain attribute)</a>
</li>
</ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.namelist_patch_file">namelist_patch_file (wrfhydropy.core.domain.Domain attribute)</a>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.namelist.Namelist">Namelist (class in wrfhydropy.core.namelist)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.namelist_patches">namelist_patches (wrfhydropy.core.domain.Domain attribute)</a>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.schedulers.PBSCheyenne.nnodes">nnodes (wrfhydropy.core.schedulers.PBSCheyenne attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.schedulers.PBSCheyenne.nnodes">nnodes (wrfhydropy.core.schedulers.PBSCheyenne attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.schedulers.PBSCheyenne.nproc">nproc (wrfhydropy.core.schedulers.PBSCheyenne attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.domain.Domain.nudging_files">nudging_files (wrfhydropy.core.domain.Domain attribute)</a>
Expand Down Expand Up @@ -411,10 +423,14 @@ <h2 id="O">O</h2>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.namelist.Namelist.patch">patch() (wrfhydropy.core.namelist.Namelist method)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.schedulers.PBSCheyenne">PBSCheyenne (class in wrfhydropy.core.schedulers)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.simulation.Simulation.pickle">pickle() (wrfhydropy.core.simulation.Simulation method)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.schedulers.PBSCheyenne.ppn">ppn (wrfhydropy.core.schedulers.PBSCheyenne attribute)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model.pre_compile_cmd">pre_compile_cmd (wrfhydropy.core.model.Model attribute)</a>
Expand Down Expand Up @@ -478,6 +494,18 @@ <h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.model.Model.table_files">table_files (wrfhydropy.core.model.Model attribute)</a>
</li>
<li><a href="source/wrfhydropy.tests.html#wrfhydropy.tests.test_WrfHydroClasses_public.test_domain_nwm">test_domain_nwm() (in module wrfhydropy.tests.test_WrfHydroClasses_public)</a>
</li>
<li><a href="source/wrfhydropy.tests.html#wrfhydropy.tests.test_WrfHydroClasses_public.test_model_nwm">test_model_nwm() (in module wrfhydropy.tests.test_WrfHydroClasses_public)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.tests.html#wrfhydropy.tests.test_WrfHydroClasses_public.test_run_nwm">test_run_nwm() (in module wrfhydropy.tests.test_WrfHydroClasses_public)</a>
</li>
<li><a href="source/wrfhydropy.tests.html#wrfhydropy.tests.test_WrfHydroClasses_public.test_setup_nwm">test_setup_nwm() (in module wrfhydropy.tests.test_WrfHydroClasses_public)</a>
</li>
<li><a href="source/wrfhydropy.tests.html#wrfhydropy.tests.test_WrfHydroClasses_public.tmp_data_dir">tmp_data_dir() (in module wrfhydropy.tests.test_WrfHydroClasses_public)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -505,19 +533,27 @@ <h2 id="W">W</h2>
</li>
<li><a href="source/wrfhydropy.core.html#module-wrfhydropy.core.job">wrfhydropy.core.job (module)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#module-wrfhydropy.core.model">wrfhydropy.core.model (module)</a>
</li>
<li><a href="source/wrfhydropy.core.html#module-wrfhydropy.core.namelist">wrfhydropy.core.namelist (module)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/wrfhydropy.core.html#module-wrfhydropy.core.outputdiffs">wrfhydropy.core.outputdiffs (module)</a>
</li>
<li><a href="source/wrfhydropy.core.html#module-wrfhydropy.core.schedulers">wrfhydropy.core.schedulers (module)</a>
</li>
<li><a href="source/wrfhydropy.core.html#module-wrfhydropy.core.simulation">wrfhydropy.core.simulation (module)</a>
</li>
<li><a href="source/wrfhydropy.tests.html#module-wrfhydropy.tests">wrfhydropy.tests (module)</a>
</li>
<li><a href="source/wrfhydropy.tests.html#module-wrfhydropy.tests.test_WrfHydroClasses_public">wrfhydropy.tests.test_WrfHydroClasses_public (module)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.ioutils.WrfHydroStatic">WrfHydroStatic (class in wrfhydropy.core.ioutils)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.ioutils.WrfHydroTs">WrfHydroTs (class in wrfhydropy.core.ioutils)</a>
</li>
<li><a href="source/wrfhydropy.core.html#wrfhydropy.core.namelist.Namelist.write">write() (wrfhydropy.core.namelist.Namelist method)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Binary file modified doc/_build/html/objects.inv
Binary file not shown.
15 changes: 15 additions & 0 deletions doc/_build/html/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,11 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="source/wrfhydropy.core.html#module-wrfhydropy.core.model"><code class="xref">wrfhydropy.core.model</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="source/wrfhydropy.core.html#module-wrfhydropy.core.namelist"><code class="xref">wrfhydropy.core.namelist</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
Expand All @@ -205,6 +210,16 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="source/wrfhydropy.core.html#module-wrfhydropy.core.simulation"><code class="xref">wrfhydropy.core.simulation</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="source/wrfhydropy.tests.html#module-wrfhydropy.tests"><code class="xref">wrfhydropy.tests</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="source/wrfhydropy.tests.html#module-wrfhydropy.tests.test_WrfHydroClasses_public"><code class="xref">wrfhydropy.tests.test_WrfHydroClasses_public</code></a></td><td>
<em></em></td></tr>
</table>


Expand Down
Loading

0 comments on commit a4860de

Please sign in to comment.