Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,16 +125,16 @@ Access water quality data from multiple agencies:
```python
from dataretrieval import wqp

# Find water quality monitoring sites
sites = wqp.what_sites(
# Find water quality monitoring sites (returns a DataFrame and metadata)
sites, metadata = wqp.what_sites(
statecode='US:55', # Wisconsin
siteType='Stream'
)

print(f"Found {len(sites)} stream monitoring sites in Wisconsin")

# Get water quality results
results = wqp.get_results(
results, metadata = wqp.get_results(
siteid='USGS-05427718',
characteristicName='Temperature, water'
)
Expand Down
17 changes: 8 additions & 9 deletions docs/source/meta/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,9 @@ Installation Guide

Whether you are a user or developer we recommend installing ``dataretrieval``
in a virtual environment. This can be done using something like ``virtualenv``
or ``conda``. Package dependencies are listed in the `requirements.txt`_ file,
a full list of dependencies necessary for development are listed in the
`requirements-dev.txt`_ file.

.. _requirements.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/main/requirements.txt

.. _requirements-dev.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/main/requirements-dev.txt
or ``conda``. Package dependencies are declared in ``pyproject.toml``: the core
runtime dependencies under ``[project.dependencies]``, and optional extras
(``test``, ``doc``, ``nldi``) under ``[project.optional-dependencies]``.


User Installation
Expand Down Expand Up @@ -59,8 +55,11 @@ the package for development:

.. code-block:: bash

$ pip install -r requirements-dev.txt
$ pip install -e .
$ pip install -e ".[test,doc,nldi]"

This installs ``dataretrieval`` in editable mode along with the development
extras: ``test`` (test runner), ``doc`` (documentation build), and ``nldi``
(``geopandas``, required by the NLDI module).

To check your installation you can run the tests with the following commands:

Expand Down
Loading