HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-cli
Add nws api tool to get obs/forecasted stage and flow
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 4
- Avg merge
- 19h 59m
- Merged PRs (30d)
- 3
Description
CLI Script
Other
Feature Proposal
Use the NWS API to get observed stage and flow from NWS api (e.g.
https://api.water.noaa.gov/nwps/v1/gauges/DBYT2/stageflow). This would be useful to scrape observed data the NWS collects but USACE does not collect (e.g. observers like county dams or non-usace hydropower) as well as getting their official forecasts. Could use timeseries groups similar to usgs timeseries.
REDACTED relevant log output
Related Context or Links
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the existing usgs timeseries CLI implementation and how it groups timeseries, then review the NWS stageflow endpoint for gauge DBYT2. Done means a CLI tool can retrieve observed stage and flow as well as official forecasts from the NWS API, including data useful for non-USACE gauges.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100