Introduction

This resource contains Jupyter Notebooks that serve as examples of how to use the USGS dataretrieval Python package to retrieve data from the United States Geological Survey's National Water Information System. These notebooks can either be downloaded and run in your local environment, or they can be launched into the CUAHSI JupyterHub server. The following notebooks are provided:

• USGS_dataretrieval_DailyValues_Examples.ipynb: This notebook demonstrates how to use the get_dv() function to retrieve daily values (e.g., daily streamflow values) for USGS monitoring sites.
• USGS_dataretrieval_GroundwaterLevels_Examples.ipynb: This notebook demonstrates how to use the get_gwlevels() function to retrieve groundwater level data for USGS monitoring sites.
• USGS_dataretrieval_Measurements_Examples.ipynb: This notebook demonstrates how to use the get_discharge_measurements() function to retrieve surface water discharge measurements for USGS monitoring sites.
• USGS_dataretrieval_NLDI_Examples.ipynb: This notebook demonstrations how to use multiple functions to access data from the USGS Hydro Network-Linked Data Index (NLDI).
• USGS_dataretrieval_ParameterCodes_examples.ipynb: This notebook demonstrates how to use the get_pmcodes() function to retrieve information about USGS NWIS parameter codes.
• USGS_dataretrieval_Peaks_examples.ipynb: This notebook demonstrates how to use the get_discharge_peaks() function to retrieve peack discharge data for USGS NWIS monitoring sites.
• USGS_dataretrieval_Ratings_Examples.ipynb: This notebook demonstrates how to use the get_ratings() function to retrieve rating curve data for USGS monitoring sites.
• USGS_dataretrieval_SiteInfo_Examples.ipynb: This notebook demonstrates how to use the get_info() function to retrieve information about a USGS monitoring site.
• USGS_dataretrieval_SiteInventory_Examples.ipynb: This notebook demonstrates how to use the what_sites() function to search NWIS for sites within a region with specific data.
• USGS_dataretrieval_Statistics_Examples.ipynb: This notebook demonstrate how to use the get_stats() function to retrieve site statistics for USGS monitoring sites.
• USGS_dataretrieval_UnitValues_Examples.ipynb: This notebook demonstrates how to use the get_iv() function to retrieve instantaneous (unit) value data for USGS monitoring sites.
• USGS_dataretrieval_WaterSamples_Examples.ipynb: This notebook demonstrates how to use the get_qwdata() function to retrieve water quality sample data for USGS monitoring sites.
• USGS_dataretrieval_WaterUse_Examples.ipynb: This notebook demonstrates how to use the get_water_use() function to retrieve water use data.

Run these Notebooks Locally

If you want to run these notebooks locally on your machine, you will need to be set up to run Jupyter notebooks. If you need help setting up Jupyter to run notebooks, you can consult the Jupyter/IPython Notebook Quick Start Guide.

There are also Python Interactive Development Environments (IDEs) like PyCharm that have support for creating, editing, and running Jupyter Notebooks.

Run these Notebooks on the CUAHSI JupyterHub Server

CUAHSI maintains a HydroShare linked JupyterHub server on which you can run these notebooks. To run these notebooks using CUAHSI's JupyterHub Server, do the following:

1. Make sure you have a HydroShare user account and then join the CUAHSI Cloud Computing group in HydroShare.
2. Make sure you are logged into HydroShare and then click on the "Open with" button at the top of this resource's landing page and select "CUAHSI JupyterHub."
3. If prompted, agree to the terms of use and click the "Sign in with HydroShare" button. You will need to click the "Authorize" button to authorize CUAHSI JupyterHub to interact with your HydroShare account.
4. Once your content has been copied to the CUAHSI JupyterHub server (this may take a couple of minutes), click on the name of the notebook you want to execute.
5. This will launch the Jupyter Notebook and you can execute it using the controls at the top of the notebook.