Remove defunct nwis functions (recreation of PR DOI-USGS#216)

Author: thodson-usgs

dataretrieval/nwis.py

@@ -152,8 +152,8 @@ def get_discharge_measurements(
 
     """
     raise NameError(
-        "`nwis.get_discharge_measurements` has been replaced with "
-        "`waterdata.get_field_measurements`."
+        "`nwis.get_discharge_measurements` has been replaced "
+        "with `waterdata.get_field_measurements`."
     )
 
 
@@ -241,8 +241,8 @@ def get_gwlevels(
 
     """
     raise NameError(
-        "`nwis.get_gwlevels` has been replaced with "
-        "`waterdata.get_field_measurements()`."
+        "`nwis.get_gwlevels` has been replaced "
+        "with `waterdata.get_field_measurements()`."
     )
 
 
@@ -678,12 +678,12 @@ def get_pmcodes(
 ) -> tuple[pd.DataFrame, BaseMetadata]:
     """
     This function is defunct, use
-    `waterdata.get_reference_table(collection='parameter_code')`.
+    `get_reference_table(collection="parameter-codes")`.
 
     """
     raise NameError(
-        "`nwis.get_pmcodes` has been replaced with "
-        "`waterdata.get_reference_table(collection='parameter_code')`."
+        "`nwis.get_pmcodes` has been replaced "
+        "with `get_reference_table(collection='parameter-codes')`."
     )
 
 
@@ -695,10 +695,10 @@ def get_water_use(
     ssl_check: bool = True,
 ) -> tuple[pd.DataFrame, BaseMetadata]:
     """
-    This function is defunct with no current replacement.
+    This function is defunct and currently has no replacement.
 
     """
-    raise NameError("`nwis.get_water_use` is defunct with no current replacement.")
+    raise NameError("`nwis.get_water_use` is defunct.")
 
 
 def get_ratings(

demos/R Python Vignette equivalents.ipynb

@@ -25,53 +25,6 @@
     "The following shows python equivalents for methods outlined in the R dataRetrieval Vignette with the equivalent R code in comments"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "\"\"\"\n",
-    "library(dataRetrieval)\n",
-    "# Choptank River near Greensboro, MD\n",
-    "siteNumber <- \"01491000\"\n",
-    "ChoptankInfo <- readNWISsite(siteNumber)\n",
-    "parameterCd <- \"00060\"\n",
-    "\n",
-    "#Raw daily data:\n",
-    "rawDailyData <- readNWISdv(siteNumber,parameterCd,\n",
-    "                      \"1980-01-01\",\"2010-01-01\")\n",
-    "\n",
-    "# Sample data Nitrate:\n",
-    "parameterCd <- \"00618\"\n",
-    "qwData <- read_USGS_samples(monitoringLocationIdentifier=sprintf(\"USGS-%s\", siteNumber),usgsPCode=parameterCd,\n",
-    "                      activityStartDateLower=\"1980-01-01\", activityStartDateUpper=\"2010-01-01\")\n",
-    "\n",
-    "pCode <- readNWISpCode(parameterCd)\n",
-    "\"\"\"\n",
-    "\n",
-    "# Choptank River near Greensboro, MD\n",
-    "siteNumber = \"01491000\"\n",
-    "chop_tank_info, md = nwis.get_info(sites=siteNumber)\n",
-    "parameterCd = \"00060\"\n",
-    "\n",
-    "# raw daily data\n",
-    "rawDailyData, md = nwis.get_dv(\n",
-    "    sites=siteNumber, parameterCd=parameterCd, start=\"1980-01-01\", end=\"2010-01-01\"\n",
-    ")\n",
-    "\n",
-    "# sample data Nitrate:\n",
-    "parameterCd = \"00618\"\n",
-    "samples_data, md = waterdata.get_samples(\n",
-    "    monitoringLocationIdentifier=f\"USGS-{siteNumber}\",\n",
-    "    usgsPCode=parameterCd,\n",
-    "    activityStartDateLower=\"1980-01-01\",\n",
-    "    activityStartDateUpper=\"2010-01-01\",\n",
-    ")\n",
-    "\n",
-    "pCode, md = nwis.get_pmcodes(parameterCd=parameterCd)"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -103,25 +56,6 @@
     "dailyDataAvailable, md = nwis.get_dv(sites=siteNumbers, statCd=\"00003\")"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "pycharm": {
-     "is_executing": false
-    }
-   },
-   "outputs": [],
-   "source": [
-    "\"\"\"\n",
-    "# Using defaults:\n",
-    "parameterCd <- \"00618\" \n",
-    "parameterINFO <- readNWISpCode(parameterCd)\n",
-    "\"\"\"\n",
-    "\n",
-    "pCode, md = nwis.get_pmcodes(parameterCd=\"00618\")"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -228,20 +162,6 @@
     ")"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "\"\"\"\n",
-    "siteNumber <- \"434400121275801\"\n",
-    "groundWater <- readNWISgwl(siteNumber)\n",
-    "\"\"\"\n",
-    "siteNumber = \"434400121275801\"\n",
-    "groundWater, md = nwis.get_gwlevels(sites=siteNumber)"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -269,35 +189,6 @@
     "ratings_data, md = nwis.get_ratings(site=\"01594440\", file_type=\"base\")"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "\"\"\"surfaceData <- readNWISmeas(siteNumber)\"\"\"\n",
-    "siteNumber = \"01594440\"\n",
-    "surface_data, md = nwis.get_discharge_measurements(sites=siteNumber)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "\"\"\"\n",
-    "allegheny <- readNWISuse(stateCd = \"Pennsylvania\",\n",
-    "                         countyCd = \"Allegheny\")\n",
-    "national <- readNWISuse(stateCd = NULL, \n",
-    "                        countyCd = NULL, \n",
-    "                        transform = TRUE)\n",
-    "\"\"\"\n",
-    "allegheny, md = nwis.get_water_use(state=\"PA\", counties=\"003\")\n",
-    "\n",
-    "national, md = nwis.get_water_use()"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -314,22 +205,6 @@
     ")"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# '''\n",
-    "# specificCond <- readWQPqw('WIDNR_WQX-10032762',\n",
-    "#                           'Specific conductance',\n",
-    "#                           '2011-05-01','2011-09-30')\n",
-    "# '''\n",
-    "# specific_cond, md = wqp.get_results(siteid='WIDNR_WQX-10032762',\n",
-    "#                           characteristicName = 'Specific conductance',\n",
-    "#                           startDateLo='2011-05-01', startDateHi='2011-09-30')"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -400,12 +275,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "\"\"\"\n",
@@ -461,8 +331,7 @@
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "pygments_lexer": "ipython3"
   },
   "vscode": {
    "interpreter": {