Skip to content

Commit 2eff9e8

Browse files
committed
remove some references to defunct fxns in README, documentation
1 parent 388e1ac commit 2eff9e8

2 files changed

Lines changed: 3 additions & 83 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Latest Announcements
88

9-
**02/24/2026** The `get_gwlevels`, `get_discharge_measurements` in the `nwis` module are deprecated and have been replaced with the `get_field_measurements` function in the `waterdata` module. The `get_pmcodes` function in the `nwis` module has been replaced with the `get_reference_table(collection='parameter_code)` function.
9+
**02/24/2026** The `get_gwlevels`, `get_discharge_measurements` functions in the `nwis` module are defunct and have been replaced with the `get_field_measurements` function in the `waterdata` module. The `get_pmcodes` function in the `nwis` module has been replaced with the `get_reference_table(collection='parameter_code)` function. Finally, the `get_water_use` function in the `nwis` module is defunct with no current replacement.
1010

1111
:mega: **01/16/2026:** `dataretrieval` now features the `waterdata` module,
1212
which provides access to USGS's modernized [Water Data
@@ -138,7 +138,7 @@ To log messages to a file, you can specify a filename in the
138138
logging.basicConfig(filename='waterdata.log', level=logging.INFO)
139139
```
140140

141-
### NWIS Legacy Services (Deprecated but still functional)
141+
### Legacy NWIS Services (Deprecated but still functional)
142142

143143
The `nwis` module accesses legacy NWIS Water Services:
144144

demos/R Python Vignette equivalents.ipynb

Lines changed: 1 addition & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,7 @@
6262
"\n",
6363
"# sample data Nitrate:\n",
6464
"parameterCd = \"00618\"\n",
65-
"samples_data, md = waterdata.get_samples(monitoringLocationIdentifier=f\"USGS-{siteNumber}\", usgsPCode=parameterCd, activityStartDateLower=\"1980-01-01\", activityStartDateUpper=\"2010-01-01\")\n",
66-
"\n",
67-
"pCode, md = nwis.get_pmcodes(parameterCd=parameterCd)"
65+
"samples_data, md = waterdata.get_samples(monitoringLocationIdentifier=f\"USGS-{siteNumber}\", usgsPCode=parameterCd, activityStartDateLower=\"1980-01-01\", activityStartDateUpper=\"2010-01-01\")\n"
6866
]
6967
},
7068
{
@@ -98,25 +96,6 @@
9896
"dailyDataAvailable, md = nwis.get_dv(sites=siteNumbers, statCd=\"00003\")"
9997
]
10098
},
101-
{
102-
"cell_type": "code",
103-
"execution_count": null,
104-
"metadata": {
105-
"pycharm": {
106-
"is_executing": false
107-
}
108-
},
109-
"outputs": [],
110-
"source": [
111-
"'''\n",
112-
"# Using defaults:\n",
113-
"parameterCd <- \"00618\" \n",
114-
"parameterINFO <- readNWISpCode(parameterCd)\n",
115-
"'''\n",
116-
"\n",
117-
"pCode, md = nwis.get_pmcodes(parameterCd=\"00618\")"
118-
]
119-
},
12099
{
121100
"cell_type": "code",
122101
"execution_count": null,
@@ -211,20 +190,6 @@
211190
" activityStartDateLower=startDate, activityStartDateUpper=endDate)"
212191
]
213192
},
214-
{
215-
"cell_type": "code",
216-
"execution_count": null,
217-
"metadata": {},
218-
"outputs": [],
219-
"source": [
220-
"'''\n",
221-
"siteNumber <- \"434400121275801\"\n",
222-
"groundWater <- readNWISgwl(siteNumber)\n",
223-
"'''\n",
224-
"siteNumber = \"434400121275801\"\n",
225-
"groundWater, md = nwis.get_gwlevels(sites=siteNumber)"
226-
]
227-
},
228193
{
229194
"cell_type": "code",
230195
"execution_count": null,
@@ -252,35 +217,6 @@
252217
"ratings_data, md = nwis.get_ratings(site='01594440', file_type=\"base\")"
253218
]
254219
},
255-
{
256-
"cell_type": "code",
257-
"execution_count": null,
258-
"metadata": {},
259-
"outputs": [],
260-
"source": [
261-
"'''surfaceData <- readNWISmeas(siteNumber)'''\n",
262-
"siteNumber = '01594440'\n",
263-
"surface_data, md = nwis.get_discharge_measurements(sites=siteNumber)"
264-
]
265-
},
266-
{
267-
"cell_type": "code",
268-
"execution_count": null,
269-
"metadata": {},
270-
"outputs": [],
271-
"source": [
272-
"'''\n",
273-
"allegheny <- readNWISuse(stateCd = \"Pennsylvania\",\n",
274-
" countyCd = \"Allegheny\")\n",
275-
"national <- readNWISuse(stateCd = NULL, \n",
276-
" countyCd = NULL, \n",
277-
" transform = TRUE)\n",
278-
"'''\n",
279-
"allegheny, md = nwis.get_water_use(state=\"PA\", counties=\"003\")\n",
280-
"\n",
281-
"national, md = nwis.get_water_use()"
282-
]
283-
},
284220
{
285221
"cell_type": "code",
286222
"execution_count": null,
@@ -295,22 +231,6 @@
295231
"discharge_stats, md = nwis.get_stats(sites='02319394', parameterCd=\"00060\", statReportType='annual', statTypeCd='all')"
296232
]
297233
},
298-
{
299-
"cell_type": "code",
300-
"execution_count": null,
301-
"metadata": {},
302-
"outputs": [],
303-
"source": [
304-
"# '''\n",
305-
"# specificCond <- readWQPqw('WIDNR_WQX-10032762',\n",
306-
"# 'Specific conductance',\n",
307-
"# '2011-05-01','2011-09-30')\n",
308-
"# '''\n",
309-
"# specific_cond, md = wqp.get_results(siteid='WIDNR_WQX-10032762',\n",
310-
"# characteristicName = 'Specific conductance',\n",
311-
"# startDateLo='2011-05-01', startDateHi='2011-09-30')"
312-
]
313-
},
314234
{
315235
"cell_type": "code",
316236
"execution_count": null,

0 commit comments

Comments
 (0)