API Summary

metadata

The metadata module provides higher-level information on all aspects of pywatershed.

meta	The metadata module.

Control

Control(start_time, end_time, time_step[, ...])

Control manages global time and options, and provides metadata.

Parameters

Parameter classes.

Parameters([dims, coords, data_vars, ...])	Parameter base class
parameters.PrmsParameters([dims, coords, ...])	A parameter class with methods for native PRMS files.
parameters.StarfitParameters(dims, coords, ...)	Starfit parameter class

adapter

The adapter module adapts various inputs to a common interface for pywatershed inputs.

adapter_factory(var[, variable_name, ...])	A function to return the appropriate subclass of Adapter
Adapter(variable)	Adapter base class for getting data from a variety of sources.
AdapterNetcdf(fname, variable, dim_sizes, ...)	Adapter subclass for a NetCDF file

Atmosphere

Atmospheric process models.

PRMSSolarGeometry(control, discretization, ...)	PRMS solar geometry.
PRMSAtmosphere(control, discretization, ...)	PRMS atmospheric boundary layer model.

Hydrology

Hydrologic model components.

PRMSCanopy(control, discretization, ...[, ...])	PRMS canopy class.
PRMSSnow(control, discretization, ...[, ...])	PRMS snow pack.
PRMSRunoff(control, discretization, ...[, ...])	PRMS surface runoff.
PRMSSoilzone(control, discretization, ...[, ...])	PRMS soil zone.
PRMSGroundwater(control, discretization, ...)	PRMS groundwater reservoir.
PRMSChannel(control, discretization, ...[, ...])	PRMS channel flow (muskingum_mann).
Starfit(control, discretization, parameters, ...)	starfit: Storage Targets And Release Function Inference Tool

Model

Model(process_list_or_model_dict[, control, ...])

Build a model in pywatershed.

Base Classes

Base classes for the modeling system.

base.Accessor()	A base class for dict access on self.
base.DatasetDict([dims, coords, data_vars, ...])	DatasetDict: a data model following NetCDF-like conventions
base.Budget(control, inputs, outputs, ...[, ...])	Budget class for mass and energy conservation.
base.Process(control, discretization, parameters)	Base class for physical process representation.
base.ConservativeProcess(control, ...[, ...])	Base class for representation of conservative physical processes.

Utils

ControlVariables(control_dict)	PRMS control file class
utils.cbh_file_to_netcdf(input_file, ...[, ...])	Convert PRMS native CBH files to NetCDF format for pywatershed