States

class rameau.core.states.States(h_thornthwaite=0.0, h_progressive=0.0, h_transfer=0.0, h_snow=0.0, r_snow=0.0, h_pump_riv=0.0, h_pump_gw=0.0, h_infl_gw=[], gm_pump_riv=0.0, gm_pump_gw=0.0, gm_infl_gw=[], h_groundwater=[0.0], q_local=[0.0, 0.0], q_outlet=[0.0, 0.0])[source]

Model states.

Parameters:

h_thornthwaite (float, optional) – Water level (mm) in the soil reservoir using the Thornthwaite method. See ThornthwaiteReservoir for details.
h_progressive (float, optional) – Water level (mm) in the soil reservoir using the GR3J method. See ProgressiveReservoir for details.
h_transfer (float, optional) – Water level (mm) in the transfer reservoir. See TransferReservoir for details.
h_snow (float, optional) – Snow water equivalent (mm) of the snow pack. See SnowReservoir for details.
h_pump_riv (float, optional)
h_pump_gw (float, optional)
h_infl_gw (List, optional)
gm_pump_riv (float, optional)
gm_pump_gw (float, optional)
gm_infl_gw (List, optional)
r_snow (float, optional) – Water retention (-) in the snow pack. See SnowReservoir for details.
h_groundwater (List, optional) – Water level (mm) in the groundwater reservoirs. See Groundwater for details.
q_local (List, optional) – Total water level (mm) produced locally.
q_outlet (List, optional) – Historical riverflow (\(m^{3}.s^{-1}\)) produced at the watershed outlet.

Returns:

States

Attributes

`gm_infl_gw`	Vector descriptor.
`gm_pump_gw`	Float descriptor.
`gm_pump_riv`	Float descriptor.
`h_groundwater`	Vector descriptor.
`h_infl_gw`	Vector descriptor.
`h_progressive`	Float descriptor.
`h_pump_gw`	Float descriptor.
`h_pump_riv`	Float descriptor.
`h_snow`	Float descriptor.
`h_thornthwaite`	Float descriptor.
`h_transfer`	Float descriptor.
`q_local`	Vector descriptor.
`q_outlet`	Vector descriptor.
`r_snow`	Float descriptor.