Merge pull request #206 from emiliom/rel0.8.7

Add NOAA GOES docs and docstring; polish README
ulmo-dev · Aug 31, 2021 · 5f7ac46 · 5f7ac46
2 parents 86ff9c3 + 65f8f19
commit 5f7ac46
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -75,6 +75,7 @@ To setup a development environment using conda:
     conda env create -n myenv --file conda_environment.yml
 
     # use 'activate myenv' on windows
+
     source activate myenv
 
     pip install -e .
@@ -84,7 +85,7 @@ Links
 -----
 
 * Documentation: http://ulmo.readthedocs.org
-* Repository: `source code`_
+* Repository: https://github.com/ulmo-dev/ulmo
 
 
 .. _source code: https://github.com/ulmo-dev/ulmo

diff --git a/docs/api.rst b/docs/api.rst
@@ -68,6 +68,12 @@ NCDC Global Summary of the Day (GSoD)
    :members: get_data, get_stations
 
 
+NOAA GOES Data Collection System (DCS) services
+-----------------------------------------------
+.. automodule:: ulmo.noaa.goes
+   :members: get_data, decode
+
+
 USGS National Water Information System (NWIS)
 ---------------------------------------------
 .. automodule:: ulmo.usgs.nwis
@@ -77,12 +83,6 @@ USGS National Water Information System (NWIS)
    :members:
 
 
-USGS Emergency Data Distribution Network (EDDN) services
---------------------------------------------------------
-.. automodule:: ulmo.usgs.eddn
-   :members: get_data, decode
-
-
 USGS National Elevation Dataset (NED) raster services
 -----------------------------------------------------
 .. automodule:: ulmo.usgs.ned

diff --git a/ulmo/noaa/goes/__init__.py b/ulmo/noaa/goes/__init__.py
@@ -1 +1,8 @@
+"""
+    NOAA `GOES Data Collection System`_ 
+    Access to data stream transmitted via GOES satellite.
+
+    .. _GOES Data Collection System: https://www.noaasis.noaa.gov/GOES/GOES_DCS/goes_dcs.html
+"""
+
 from .core import get_data, decode