Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arbennett committed May 8, 2019
1 parent ed233e4 commit f58d96c
Show file tree
Hide file tree
Showing 9 changed files with 451 additions and 35 deletions.
62 changes: 32 additions & 30 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,35 @@ Simulation
=======
.. automodule:: pysumma.simulation
:members:

Ensemble
=======
.. automodule:: pysumma.ensemble
:members:

File Manager
=========
.. automodule:: pysumma.file_manager
:members:

Decisions
=========
.. automodule:: pysumma.decisions
:members:

Output Control
=========
.. automodule:: pysumma.output_control
:members:

Local Param Info
=========
.. automodule:: pysumma.local_param_info
:members:

Basin Param Info
=========
.. automodule:: pysumma.basin_param_info
:members:
:undoc-members:
:show-inheritance:

.. Ensemble
.. =======
.. .. automodule:: pysumma.ensemble
.. :members:
..
.. File Manager
.. =========
.. .. automodule:: pysumma.file_manager
.. :members:
..
.. Decisions
.. =========
.. .. automodule:: pysumma.decisions
.. :members:
..
.. Output Control
.. =========
.. .. automodule:: pysumma.output_control
.. :members:
..
.. Local Param Info
.. =========
.. .. automodule:: pysumma.local_param_info
.. :members:
..
.. Basin Param Info
.. =========
.. .. automodule:: pysumma.basin_param_info
.. :members:
14 changes: 9 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
.. pysumma documentation
.. _index:

# pySUMMA
pySUMMA
=======

The pySUMMA is a Python wrapper for the manipulation, display and analysis of
SUMMA model (Structure for Unifying Multiple Modeling Alternatives)

* [SUMMA web site at UCAR ](https://www.rap.ucar.edu/projects/summa)

## pySUMMA intends to provide
pySUMMA intends to provide

- Get and set model parameters and method (fileManager and Decision file)
- Run SUMMA
- Visualize netcdf of SUMMA outputs
- Get and set model parameters and method (fileManager and Decision file)
- Run SUMMA
- Visualize netcdf of SUMMA outputs

Sitemap
=======
.. toctree::
:maxdepth: 3

api
source/pysumma.rst
source/modules.rst
7 changes: 7 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pysumma
=======

.. toctree::
:maxdepth: 4

pysumma
62 changes: 62 additions & 0 deletions docs/source/pysumma.hydroshare.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
pysumma.hydroshare package
==========================

Submodules
----------

pysumma.hydroshare.compat module
--------------------------------

.. automodule:: pysumma.hydroshare.compat
:members:
:undoc-members:
:show-inheritance:

pysumma.hydroshare.hydroshare module
------------------------------------

.. automodule:: pysumma.hydroshare.hydroshare
:members:
:undoc-members:
:show-inheritance:

pysumma.hydroshare.progress module
----------------------------------

.. automodule:: pysumma.hydroshare.progress
:members:
:undoc-members:
:show-inheritance:

pysumma.hydroshare.resource module
----------------------------------

.. automodule:: pysumma.hydroshare.resource
:members:
:undoc-members:
:show-inheritance:

pysumma.hydroshare.threads module
---------------------------------

.. automodule:: pysumma.hydroshare.threads
:members:
:undoc-members:
:show-inheritance:

pysumma.hydroshare.utilities module
-----------------------------------

.. automodule:: pysumma.hydroshare.utilities
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: pysumma.hydroshare
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/source/pysumma.meta.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
pysumma.meta package
====================

Module contents
---------------

.. automodule:: pysumma.meta
:members:
:undoc-members:
:show-inheritance:
102 changes: 102 additions & 0 deletions docs/source/pysumma.plotting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
pysumma.plotting package
========================

Submodules
----------

pysumma.plotting.energy\_balance module
---------------------------------------

.. automodule:: pysumma.plotting.energy_balance
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.energybalance module
-------------------------------------

.. automodule:: pysumma.plotting.energybalance
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.hovmoller module
---------------------------------

.. automodule:: pysumma.plotting.hovmoller
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.layers module
------------------------------

.. automodule:: pysumma.plotting.layers
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.plot module
----------------------------

.. automodule:: pysumma.plotting.plot
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.plotting module
--------------------------------

.. automodule:: pysumma.plotting.plotting
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.spatial module
-------------------------------

.. automodule:: pysumma.plotting.spatial
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.timeseries module
----------------------------------

.. automodule:: pysumma.plotting.timeseries
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.utils module
-----------------------------

.. automodule:: pysumma.plotting.utils
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.water\_balance module
--------------------------------------

.. automodule:: pysumma.plotting.water_balance
:members:
:undoc-members:
:show-inheritance:

pysumma.plotting.waterbalance module
------------------------------------

.. automodule:: pysumma.plotting.waterbalance
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: pysumma.plotting
:members:
:undoc-members:
:show-inheritance:

0 comments on commit f58d96c

Please sign in to comment.