pownet.data_model package

pownet.data_model.reservoir module

reservoir.py

class pownet.data_model.reservoir.ReservoirParams(name, min_day, max_day, min_level, max_level, max_head, max_storage, max_release, max_generation, turbine_factor, inflow_ts, minflow_ts, upstream_units, downstream_flow_fracs)[source]

Data class to hold static parameters and initial timeseries data for a reservoir.

name

The unique name of the reservoir.

Type:

str

min_day

The day of the year when the target level is typically at its minimum.

Type:

int

max_day

The day of the year when the target level is typically at its maximum.

Type:

int

min_level

The minimum operational water level (meters).

Type:

float

max_level

The maximum operational water level (meters).

Type:

float

max_head

The maximum hydraulic head difference available for generation (meters).

Type:

float

max_storage

The maximum storage capacity of the reservoir (m³).

Type:

float

max_release

The maximum allowable daily release rate (m³/day).

Type:

float

max_generation

The maximum power generation capacity (MW).

Type:

float

turbine_factor

The efficiency factor of the turbine(s).

Type:

float

inflow_ts

Timeseries of daily natural inflow into the reservoir (m³/day), indexed from 1.

Type:

pd.Series

minflow_ts

Minimum environmental flow (m³/day), indexed from 1.

Type:

pd.Series

upstream_units

List of upstream reservoir names that feed into this reservoir.

Type:

list[str]

downstream_flow_fracs

Dictionary mapping downstream reservoir names to their respective flow fractions (0-1).

Type:

dict[str, float]