pywrdrb.parameters.STARFITReservoirRelease

class pywrdrb.parameters.STARFITReservoirRelease(model, reservoir_name, storage_node, flow_parameter, run_starfit_sensitivity_analysis, sensitivity_analysis_scenarios, **kwargs)

Custom Pywr Parameter used to implement the STARFIT-inferred reservoir operations policy at non-NYC reservoirs following Turner et al. (2021).

model

The PywrDRB model.

Type:

Model

storage_node

The storage node associated with the reservoir.

Type:

str

flow_parameter

The PywrDRB catchment inflow parameter corresponding to the reservoir.

value(timestep, scenario_index)

returns the STARFIT-inferred reservoir release for the current timestep and scenario index

__init__(model, reservoir_name, storage_node, flow_parameter, run_starfit_sensitivity_analysis, sensitivity_analysis_scenarios, **kwargs)

Methods

__init__(model, reservoir_name, ...)
after(self)
assign_starfit_param_values(starfit_params)	Assign STARFIT parameter values to the reservoir.
before(self)
calculate_percent_storage(storage)	Calculate the reservoir's current percentage of storage capacity.
calculate_release_adjustment(S_hat, I_hat, ...)	Calculate the release adjustment.
calculate_target_release(harmonic_release, ...)	Calculate the target release under current inflow and storage.
finish(self)
get_NORhi(timestep)	Get the upper-bound normalized reservoir storage of the Normal Operating Range (NORlo) for a given timestep.
get_NORlo(timestep)	Get the lower-bound normalized reservoir storage of the Normal Operating Range (NORlo) for a given timestep.
get_all_values(self)
get_constant_value(self)	Return a constant value.
get_double_lower_bounds(self)
get_double_upper_bounds(self)
get_double_variables(self)
get_harmonic_release(timestep)	Get the harmonic release for a given timestep.
get_integer_lower_bounds(self)
get_integer_upper_bounds(self)
get_integer_variables(self)
get_value(self, ScenarioIndex scenario_index)
load(model, data)	Set up the parameter.
load_default_starfit_params(model_data_dir)	Load default STARFIT parameters from istarf_conus.csv
load_starfit_sensitivity_samples(...)	Load STARFIT sensitivity samples from an HDF5 file.
register(cls)
reset(self)
set_double_variables(self, double[)
set_integer_variables(self, int[)
setup()	Set up the parameter.
standardize_inflow(inflow)	Standardize the current reservoir inflow based on historic average.
unregister(cls)
value(timestep, scenario_index)	Get the reservoir release for a given timestep and scenario index.

Attributes

children
comment	unicode
double_size	'int'
integer_size	'int'
is_constant
is_variable	'bool'
model
name
parents
size
tags	dict