NWIS Data Component

1.0 hrs
Run online using:
  1. Jupyter
  2. Lab
     Jupyter logo.png

    Tian Gan at INSTAAR - University of Colorado Boulder.

bmi_nwis package ( is an implementation of the Basic Model Interface (BMI) for the USGS NWIS dataset ( This package uses the dataretrieval package ( 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_nwis package to download the instantaneous datasets at the USGS Gage and then create time series plots for stream flow and gage height.

Learning objectives
  • Learn to use dataretrieval package 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 If you're an educator, you can get JupyterHub accounts for students--please contact us through the CSDMS Help Desk:

If run locally, see instructions at

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.

  • 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,
  • Gan, T., Tucker, G.E., Hutton, E.W.H., Piper, M.D., Overeem, I., Kettner, A.J., Campforts, B., Moriarty, J.M., Undzis, B., Pierce, E., McCready, L., 2024: CSDMS Data Components: data–model integration tools for Earth surface processes modeling. Geosci. Model Dev., 17, 2165–2185.