pywrdrb.parameters.PredictionEnsemble

pywrdrb.parameters.PredictionEnsemble#

class pywrdrb.parameters.PredictionEnsemble(model, column, inflow_type, ensemble_indices, **kwargs)#

This parameter provides access to an ensemble of flow prediction timeseries used to inform FFMP releases.

Parameters:
  • model (Model) – The Pywr model.

  • column (str) – The label of the prediction column.

  • inflow_type (str) – The dataset label; Options: ‘obs_pub_nhmv10_ObsScaled_ensemble’, ‘obs_pub_nwmv21_ObsScaled_ensemble’

  • ensemble_indices (list) – Indices of the inflow ensemble to be used.

  • **kwargs – Additional keyword arguments.

Returns:

None

__init__(model, column, inflow_type, ensemble_indices, **kwargs)#

Methods

__init__(model, column, inflow_type, ...)

after(self)

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(cls, model, data)

register(cls)

reset(self)

set_double_variables(self, double[)

set_integer_variables(self, int[)

setup()

Perform setup operations for the parameter.

unregister(cls)

value(timestep, scenario_index)

Return the current flow across scenarios for the specified 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