NWSRFSpy

nwsrfs_py is a Python interface to NWSRFS hydrologic models using f2py wrappers around FORTRAN implementations.

It is designed to support NWRFC autocalibration workflows and provides classes for simulation and AdjustQ operations. Sample calibration data is archived on Zenodo.

Install (PyPI)

pip install nwsrfspy

Quick Start

from nwsrfs_py import simulation

# Load packaged example data
model_run = simulation.NwsrfsRun.load_example("NRKW1")

# Simulated streamflow series
sim_flow = model_run.sim
print(sim_flow.head())

Included Model Components

• SAC-SMA + SNOW-17 (SacSnow)
• UNIT-HG (GammaUh)
• LAG-K (Lagk)
• CHANLOSS (Chanloss)
• CONS_USE (Consuse)

Documentation

Python docs: https://NOAA-NWRFC.github.io/nwsrfs-hydro-models/python/

Attribution

nwsrfs_py packages and wraps legacy NWSRFS FORTRAN components together with newer support modules.

Detailed source provenance, contributor attribution, and third-party license notices are documented in COPYRIGHTS.

Current package maintainers are Geoffrey Walters and Cameron Bracken.

Build From Source (Developers)

Source builds require a Fortran toolchain plus build tools.

Requirements:

• Python 3.10+
• numpy, pandas, scipy
• gfortran
• meson, meson-python, ninja

Using pixi (recommended)

From repository root:

pixi run install-py

Using conda

conda create -n nwsrfs_env python=3.10
conda activate nwsrfs_env
conda install -c conda-forge fortran-compiler meson meson-python ninja

Install from source:

git clone https://github.com/NOAA-NWRFC/nwsrfs-hydro-models.git
cd nwsrfs-hydro-models/nwsrfs_py
pip install .
python -c "import nwsrfs_py; print('Success!')"

Editable install:

pip install -e . --no-build-isolation -v

For runnable scripts in the source tree, see examples/.

Citation

If you use this package, please cite:

Walters, G., Bracken, C., Gillies, B., et al. 2026. "A Comprehensive Calibration Framework for the Northwest River Forecast Center." JAWRA Journal of the American Water Resources Association 62(2): e70112. https://doi.org/10.1111/1752-1688.70112