Checking for non-preferred file/folder path names (may take a long time depending on the number of files/folders) ...

Jupyter Notebooks for the NWIS Data Component

Owners: This resource does not have an owner who is an active HydroShare user. Contact CUAHSI ( for information on this resource.
Type: Resource
Storage: The size of this resource is 20.4 KB
Created: Apr 01, 2021 at 3:10 a.m.
Last updated: Jun 21, 2023 at 9:48 p.m.
Citation: See how to cite this resource
Sharing Status: Public
Views: 567
Downloads: 25
+1 Votes: Be the first one to 
Comments: No comments (yet)


This resource includes two Jupyter Notebooks as a quick start tutorial for the NWIS Data Component of the PyMT modeling framework ( developed by Community Surface Dynamics Modeling System (CSDMS

The 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 BMI for data control and query. This package is not implemented for people to use but is the key element to convert the NWIS dataset into a data component for the PyMT modeling framework.

The pymt_nwis package is implemented for people to use as a reusable, plug-and-play NWIS data component for the PyMT modeling framework. This package uses the BMI implementation from the bmi_nwis package and allows the NWIS datasets to be easily coupled with other datasets or models that expose a BMI.

HydroShare users can test and run the Jupyter Notebooks (bmi_nwis.ipynb, pymt_nwis.ipynb) directly through the "CUAHSI JupyterHub" web app with the following steps:
- For the new user of the CUAHSI JupyterHub, please first make a request to join the "CUAHSI Could Computing Group" ( After approval, the user will gain access to launch the CUAHSI JupyterHub.
- Click on the "Open with" button. (on the top right corner of the page)
- Select "CUAHSI JupyterHub".
- Select "CSDMS Workbench" server option. (Make sure to select the right server option. Otherwise, the notebook won't run correctly.)

If there is any question or suggestion about the NWIS data component, please create a github issue at

Subject Keywords


Related Resources

This resource belongs to the following collections:
Title Owners Sharing Status My Permission
PyMT model and data components example Tian Gan  Public &  Shareable Open Access

How to Cite

Gan, T. (2023). Jupyter Notebooks for the NWIS Data Component, HydroShare,

This resource is shared under the Creative Commons Attribution CC BY.


There are currently no comments

New Comment