docs: migrate userguide, examples, and notebooks to the Water Data API#290
Merged
Merged
Conversation
thodson-usgs
force-pushed
the
waterdata-docs
branch
from
f7021e6 to
61d51f2
Compare
Move the user guide, example pages, and demo notebooks off the deprecated `nwis` module onto the `waterdata` module (USGS Water Data API): - userguide/timeconventions: rewritten for the Water Data API datetime model (`time` is a column; tz-aware UTC for continuous data, tz-naive for daily), using the `.dt.tz_convert` idiom. - examples/readme_examples + siteinfo_examples: ported to get_continuous, get_monitoring_locations, and get_time_series_metadata. - demo notebooks: migrated to the waterdata API (USGS-prefixed monitoring location ids; get_daily, get_continuous, get_field_measurements, get_peaks, get_ratings, get_stats_*, get_samples), with titles, narratives, and argument lists rewritten to match the code. WaterUse stays on the legacy nwis.get_water_use with a note (no Water Data API equivalent yet). - renamed the demo notebooks to lead with their module (USGS_WaterData_*, USGS_NLDI, USGS_NWIS_WaterUse) and renamed the peak-flow trends demo to peak_streamflow_trends. - nldi: mark the nationwide get_features_by_data_source example `# doctest: +SKIP` (it streams every nwissite feature and hangs the build). - fixed pre-existing Sphinx build warnings: get_channel bullet-list RST, the duplicated get_monitoring_locations link, the NWIS_Metadata duplicate object description, the deprecated display_version theme option, the missing _static directory, and a WaterData_demo heading level. Notebooks are kept output-free (nbsphinx executes them at build time). `sphinx-build -b doctest` passes and every notebook executes against the live API with no cell errors. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
thodson-usgs
force-pushed
the
waterdata-docs
branch
from
61d51f2 to
3420744
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrates the documentation and demo notebooks off the deprecated
nwismodule onto thewaterdatamodule (USGS Water Data API).Changes
timeis a column (tz-aware UTC for continuous data, tz-naive for daily), with the.dt.tz_convertidiom.get_continuous/get_monitoring_locations/get_time_series_metadata.get_daily,get_continuous,get_field_measurements,get_peaks,get_ratings,get_stats_*,get_samples), with titles, narratives, and argument lists rewritten to match the code. WaterUse stays on legacynwis.get_water_usewith a note (no Water Data API equivalent yet).USGS_WaterData_*,USGS_NLDI,USGS_NWIS_WaterUse— and renamed the peak-flow trends demo topeak_streamflow_trends.get_features_by_data_sourceexample is marked# doctest: +SKIP(it streams everynwissitefeature).get_channelbullet-list RST, the duplicatedget_monitoring_locations"list of codes" link, theNWIS_Metadataduplicate object description, the deprecateddisplay_versiontheme option, the missing_static/directory, and aWaterData_demoheading level.Verification
sphinx-build -b doctest: 0 failures (against the live API).make html: builds with notebooks executing against the live API — 0 notebook cell errors; the only remaining warnings are the intentional!pipcells inWaterData_demo.🤖 Generated with Claude Code