pywatershed.PRMSStreamTemp

class pywatershed.PRMSStreamTemp(control, discretization, parameters, seg_outflow, seg_lateral_inflow, swrad, potet, sroff, ssres_flow, gwres_flow, tavgc, snowmelt, hru_rain, soltab_potsw, seg_flow_width=None, seg_flow_depth=None, seg_flow_area=None, seg_flow_velocity=None, stream_shade=None, stream_shade_class=None, stream_shade_parameters=None, calc_method=None, imbalance_behavior='defer', input_aliases=None, verbose=False, use_vectorized_shade=True, track_energy_fluxes=True, atmos_exchange_factor=1.0)

PRMS stream temperature with monthly segment humidity parameter.

Corresponds to strmtemp_humidity_flag=1 where humidity is supplied via the seg_humidity parameter (12 monthly values per segment) rather than a time-varying CBH input. All other behaviour is identical to PRMSStreamTempHumidityCBH.

Parameters:

• control (Control) – a Control object

• discretization (Parameters) – a discretization of class Parameters

• parameters (Parameters) – a parameter object of class Parameters — must include seg_humidity with shape (nmonth, nsegment)

• seg_outflow (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Streamflow leaving each segment (from PRMSChannel)

• seg_lateral_inflow (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Lateral inflow entering each segment

• swrad (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Solar radiation for each HRU

• potet (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Potential ET for each HRU

• sroff (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Surface runoff for each HRU

• ssres_flow (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Subsurface flow for each HRU

• gwres_flow (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Groundwater flow for each HRU

• tavgc (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Average air temperature for each HRU in Celsius

• snowmelt (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Snowmelt for each HRU

• hru_rain (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Rainfall for each HRU

• soltab_potsw (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Potential shortwave radiation table for current day

• seg_flow_width (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Flow-dependent width from PRMSHydraulicGeometryFull

• seg_flow_depth (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Flow-dependent depth from PRMSHydraulicGeometryFull

• seg_flow_area (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Flow-dependent cross-sectional area

• seg_flow_velocity (Union[str, Path, ndarray, Adapter, PrmsDynamicParameter]) – Flow-dependent velocity

• stream_shade (Optional[PRMSStreamShade]) – PRMSStreamShade instance

• stream_shade_class (Optional[type]) – Class to use for stream shade computation

• stream_shade_parameters (Union[Parameters, Path, None]) – Parameters for stream shade computation

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

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

• use_vectorized_shade (bool) – Use vectorized shade computation

• track_energy_fluxes (bool) – Track energy flux terms for budget analysis

__init__(control, discretization, parameters, seg_outflow, seg_lateral_inflow, swrad, potet, sroff, ssres_flow, gwres_flow, tavgc, snowmelt, hru_rain, soltab_potsw, seg_flow_width=None, seg_flow_depth=None, seg_flow_area=None, seg_flow_velocity=None, stream_shade=None, stream_shade_class=None, stream_shade_parameters=None, calc_method=None, imbalance_behavior='defer', input_aliases=None, verbose=False, use_vectorized_shade=True, track_energy_fluxes=True, atmos_exchange_factor=1.0)

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()	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 energy budget terms for stream temperature.
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.
initialize_netcdf([output_dir, ...])	Initialize NetCDF output with energy flux tracking checks.
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, ...)	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

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

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.

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()

Get a tuple of dimension names for this Process.

Return type:

tuple

static get_energy_budget_terms()

Get energy budget terms for stream temperature.

Return type:

dict

Returns:

Dictionary with inputs, outputs, exchanges, and storage_changes for energy budget.

Notes

Energy fluxes are computed in Watts (J/s). The budget tracks: - Advective heat transport (upstream, lateral, outflow) - Surface energy exchange (solar, longwave, evaporation) - Internal sources (friction, groundwater conduction) - Bi-directional exchanges that can be gains or losses

Storage changes are empty because the kinematic wave assumption means water storage is constant - only temperature (and thus heat content) changes, which is captured by the balance of inputs and outputs.

Exchanges are net fluxes that can be positive (heat gain) or negative (heat loss) depending on temperature gradients: - convective_exchange: depends on air vs water temperature While it seems that the following could be exchanges, their current formulation restricts their sign and they have been categorized to match that pre-determined sign: - longwave_vegetation: net longwave exchange with vegetation - groundwater_conduction: depends on groundwater vs water temp

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.

Return type:

dict

static get_parameters()

Get a tuple of parameter names for this Process.

Return type:

tuple

static get_restart_variables()

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

Initialize NetCDF output with energy flux tracking checks.

This method overrides the parent class to add consistency checks for energy flux tracking.

Parameters:

• output_dir (Union[str, 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

• budget_args (dict) – arguments to pass to budget initialization

• output_vars (list) – list of variable names to output

• extra_coords (dict) – extra coordinates to add to the output

• addtl_output_vars (list) – additional output variables

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.

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.