added NWM and ERA docs; fixed NWM docs

CI-WATER · May 15, 2017 · fc48612 · fc48612
1 parent 9bf9479
commit fc48612
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 3 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -61,6 +61,8 @@ GRID API
 
     api/grid/lsm_tools
     api/grid/hrrr_tools
+    api/grid/era_tools
+    api/grid/nwm_tools
 
 Modeling API
 ============

diff --git a/docs/api/grid/era_tools.rst b/docs/api/grid/era_tools.rst
@@ -0,0 +1,19 @@
+**************************************
+ERA output to GSSHA input (ERAtoGSSHA)
+**************************************
+- https://software.ecmwf.int/wiki/display/CKB/What+is+ERA5
+
+- http://www.ecmwf.int/en/research/climate-reanalysis/era-interim
+
+
+ERAtoGSSHA
+===========
+
+.. autoclass:: gsshapy.grid.ERAtoGSSHA
+    :show-inheritance:
+
+Download ERA
+============
+.. autofunction:: gsshapy.grid.era_to_gssha.download_era5_for_gssha
+
+.. autofunction:: gsshapy.grid.era_to_gssha.download_interim_for_gssha
diff --git a/docs/api/grid/nwm_tools.rst b/docs/api/grid/nwm_tools.rst
@@ -0,0 +1,10 @@
+*******************************************************
+National Water Model output to GSSHA input (NWMtoGSSHA)
+*******************************************************
+http://water.noaa.gov/about/nwm
+
+NWMtoGSSHA
+===========
+
+.. autoclass:: gsshapy.grid.NWMtoGSSHA
+    :show-inheritance:
diff --git a/gsshapy/grid/nwm_to_gssha.py b/gsshapy/grid/nwm_to_gssha.py
@@ -38,6 +38,7 @@ class NWMtoGSSHA(GRIDtoGSSHA):
 
     Example::
 
+
         from datetime import datetime
         from gsshapy.grid import NWMtoGSSHA
 
@@ -48,7 +49,7 @@ class NWMtoGSSHA(GRIDtoGSSHA):
                          )
 
 
-        out_gage_file = 'E:\\GSSHA\\era5_rain1.gag
+        out_gage_file = 'E:\\GSSHA\\era5_rain1.gag'
         e2g.lsm_precip_to_gssha_precip_gage(out_gage_file,
                                             lsm_data_var="RAINRATE",
                                             precip_type="ACCUM")
@@ -58,13 +59,14 @@ class NWMtoGSSHA(GRIDtoGSSHA):
                                ['pressure', 'PSFC'],
                                ['relative_humidity', ['Q2D','T2D', 'PSFC']],
                                ['wind_speed', ['U2D', 'V2D']],
-                               ['direct_radiation', 'SWDOWN'], ???
-                               ['diffusive_radiation', 'SWDOWN'], ???
+                               ['direct_radiation', 'SWDOWN'],  # ???
+                               ['diffusive_radiation', 'SWDOWN'],  # ???
                                ['temperature', 'T2D'],
                                ['cloud_cover', '????'],
                               ]
 
         e2g.lsm_data_to_arc_ascii(data_var_map_array)
+
     """
     def __init__(self,
                  gssha_project_folder,