Lab-0034

NWIS Data Component

Model
NWIS Data Component

Duration
1.0 hrs

Updated
2023-06-12

Download
download

Run online using:

Jupyter
Lab

Contributor(s)

Tian Gan at INSTAAR - University of Colorado Boulder.

Introduction

bmi_nwis package (https://github.com/gantian127/bmi_nwis) is an implementation of the Basic Model Interface (BMI) for the USGS NWIS dataset (https://waterdata.usgs.gov/nwis). This package uses the dataretrieval package (https://github.com/USGS-python/dataretrieval) to download the NWIS dataset and wraps the dataset with Basic Model Interface (BMI) for data control and query.

Classroom organization
In this lab, you will learn how to use the bmi_era5 package to download the instantaneous datasets at the USGS Gage.

Learning objectives
Skills

Learn to use an application programming interface (API) to access NWIS data
Learn to use Basic Model Interface to access NWIS data and metadata

Key concepts

CSDMS Data Component

Lab notes

This lab can be run on the lab (for educators) and jupyter (for general use) instances of the OpenEarthscape JupyterHub: just click one of the links under the Run online using heading at the top of this page, then run the notebook in the "CSDMS" kernel.

If you don't already have a JupyterHub account, follow the instructions to sign up at https://csdms.colorado.edu/wiki/JupyterHub. If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk: https://csdms.github.io/help-desk.

Requirements
If run locally, see instructions at https://github.com/gantian127/bmi_nwis

Acknowledgements
This work is supported by the National Science Foundation under Award No. 2026951, EarthCube Capabilities: Cloud-Based Accessible and Reproducible Modeling for Water and Sediment Research.

References

Tucker, G. E., Hutton, E. W. H., Piper, M. D., Campforts, B., Gan, T., Barnhart, K. R., Kettner, A. J., Overeem, I., Peckham, S. D., McCready, L., and Syvitski, J., 2022: CSDMS: a community platform for numerical modeling of Earth surface processes, Geosci. Model Dev., 15, 1413–1439, https://doi.org/10.5194/gmd-15-1413-2022.