pywatershed.PRMSRunoff

pywatershed.PRMSRunoff#

class pywatershed.PRMSRunoff(control, discretization, parameters, soil_lower_prev, soil_rechr_prev, net_ppt, net_rain, net_snow, potet, snowmelt, snow_evap, pkwater_equiv, pptmix_nopack, snowcov_area, through_rain, hru_intcpevap, intcp_changeover, dprst_flag=None, intcp_changeover_in_net_rain=False, imbalance_behavior='defer', calc_method=None, input_aliases=None, verbose=None, restart_read=False, restart_write=False, restart_write_freq=False)[source]#

PRMS surface runoff.

A surface runoff 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
soil_lower_prev (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Previous storage of lower reservoir for each HRU
soil_rechr_prev (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Previous storage of recharge reservoir for each HRU
net_ppt (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Precipitation (rain and/or snow) that falls through the canopy for each HRU
net_rain (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Rain that falls through canopy for each HRU
net_snow (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Snow that falls through canopy for each HRU
potet (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Potential ET for each HRU
snowmelt (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Snowmelt from snowpack on each HRU
snow_evap (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Evaporation and sublimation from snowpack on each HRU
pkwater_equiv (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Snowpack water equivalent on each HRU
pptmix_nopack (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Flag indicating that a mixed precipitation event has occurred with no snowpack
snowcov_area (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Snow-covered area on each HRU prior to melt and sublimation unless snowpack
through_rain (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Rain that passes through snow when no snow present
hru_intcpevap (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – HRU area-weighted average evaporation from the canopy for each HRU
intcp_changeover (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Canopy throughfall caused by canopy density change from winter to summer
dprst_flag (Optional[bool]) – use depression storage or not? None uses value in control file, which otherwise defaults to True.
intcp_changeover_in_net_rain (bool) – Boolean flag indicating whether intcp_changeover is included in net rain (GSFLOW 4.2.0 and PRMS 6.0.0) or not (pywatershed and PRMS < 6.0.0).
imbalance_behavior (Literal['defer', None, 'warn', 'error']) – one of [“defer”, None, “warn”, “error”] with “defer” being the default and defering to control.options[“imbalance_behavior”] when available. When control.options[“imbalance_behavior”] is not avaiable, imbalance_behavior is set to “warn”.
calc_method (Literal['numba', 'numpy', None]) – one of [“numba”, “numpy”]. None defaults to “numba”.
verbose (Optional[bool]) – Print extra information or not?
restart_read (Union[Path, bool]) – May be boolean or a Pathlib.Path. If False, control.options will be examined for this key. If True, the working directory is searched for restart files. If a Pathlib.Path, this specifies an alternative directory to search for restart files. Files searched for are of the pattern YYYY-mm-dd-varname.nc where the date is the control.init_time. The timestamp on the file is the valid time of the states in the file with the exception of processes with sub-daily timesteps. For example, the outflow_ts variable of PRMSChannel is instantaneous and valid at the 23rd hour of the timestampped day whereas its variable seg_outflow is the daily averge value over the timestampped day.
restart_write (Union[Path, bool]) – As for restart_read but for writing. The directory in either case will be attempted to be created if it does not exist.
restart_write_freq (Literal['y', 'm', 'd', 'f', False]) – If False, then control.options is examined for this key. The follwing values set the frequency of restart output with “y” for yearly, “m” for monthly, “d” for daily, or “f” for final. “Final” means that restart files are written with the states at control.end_time to files timestampped with control.end_time. Yearly and monthly restart options write files with timestamps on the last day of each year or month during the run. If daily, restarts are written every day. If restart_write is not False and restart_write_freq is False, the default of “f” is used.

__init__(control, discretization, parameters, soil_lower_prev, soil_rechr_prev, net_ppt, net_rain, net_snow, potet, snowmelt, snow_evap, pkwater_equiv, pptmix_nopack, snowcov_area, through_rain, hru_intcpevap, intcp_changeover, dprst_flag=None, intcp_changeover_in_net_rain=False, imbalance_behavior='defer', calc_method=None, input_aliases=None, verbose=None, restart_read=False, restart_write=False, restart_write_freq=False)[source]#

Methods

`__init__`(control, discretization, ...[, ...])
`advance`()	Advance the Process in time.
`basin_init`()	This is trying to replicate the prms basin.f90/basinit() function that calculates some of the variables needed here by runoff.
`calculate`(time_length, **kwargs)	Calculate Process terms for a time step
`check_capacity`(soil_moist_prev, ...)	Fill soil to soil_moist_max, if more than capacity restrict infiltration by snowinfil_max, with excess added to runoff
`compute_infil`(contrib_fraction, ...)
`description`()	A dictionary description of this Process.
`dprst_comp`(dprst_vol_clos, ...)
`dprst_init`()
`finalize`()	Finalize the Process, output methods, and close input adapters.
`get_dimensions`()	Get a tuple of dimension names for this Process.
`get_energy_budget_terms`()	Get a dictionary of variable names for energy budget terms.
`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`()	A list of restart varible names.
`get_variables`()	Get a tuple of (public) variable names for this Process.
`imperv_et`(imperv_stor, potet, imperv_evap, ...)
`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
`perv_comp`(soil_moist_prev, carea_max, ...)	Pervious area computations.
`set_input_to_adapter`(input_variable_name, ...)	Set input variables to adapter.current and manage the adapter.

Attributes

`budget`	Legacy property for backward compatibility - returns mass budget.
`dimensions`	A tuple of parameter names.
`energy_budget`	The energy budget for this process, if enabled.
`energy_budget_terms`	A dictionary of variable names for the energy budget terms.
`init_values`	A dictionary of initial values for each public variable.
`inputs`	A tuple of input variable names.
`mass_budget`	The mass budget for this process, if enabled.
`mass_budget_terms`	A dictionary of variable names for the mass budget terms.
`parameters`	A tuple of parameter names.
`restart_variables`	previous.
`variables`	A tuple of public variable names.

advance()#

Advance the Process in time.

Returns:: None

basin_init()[source]#: This is trying to replicate the prms basin.f90/basinit() function that calculates some of the variables needed here by runoff. This should probably go somewhere else at some point as I suspect other components may need similar information.

property budget#: Legacy property for backward compatibility - returns mass budget.

Deprecated since version The: ‘budget’ property is deprecated. Use ‘mass_budget’ instead.

calculate(time_length, **kwargs)#

Calculate Process terms for a time step

Parameters:: simulation_time – current simulation time
Return type:: None
Returns:: None

static check_capacity(soil_moist_prev, soil_moist_max, snowinfil_max, infil, srp)[source]#: Fill soil to soil_moist_max, if more than capacity restrict infiltration by snowinfil_max, with excess added to runoff

static compute_infil(contrib_fraction, soil_moist_prev, soil_moist_max, carea_max, smidx_coef, smidx_exp, pptmix_nopack, net_rain, net_ppt, imperv_stor, imperv_stor_max, snowmelt, snowinfil_max, net_snow, pkwater_equiv, infil, hru_type, intcp_changeover, hruarea_imperv, sri, srp, check_capacity, perv_comp, through_rain, intcp_changeover_in_net_rain)[source]#

classmethod description()#

A dictionary description of this Process.

Return type:: dict
Returns:: All metadata for all variables in inputs, variables, parameters, mass_budget_terms, and energy_budget_terms for this Process.

property dimensions: tuple#: A tuple of parameter names.

static dprst_comp(dprst_vol_clos, dprst_area_clos_max, dprst_area_clos, dprst_vol_open_max, dprst_vol_open, dprst_area_open_max, dprst_sroff_hru, sro_to_dprst_perv, sro_to_dprst_imperv, dprst_evap_hru, pptmix_nopack, snowmelt, pkwater_equiv, net_snow, hru_area, dprst_insroff_hru, dprst_frac_open, dprst_frac_clos, va_open_exp, dprst_vol_clos_max, dprst_vol_clos_frac, va_clos_exp, potet, snowcov_area, dprst_et_coef, dprst_seep_rate_open, dprst_vol_thres_open, dprst_flow_coef, dprst_seep_rate_clos, avail_et, net_rain, dprst_in, srp, sri, imperv_frac, perv_frac)[source]#

dprst_init()[source]#

property energy_budget#: The energy budget for this process, if enabled.

property energy_budget_terms: dict#: A dictionary of variable names for the energy budget terms.

finalize()#

Finalize the Process, output methods, and close input adapters.

Return type:: None
Returns:: None

static get_dimensions()[source]#

Get a tuple of dimension names for this Process.

Return type:: tuple

classmethod get_energy_budget_terms()#

Get a dictionary of variable names for energy budget terms.

Return type:: dict

static get_init_values()[source]#

Get a dictionary of initialization values for each public variable.

Return type:: dict

static get_inputs()[source]#

Get a tuple of input variable names for this Process.

Return type:: tuple

static get_mass_budget_terms()[source]#: Get a dictionary of variable names for mass budget terms.

static get_parameters()[source]#

Get a tuple of parameter names for this Process.

Return type:: tuple

static get_restart_variables()[source]#

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

static imperv_et(imperv_stor, potet, imperv_evap, sca, avail_et, imperv_frac)[source]#

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, extra_coords=None, addtl_output_vars=None)#

Initialize NetCDF output.

Parameters:

output_dir ([<class ‘str’>, <class ‘pathlib.Path’>]) – base directory path or NetCDF file path if separate_files is True
separate_files (bool) – boolean indicating if storage component output variables should be written to a separate file for each variable
output_vars (list) – list of variable names to output.

Return type:

None

Returns:

None

property inputs: tuple#: A tuple of input variable names.

property mass_budget#: The mass budget for this process, if enabled.

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.

static perv_comp(soil_moist_prev, carea_max, smidx_coef, smidx_exp, pptp, ptc, infil, srp)[source]#: Pervious area computations.

property restart_variables: dict#

previous.

Type:: A dict of restart variable names mapping current

set_input_to_adapter(input_variable_name, adapter)#

Set input variables to adapter.current and manage the adapter.

TODO: make this private?

Parameters:

input_variable_name (str) – key of input variable
adapter (Adapter) – the Adapter for the input.

property variables: tuple#: A tuple of public variable names.

pywatershed.PRMSRunoff

Contents

pywatershed.PRMSRunoff#