pywatershed.PRMSCanopy

class pywatershed.PRMSCanopy(control, discretization, parameters, pk_ice_prev, freeh2o_prev, transp_on, hru_ppt, hru_rain, hru_snow, potet, budget_type=None, calc_method=None, verbose=None)

PRMS canopy class.

A canopy or vegetation representation from PRMS.

Implementation based on PRMS 5.2.1 with theoretical documentation given in the PRMS-IV documentation:

Markstrom, S. L., Regan, R. S., Hay, L. E., Viger, R. J., Webb, R. M., Payn, R. A., & LaFontaine, J. H. (2015). PRMS-IV, the precipitation-runoff modeling system, version 4. US Geological Survey Techniques and Methods, 6, B7.

Parameters:

• control (Control) – a Control object

• discretization (Parameters) – a discretization of class Parameters

• parameters (Parameters) – a parameter object of class Parameters

• pk_ice_prev (Union[str, Path, ndarray, Adapter]) – Previous snowpack ice on each HRU

• freeh2o_prev (Union[str, Path, ndarray, Adapter]) – Previous snowpack free water on each HRU

• transp_on (Union[str, Path, ndarray, Adapter]) – Flag indicating whether transpiration is occurring (0=no;1=yes)

• hru_ppt (Union[str, Path, ndarray, Adapter]) – Precipitation on each HRU

• hru_rain (Union[str, Path, ndarray, Adapter]) – Rain on each HRU

• hru_snow (Union[str, Path, ndarray, Adapter]) – Snow on each HRU

• budget_type (Optional[Literal[None, 'warn', 'error']]) – one of [None, “warn”, “error”]

• calc_method (Optional[Literal['fortran', 'numba', 'numpy']]) – one of [“fortran”, “numba”, “numpy”]. None defaults to “numba”.

• verbose (Optional[bool]) – Print extra information or not?

• load_n_time_batches – not-implemented

__init__(control, discretization, parameters, pk_ice_prev, freeh2o_prev, transp_on, hru_ppt, hru_rain, hru_snow, potet, budget_type=None, calc_method=None, verbose=None)

Methods

__init__(control, discretization, ...[, ...])
advance()	Advance the Process in time.
calculate(time_length, **kwargs)	Calculate Process terms for a time step
description()	A dictionary description of this Process.
finalize()	Finalizes the Process, including output methods.
get_dimensions()	Get a tuple of dimension names for this Process.
get_init_values()	Get a dictionary of initialization values for each public variable.
get_inputs()	Get a tuple of input variable names for this Process.
get_mass_budget_terms()	Get a dictionary of variable names for mass budget terms.
get_parameters()	Get a tuple of parameter names for this Process.
get_restart_variables()	Get a list of restart varible names.
get_variables()	Get a tuple of (public) variable names for this Process.
initialize_netcdf([output_dir, ...])	Initialize NetCDF output.
output()	Output data to previously initialized output types.
output_to_csv(pth)	Save each output variable to separate csv file in specified path
set_input_to_adapter(input_variable_name, ...)
update_net_precip(precip, stor_max, covden, ...)

Attributes

dimensions	A tuple of parameter names.
init_values	A dictionary of initial values for each public variable.
inputs	A tuple of input variable names.
mass_budget_terms	A dictionary of variable names for the mass budget terms.
parameters	A tuple of parameter names.
restart_variables	A tuple of restart variable names.
variables	A tuple of public variable names.

advance()

Advance the Process in time.

Returns:

None

calculate(time_length, **kwargs)

Calculate Process terms for a time step

Parameters:

simulation_time – current simulation time

Return type:

None

Returns:

None

classmethod description()

A dictionary description of this Process.

Return type:

dict

Returns:

All metadata for all variables in inputs, variables,parameters, and mass_budget_terms for this Process.

property dimensions: tuple

A tuple of parameter names.

finalize()

Finalizes the Process, including output methods. :rtype: None :returns: None

static get_dimensions()

Get a tuple of dimension names for this Process.

Return type:

tuple

static get_init_values()

Get a dictionary of initialization values for each public variable.

Return type:

dict

static get_inputs()

Get a tuple of input variable names for this Process.

Return type:

tuple

static get_mass_budget_terms()

Get a dictionary of variable names for mass budget terms.

static get_parameters()

Get a tuple of parameter names for this Process.

Return type:

tuple

static get_restart_variables()

Get a list of restart varible names.

Return type:

list

classmethod get_variables()

Get a tuple of (public) variable names for this Process.

Return type:

tuple

property init_values: dict

A dictionary of initial values for each public variable.

initialize_netcdf(output_dir=None, separate_files=None, budget_args=None, output_vars=None)

Initialize NetCDF output.

Parameters:

• output_dir – base directory path or NetCDF file path if separate_files is True

• separate_files – boolean indicating if storage component output variables should be written to a separate file for each variable

• output_vars – list of variable names to outuput.

Returns:

None

property inputs: tuple

A tuple of input variable names.

property mass_budget_terms: dict

A dictionary of variable names for the mass budget terms.

output()

Output data to previously initialized output types. :rtype: None :returns: None

output_to_csv(pth)

Save each output variable to separate csv file in specified path

property parameters: tuple

A tuple of parameter names.

property restart_variables: tuple

A tuple of restart variable names.

set_input_to_adapter(input_variable_name, adapter)

static update_net_precip(precip, stor_max, covden, intcp_stor, net_precip, idx)

property variables: tuple

A tuple of public variable names.