Skip to content

Commit 472eb0f

Browse files
thodson-usgsclaude
andcommitted
docs: make the README Available Data Services entries consistent
Give every service the same `### Name — `dataretrieval.module`` heading (Water Use was missing its module reference) and the same `function: description` bullet style (Water Use listed data categories instead of its `get_wateruse` getter). Add `get_peaks` to the waterdata list so peak streamflow appears under the recommended module, not only under the deprecated NWIS one. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Sjb14HkwuCydKSKMsaXsgd
1 parent 4daf771 commit 472eb0f

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ pip install git+https://github.com/DOI-USGS/dataretrieval-python.git
3737

3838
## Usage Examples
3939

40-
### Water Data API (Recommended - Modern USGS Data)
40+
### Water Data API
4141

4242
Access USGS water-monitoring data.
4343

@@ -219,10 +219,11 @@ print(statewide.head())
219219

220220
## Available Data Services
221221

222-
### Modern USGS Water Data APIs (Recommended) `dataretrieval.waterdata`
222+
### Modern USGS Water Data APIs — `dataretrieval.waterdata`
223223
- `get_daily`: Daily statistical summaries (mean, min, max)
224224
- `get_continuous`: High-frequency continuous (instantaneous) values
225225
- `get_field_measurements`: Discrete measurements from field visits
226+
- `get_peaks`: Annual peak streamflow
226227
- `get_monitoring_locations`: Site information and metadata
227228
- `get_time_series_metadata`: A location's available data parameters
228229
- `get_latest_daily`: Most recent daily statistical summary
@@ -257,12 +258,8 @@ print(statewide.head())
257258
- `get_features`: Find monitoring sites, dams, and other features along the network
258259
- `get_features_by_data_source`: Features from a specific data source
259260

260-
### Water Use (NWDC)
261-
- **Public supply**: Modeled public-supply withdrawals and consumptive use
262-
- **Irrigation**: Modeled irrigation withdrawals and consumptive use
263-
- **Thermoelectric**: Modeled thermoelectric-power water use
264-
- **HUC12 estimates**: National coverage on a 12-digit hydrologic-unit grid,
265-
summarizable to counties, states, or coarser hydrologic units
261+
### Water Use (NWDC) — `dataretrieval.wateruse`
262+
- `get_wateruse`: Modeled water-use estimates — public-supply, irrigation, and thermoelectric withdrawals and consumptive use — on a national 12-digit hydrologic-unit (HUC12) grid, summarizable to counties, states, or coarser hydrologic units
266263

267264
## More Examples
268265

0 commit comments

Comments
 (0)