Merge pull request #55 from SorooshMani-NOAA/feature/usgs_nwis

Adding support for USGS stations

Author: SorooshMani-NOAA

CERA_filter_STOFS_stations_from_searvey_csv.py

@@ -11,9 +11,9 @@
 
 import CERA_get_active_stations
 
+
 ################################################################################
 def get_csv():
-
     # read searvey data and return geopandas geodataframe object
 
     # COOPS stations, status = active

CERA_filter_STOFS_stations_from_searvey_json.py

@@ -8,9 +8,9 @@
 
 import CERA_get_active_stations
 
+
 ################################################################################
 def get_geojson():
-
     # read searvey data and return geopandas geodataframe object
 
     # COOPS stations, status = active

CERA_get_active_stations.py

@@ -22,7 +22,6 @@ def get_ioc_stations_activity(
     activity_threshold: datetime.timedelta,
     region: Polygon | MultiPolygon | None = None,
 ) -> gpd.GeoDataFrame:
-
     # Retrieve the metadata
     ioc_gdf = ioc.get_ioc_stations(region=region)
 
@@ -81,7 +80,6 @@ def get_ioc_stations_activity(
 def get_coops_stations_activity(
     region: Polygon | MultiPolygon | None = None,
 ) -> gpd.GeoDataFrame:
-
     # Retrieve the metadata
     coops_gdf = coops.coops_stations_within_region(region=region)
 

README.md

@@ -16,6 +16,7 @@ Searvey aims to provide the following functionality:
 
     - U.S. Center for Operational Oceanographic Products and Services (CO-OPS)
     - Flanders Marine Institute (VLIZ); Intergovernmental Oceanographic Commission (IOC)
+    - U.S. Geological Survey (USGS)
 
 ## Installation
 

docs/source/index.rst

@@ -6,3 +6,4 @@
    installation
    coops
    ioc
+   usgs

docs/source/usgs.rst

@@ -0,0 +1,18 @@
+USGS
+====
+
+The United States Geological Survey's (USGS) `National Water Information
+System (NWIS) <https://waterdata.usgs.gov/nwis>`_ provides different
+categories of water data for sites all across the US. This includes information
+about both surface and ground water, and for physical, chemical, and pollution
+variables. `searvey` uses NWIS REST API through `dataretrieval`
+package to access this data. Currently only data about elevation and
+flow rate are exposed in `searvey`.
+
+A list of USGS stations is provided with the ``get_usgs_stations()`` function with various subsetting options.
+
+.. autofunction:: searvey.usgs.get_usgs_stations
+
+The station data can be retrieved with
+
+.. autofunction:: searvey.usgs.get_usgs_data