Merge pull request #164 from UW-Hydro/develop

Develop

Author: arbennett

binder/apt.txt

@@ -0,0 +1,3 @@
+wget
+software-properties-common
+ca-certificates

binder/environment.yml

@@ -0,0 +1,28 @@
+name: pysumma
+channels:
+  - conda-forge
+dependencies:
+  - python>=3.7
+  - xarray>=0.15.0
+  - pandas
+  - netcdf4>=1.2.5
+  - numpy>=1.11.2
+  - dask
+  - distributed
+  - toolz
+  - pytest
+  - fiona
+  - cartopy
+  - shapely
+  - seaborn
+  - matplotlib
+  - geopandas
+  - pandas
+  - jupyter
+  - pip
+  - summa>=3.0.3
+  - pysumma>=3.0.3
+  - mizuroute
+  - pip:
+    - hs_restclient
+    - nbsphinx

binder/postbuild

@@ -0,0 +1,3 @@
+source activate pysumma
+python setup.py develop
+python -m ipykernel install --user --name pysumma

docs/_static/wide_theme.css

@@ -0,0 +1,3 @@
+.wy-nav-content {
+max-width: 1200px !important;
+}

docs/api.rst

@@ -8,6 +8,9 @@ API reference
 This page provides an auto-generated summary of pysumma's API. For more details
 and examples, refer to the main documentation.
 
+Interfaces to running SUMMA
++++++++++++++++++++++++++++
+
 Simulation
 ==========
 .. autoclass:: pysumma.Simulation
@@ -20,8 +23,32 @@ Ensemble
     :members:
 
 Distributed
-=======
+===========
 
 .. autoclass:: pysumma.Distributed
     :members:
 
+Ostrich
+=======
+
+.. autoclass:: pysumma.calibration.Ostrich
+    :members:
+
+Plotting utilities
+++++++++++++++++++
+
+.. automodule:: pysumma.plotting.layers
+    :members:
+
+.. automodule:: pysumma.plotting.hovmoller
+    :members:
+
+.. automodule:: pysumma.plotting.spatial
+    :members: spatial
+
+
+Evaluation utilities
+++++++++++++++++++++
+
+.. automodule:: pysumma.evaluation
+    :members:

docs/conf.py

@@ -21,6 +21,7 @@
 
 sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('../tutorial'))
 
 # -- General configuration ------------------------------------------------
 
@@ -36,7 +37,10 @@
               'sphinx.ext.mathjax',
               'sphinx.ext.viewcode',
               'sphinx.ext.napoleon',
-              'sphinx.ext.autosummary']
+              'sphinx.ext.autosummary',
+              'nbsphinx',
+              'nbsphinx_multilink'
+              ]
 
 extlinks = {'issue': ('https://github.com/UW-Hydro/pysumma/issues/%s', 'GH'),
             'pull': ('https://github.com/UW-Hydro/pysumma/pull/%s', 'PR'),
@@ -163,6 +167,9 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'pysumma', 'pysumma Documentation',
-     author, 'pysumma ', 'One line description of project.',
-     'Miscellaneous'),
+     author, 'pysumma ', 'A python package for interfacing with SUMMA',
+     'Hydrology'),
 ]
+
+def setup(app):
+    app.add_css_file('wide_theme.css')

docs/index.rst

@@ -22,7 +22,7 @@ it will also install a compatible version of SUMMA.
 
 To install via ``conda`` use:
 
-:: 
+::
 
     conda install -c conda-forge pysumma
 
@@ -78,21 +78,12 @@ Bugs
   will help you make the pull request if you are new to git
   (just ask on the issue).
 
-How to run pySUMMA on HydroShare
-================================
- (Link YouTube: https://www.youtube.com/watch?v=pL-LNd474Tw)
- 1) log in HydoShare(https://www.hydroshare.org)
- 2) Start CUAHSI JupyterHub from APPS menu on HydroShare(https://www.hydroshare.org/apps/)
- 3) Open "Welcome.ipynb" to download pySUMMA resources from HydroShare
-  - run the code "1.How to connect with HydroShare"
-  - change the code from "resid = os.environ['HS_RES_ID']" to "resid = 'c1bb4a12bff44bf08c5958cba7947348'".
- 4) You can see the list of Jupyter Notebooks and click one of Jupyter Notebook.
- 5) Run one of Jupyter Notebooks.
-
 Sitemap
 =======
 .. toctree::
     :maxdepth: 3
 
-    api
     configuration
+    tutorials
+    plotting
+    api

docs/plotting.ipynb

@@ -0,0 +1,4 @@
+Sphinx>=3.0
+nbconvert==5.6.1
+nbsphinx-link
+nbsphinx-multilink

docs/requirements.txt

@@ -0,0 +1,7 @@
+
+[
+  { "path": "../tutorial/1_introduction_to_pysumma.ipynb" },
+  { "path": "../tutorial/2_building_ensembles.ipynb" },
+  { "path": "../tutorial/3_parallelizing_distributed_simulations.ipynb" },
+  { "path": "../tutorial/4_simple_calibration.ipynb" }
+]