Tools for downloading hydrologic and climate data.
Project description
dataretrieval: Download hydrologic data
=============================================
What is dataretrieval?
-----------------------
dataretrieval is a python alternative to USGS-R's dataRetrieval package for
obtaining USGS or EPA water quality data, streamflow data, and metadata
directly from web services. Note that dataretrieval is an **alternantive** to the
R package, not a port, in that it reproduces and expands upon the functionality
of the R package but the organization and functionality often differs.
Here's an example of how to use dataretrievel to retrieve data from the National Water Information System (NWIS).
```python
# 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(site=site, service='iv', start='2017-12-31', end='2018-01-01')
# get water quality samples (qwdata)
df2 = nwis.get_record(site=site, service='qwdata', start='2017-12-31', end='2018-01-01')
# get basic info about the site
df3 = nwis.get_record(site=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
```python
nwis.get_record(site='03339000', service='dv', start='2017-12-31', parameterCd='00060')
```
will download daily data with the parameter code 00060 (discharge).
More services and documentation to come!
Quick start
-----------
dataretrieval can be installed using pip:
$ python3 -m pip install -U dataretrieval
If you want to run the latest version of the code, you can install from git:
$ python3 -m pip install -U git+git://github.com/USGS-python/dataretrieval.git
Issue tracker
-------------
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.
Help wanted
-----------
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](CONTRIBUTING.md).
[![Coverage Status](https://coveralls.io/repos/github/thodson-usgs/data_retrieval/badge.svg?branch=master)](https://coveralls.io/github/thodson-usgs/data_retrieval?branch=master)
=============================================
What is dataretrieval?
-----------------------
dataretrieval is a python alternative to USGS-R's dataRetrieval package for
obtaining USGS or EPA water quality data, streamflow data, and metadata
directly from web services. Note that dataretrieval is an **alternantive** to the
R package, not a port, in that it reproduces and expands upon the functionality
of the R package but the organization and functionality often differs.
Here's an example of how to use dataretrievel to retrieve data from the National Water Information System (NWIS).
```python
# 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(site=site, service='iv', start='2017-12-31', end='2018-01-01')
# get water quality samples (qwdata)
df2 = nwis.get_record(site=site, service='qwdata', start='2017-12-31', end='2018-01-01')
# get basic info about the site
df3 = nwis.get_record(site=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
```python
nwis.get_record(site='03339000', service='dv', start='2017-12-31', parameterCd='00060')
```
will download daily data with the parameter code 00060 (discharge).
More services and documentation to come!
Quick start
-----------
dataretrieval can be installed using pip:
$ python3 -m pip install -U dataretrieval
If you want to run the latest version of the code, you can install from git:
$ python3 -m pip install -U git+git://github.com/USGS-python/dataretrieval.git
Issue tracker
-------------
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.
Help wanted
-----------
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](CONTRIBUTING.md).
[![Coverage Status](https://coveralls.io/repos/github/thodson-usgs/data_retrieval/badge.svg?branch=master)](https://coveralls.io/github/thodson-usgs/data_retrieval?branch=master)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dataretrieval-0.1.tar.gz
(12.9 kB
view hashes)
Built Distribution
Close
Hashes for dataretrieval-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebb6b66172b6e9d06fb827863eefc9420920224aa709fb207a9d9cc7100f3b09 |
|
MD5 | ac0e58445dbc3ae0c3a6665135251ac6 |
|
BLAKE2b-256 | 32984bfb8d7e05d7d3c63279046992eb788fe7b24c449138fd4c52aa21720432 |