pywrdrb.parameters.IERQRelease_step1

class pywrdrb.parameters.IERQRelease_step1(model, bank, release_needed, **kwargs)

Tracks the Interim Excess Release Quantity (IERQ) release for the Trenton bank.

setup()

Allocates an array to hold the parameter state.

value(timestep, scenario_index)

Returns the current volume remaining for the scenario.

after()

Automatically called after the value() method to update the bank remaining volume.

load(model, data)

Standard method to load the parameter from a data dictionary.

model

The Pywr model dict.

Type:

Model

bank

The IERQ bank to track; options: “trenton”, “thermal”, “rapid_flow”, “nj_diversion”.

Type:

str

release_needed

The parameter that indicates the release needed for the bank.

Type:

pywr.Parameter

step

The step of the model (1 or 2).

Type:

int

bank_remaining

Array to hold the remaining volume for each scenario.

Type:

np.ndarray

bank_release

Array to hold the release for each scenario.

Type:

np.ndarray

datetime

Datetime index object.

Type:

pd.Timestamp

__init__(model, bank, release_needed, **kwargs)

Initalize the IERQRelease_step1 parameter.

Parameters:

• model (Model) – The Pywr model dict.

• bank (str) – The IERQ bank to track; options: “trenton”, “thermal”, “rapid_flow”, “nj_diversion”. Only “trenton” is implemented currently.

• release_needed (pywr.Parameter) – The parameter that indicates the release needed for the bank.

• kwargs (dict) – Other keyword arguments passed to the pwyr.Parameter class. None currently used.

Methods

__init__(model, bank, release_needed, **kwargs)	Initalize the IERQRelease_step1 parameter.
after()	Run automatically after the value() method to update the bank remaining volume.
before(self)
finish(self)
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_integer_lower_bounds(self)
get_integer_upper_bounds(self)
get_integer_variables(self)
get_value(self, ScenarioIndex scenario_index)
load(model, data)	Load the IERQRelease_step1 parameter from the model dictionary.
register(cls)
reset(self)
set_double_variables(self, double[)
set_integer_variables(self, int[)
setup()	Allocate arrays to hold the parameter state.
unregister(cls)
value(timestep, scenario_index)	Returns the current IERQ volume remaining for this year and scenario.

Attributes

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