Skip to content

Commit 31ff4ba

Browse files
authored
Point get_gwlevels deprecation at continuous/daily services (DOI-USGS#237)
The old stub only directed users to waterdata.get_field_measurements, which returns discrete/manual readings and silently drops users who need continuous transducer data. Extend the NameError and the get_record defunct-replacement table to also surface get_continuous and get_daily. Fixes DOI-USGS#236.
1 parent 3550374 commit 31ff4ba

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

dataretrieval/nwis.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -291,10 +291,13 @@ def get_discharge_peaks(
291291

292292

293293
def get_gwlevels(**kwargs):
294-
"""Defunct: use ``waterdata.get_field_measurements()``."""
294+
"""Defunct: use ``waterdata.get_continuous()``, ``waterdata.get_daily()``,
295+
or ``waterdata.get_field_measurements()``."""
295296
raise NameError(
296-
"`nwis.get_gwlevels` has been replaced "
297-
"with `waterdata.get_field_measurements()`."
297+
"`nwis.get_gwlevels` has been replaced. Use "
298+
"`waterdata.get_continuous()` for continuous (typically 15-minute) "
299+
"values, `waterdata.get_daily()` for daily values, or "
300+
"`waterdata.get_field_measurements()` for discrete/manual readings."
298301
)
299302

300303

@@ -885,7 +888,8 @@ def get_record(
885888
- 'site' : site description
886889
- 'measurements' : (defunct) use `waterdata.get_field_measurements`
887890
- 'peaks': discharge peaks
888-
- 'gwlevels': (defunct) use `waterdata.get_field_measurements`
891+
- 'gwlevels': (defunct) use `waterdata.get_continuous`,
892+
`waterdata.get_daily`, or `waterdata.get_field_measurements`
889893
- 'pmcodes': (defunct) use `get_reference_table`
890894
- 'water_use': (defunct) no replacement available
891895
- 'ratings': get rating table
@@ -933,7 +937,11 @@ def get_record(
933937

934938
defunct_replacements = {
935939
"measurements": "`waterdata.get_field_measurements`",
936-
"gwlevels": "`waterdata.get_field_measurements`",
940+
"gwlevels": (
941+
"`waterdata.get_continuous` (continuous), "
942+
"`waterdata.get_daily`, or `waterdata.get_field_measurements` "
943+
"(discrete)"
944+
),
937945
"pmcodes": "`waterdata.get_reference_table`",
938946
"water_use": "no replacement available",
939947
}

0 commit comments

Comments
 (0)