pywatershed.base.ConservativeProcess

pywatershed.base.ConservativeProcess#

class pywatershed.base.ConservativeProcess(control, discretization, parameters, imbalance_behavior='defer', input_aliases=None, metadata_patches=None, metadata_patch_conflicts='error', restart_read=False, restart_write=False, restart_write_freq=False)[source]#

Base class for representation of conservative physical processes.

ConservativeProcess is a base class for mass and energy conservation which extends the Process() class with budgets for mass and/or energy. Please see Process() for many details on the design of this parent class. In ConservativeProcess both mass and energy conservation can be tracked. Budgets can optionally be established for mass and/or energy and these can be enforced or simply diagnosed with the model run.

Conventions are adopted through the use of the following properties/methods:

mass_budget_terms/get_mass_budget_terms():: These terms must all in in the same units across all components of the budget (inputs, outputs, storage_changes). Diagnostic variables should not appear in the budget terms, only prognostic variables should.
_calculate():: This method is to be overridden by the subclass. Near the end of the method, the subclass should calculate its changes in mass and energy storage in an obvious way. As commented for mass_budget_terms, storage changes should only be tracked for prognostic variables. (For example is snow_water_equiv = snow_ice + snow_liquid, then storage changes for snow_ice and snow_liquid should be tracked and not for snow_water_equiv).

Parameters:

control (Control) – A Control object
discretization (Parameters) – A discretization object
parameters (Parameters) – The parameters for this object
imbalance_behavior (one of [``”defer”, :obj:`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”.
metadata_patches (dict[dict]) – Override static metadata for any public parameter or variable – experimental.
metadata_patch_conflicts (Literal['left', 'warn', 'error']) – How to handle metadata_patches conflicts. Experimental.
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, imbalance_behavior='defer', input_aliases=None, metadata_patches=None, metadata_patch_conflicts='error', restart_read=False, restart_write=False, restart_write_freq=False)[source]#

Methods

`__init__`(control, discretization, parameters)
`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 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.
`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, ...)	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)[source]#

Calculate Process terms for a time step

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

classmethod description()[source]#

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()[source]#

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

classmethod get_energy_budget_terms()[source]#

Get a dictionary of variable names for energy budget terms.

Return type:: dict

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

classmethod get_mass_budget_terms()[source]#

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)[source]#

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()[source]#: 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)[source]#

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.base.ConservativeProcess

Contents

pywatershed.base.ConservativeProcess#