move samples function to waterdata.py

Author: ehinman

README.md

@@ -53,11 +53,11 @@ Water quality data are available from:
 - [Samples](https://waterdata.usgs.gov/download-samples/#dataProfile=site) - Discrete USGS water quality data only
 - [Water Quality Portal](https://www.waterqualitydata.us/) - Discrete water quality data from USGS and EPA. Older data are available in the legacy WQX version 2 format; all data are available in the beta WQX3.0 format.
 
-To access the full functionality available from NWIS web services, nwis.get record appends any additional kwargs into the REST request. For example
+To access the full functionality available from NWIS web services, nwis.get record appends any additional kwargs into the REST request. For example:
 ```python
 nwis.get_record(sites='03339000', service='dv', start='2017-12-31', parameterCd='00060')
 ```
-will download daily data with the parameter code 00060 (discharge).
+...will download daily data with the parameter code 00060 (discharge).
 
 ## Accessing the "Internal" NWIS
 If you're connected to the USGS network, dataretrieval call pull from the internal (non-public) NWIS interface.

dataretrieval/__init__.py

@@ -5,6 +5,7 @@
 from dataretrieval.samples import *
 from dataretrieval.streamstats import *
 from dataretrieval.utils import *
+from dataretrieval.waterdata import *
 from dataretrieval.waterwatch import *
 from dataretrieval.wqp import *
 

dataretrieval/nwis.py

@@ -134,13 +134,13 @@ def get_qwdata(
     **kwargs,
 ) -> Tuple[pd.DataFrame, BaseMetadata]:
     """
-    Get water sample data from qwdata service - deprecated, use `get_usgs_samples()`
-    in the samples module.
+    Get water sample data from qwdata service - deprecated, use `get_samples()`
+    in the waterdata module.
 
     """
     return print("This function is deprecated and has been " \
-                 "replaced with `get_usgs_samples() in the " \
-                 "samples module. If you have questions, " \
+                 "replaced with `get_samples() in the " \
+                 "waterdata module. If you have questions, " \
                  "please reach out to comptools@usgs.gov")
 
 

dataretrieval/samples.py

@@ -272,21 +272,21 @@ def get_usgs_samples(
     .. code::
 
         >>> # Get PFAS results within a bounding box
-        >>> df, md = dataretrieval.samples.get_usgs_samples(
+        >>> df, md = dataretrieval.samples.get_samples(
         ...     boundingBox=[-90.2,42.6,-88.7,43.2],
         ...     characteristicGroup="Organics, PFAS"
         ... )
 
         >>> # Get all activities for the Commonwealth of Virginia over a date range
-        >>> df, md = dataretrieval.samples.get_usgs_samples(
+        >>> df, md = dataretrieval.samples.get_samples(
         ...     service="activities",
         ...     profile="sampact",
         ...     activityStartDateLower="2023-10-01",
         ...     activityStartDateUpper="2024-01-01",
         ...     stateFips="US:51")
 
         >>> # Get all pH samples for two sites in Utah
-        >>> df, md = dataretrieval.samples.get_usgs_samples(
+        >>> df, md = dataretrieval.samples.get_samples(
         ...     monitoringLocationIdentifier=['USGS-393147111462301', 'USGS-393343111454101'],
         ...     usgsPCode='00400')