dataretrieval is a Python alternative to the R dataRetrieval package for obtaining USGS or EPA water quality data, streamflow data, and metadata directly from web services. Note that dataretrieval is an alternative to the R package, not a port, in that it attempts to reproduce the functionality of the R package, though its organization and functionality often differ.
If there's a hydrologic or environmental data portal that you'd like dataretrieval to work with, raise it as an issue.
Here's an example of how to use dataRetrieval to retrieve data from the National Water Information System (NWIS).
# first import the functions for downloading data from NWIS
import dataretrieval.nwis as nwis
# specify the USGS site code for which we want data.
site = '03339000'
# get instantaneous values (iv)
df = nwis.get_record(sites=site, service='iv', start='2017-12-31', end='2018-01-01')
# get water quality samples (qwdata)
df2 = nwis.get_record(sites=site, service='qwdata', start='2017-12-31', end='2018-01-01')
# get basic info about the site
df3 = nwis.get_record(sites=site, service='site')
Services available from NWIS include:
- instantaneous values (iv)
- daily values (dv)
- statistics (stat)
- site info (site)
- discharge peaks (peaks)
- discharge measurements (measurements)
- water quality samples (qwdata)
To access the full functionality available from NWIS web services, nwis.get record appends any additional kwargs into the REST request. For example
nwis.get_record(sites='03339000', service='dv', start='2017-12-31', parameterCd='00060')
will download daily data with the parameter code 00060 (discharge).
If you're connected to the USGS network, dataretrieval call pull from the internal (non-public) NWIS interface. Most dataretrieval functions pass kwargs directly to NWIS's REST API, which provides simple access to internal data; simply specify "access='3'". For example
nwis.get_record(sites='05404147',service='iv', start='2021-01-01', end='2021-3-01', access='3')
More services and documentation to come!
dataretrieval can be installed using pip:
$ python3 -m pip install -U dataretrieval
or conda:
$ conda install -c conda-forge dataretrieval
Please report any bugs and enhancement ideas using the dataretrieval issue tracker:
https://github.com/USGS-python/dataretrieval/issues
Feel free to also ask questions on the tracker.
Any help in testing, development, documentation and other tasks is highly appreciated and useful to the project.
For more details, see the file CONTRIBUTING.md.
The Water Mission Area of the USGS supports the development and maintenance of dataretrieval
and most likely further into the future.
Resources are available primarily for maintenance and responding to user questions.
Priorities on the development of new features are determined by the dataretrieval
development team.
This material is partially based upon work supported by the National Science Foundation (NSF) under award 1931297. Any opinions, findings, conclusions, or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the NSF.
This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy
Although this software program has been used by the U.S. Geological Survey (USGS), no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.
This software is provided “AS IS.”
Hodson, T.O., Hariharan, J.A., and contributors, 2022, dataretrieval (Python): a Python package for discovering and retrieving water data available from U.S. federal hydrologic web services: U.S. Geological Survey software release, https://doi.org/10.5066/P94I5TX3