Examples

Introduction to the waterdata module of dataretrieval

The waterdata module will replace the nwis module as the primary set of data download functions for USGS water data. This Jupyter notebook covers a basic introduction to module functions and usage.

• Using the waterdata module to pull data from the USGS Water Data APIs

USGS Water Data API vignettes

These notebooks are Python ports of the new USGS Water Data API vignettes from the R dataRetrieval package. Each introduces a family of waterdata functions and is executed against the live USGS Water Data API.

• Introduction to the USGS Water Data APIs
• Discrete water-quality samples: get_samples
• Daily statistics: get_stats_por and get_stats_date_range
• Continuous Data
• USGS Reference Lists

Simple uses of the dataretrieval package

• Retrieving USGS water data with the waterdata module
• Retrieving site information

Example Notebooks from Hydroshare

A set of Jupyter Notebooks with Python code examples on how to use the dataretrieval package are available on the Hydroshare platform. We provide executed versions of these notebooks below; to download the .ipynb files for your own use, either visit the Hydroshare repository, or navigate to the demos/hydroshare subdirectory of the dataretrieval project repository.

• USGS dataretrieval Python Package get_daily() Examples
• USGS dataretrieval Python Package Groundwater-Level get_field_measurements() Examples
• USGS dataretrieval Python Package Surface-Water get_field_measurements() Examples
• USGS dataretrieval Python Package get_reference_table() Examples
• USGS dataretrieval Python Package Peak Streamflow Examples
• USGS dataretrieval Python Package Rating Curve Examples
• USGS dataretrieval Python Package get_monitoring_locations() Examples
• USGS dataretrieval Python Package get_monitoring_locations() Examples
• USGS dataretrieval Python Package Statistics Examples
• USGS dataretrieval Python Package get_continuous() Examples
• USGS dataretrieval Python Package get_samples() Examples
• USGS dataretrieval Python Package Water Use Examples

Using dataretrieval to obtain nation trends in peak annual streamflow

• National trends in peak annual streamflow
  • Introduction
  • Setup
  • Basic usage
  • Preparing the regression
  • Preparing the analysis
  • Plotting the results

Duplicating the R dataRetrieval vignettes functionality

Note

Some of the larger (e.g., state-wide) examples have been commented out in the interest of run-time for the notebook.

• Python Equivalents to R Vignette Examples
• Embedded Metadata