hydro

Classes:

Hydro –

Hydro object of modelling.
HydroAllocation –

Diagonal term of the hydro allocations matrix used during a heuristic pre-allocation process,
HydroProperties –

Hydro properties.
HydroPropertiesUpdate –

Update hydro properties.
InflowStructure –

The inflow structure.
InflowStructureUpdate –

Update the inflow structure.

Hydro

Hydro(
    service: BaseHydroService,
    area_id: str,
    properties: HydroProperties,
    inflow_structure: InflowStructure,
    allocation: list[HydroAllocation],
)

Hydro object of modelling.

Methods:

get_credit_modulations –

Get credit modulation.
get_energy –

Get energy.
get_inflow_pattern –

Get inflow pattern.
get_maxpower –

Get maximum power.
get_mingen –

Get minimum generation time-series.
get_mod_series –
get_reservoir –

Get reservoir levels.
get_ror_series –

Get run-of-river generation time-series.
get_water_values –

Get water values.
set_allocation –

Set allocation.
set_credits_modulation –

Set credit_modulation.
set_energy –

Set energy.
set_inflow_pattern –

Set inflow pattern.
set_maxpower –

Set maximum power.
set_mingen –

Set minimum generation series.
set_mod_series –

Set modulation series.
set_reservoir –

Set reservoir.
set_ror_series –

Set run-of-river generation series.
set_water_values –

Set water values.
update_inflow_structure –

Update inflow structure.
update_properties –

Update hydro properties.

Attributes:

allocation (list[HydroAllocation]) –

Hydro allocations.
area_id (str) –

Area ID.
inflow_structure (InflowStructure) –

Inflow structure.
properties (HydroProperties) –

Hydro properties.

Source code in src/antares/craft/model/hydro.py

def __init__(
    self,
    service: BaseHydroService,
    area_id: str,
    properties: HydroProperties,
    inflow_structure: InflowStructure,
    allocation: list[HydroAllocation],
):
    self._area_id = area_id
    self._service = service
    self._properties = properties
    self._inflow_structure = inflow_structure
    self._allocation = allocation

allocation `property`

allocation: list[HydroAllocation]

Hydro allocations.

area_id `property`

area_id: str

Area ID.

inflow_structure `property`

inflow_structure: InflowStructure

Inflow structure.

properties `property`

properties: HydroProperties

Hydro properties.

get_credit_modulations

get_credit_modulations() -> DataFrame

Get credit modulation.

Returns:

DataFrame –

Credit modulation

Source code in src/antares/craft/model/hydro.py

def get_credit_modulations(self) -> pd.DataFrame:
    """Get credit modulation.

    Returns:
        Credit modulation
    """
    return self._service.get_credit_modulations(self.area_id)

get_energy

get_energy() -> DataFrame

Get energy.

Returns:

DataFrame –

Energy time-series.

Source code in src/antares/craft/model/hydro.py

def get_energy(self) -> pd.DataFrame:
    """Get energy.

    Returns:
        Energy time-series.
    """
    return self._service.get_energy(self.area_id)

get_inflow_pattern

get_inflow_pattern() -> DataFrame

Get inflow pattern.

Returns:

DataFrame –

Inflow pattern time-series.

Source code in src/antares/craft/model/hydro.py

def get_inflow_pattern(self) -> pd.DataFrame:
    """Get inflow pattern.

    Returns:
        Inflow pattern time-series.
    """
    return self._service.get_inflow_pattern(self.area_id)

get_maxpower

get_maxpower() -> DataFrame

Get maximum power.

Returns:

DataFrame –

The maximum power time-series.

Source code in src/antares/craft/model/hydro.py

def get_maxpower(self) -> pd.DataFrame:
    """Get maximum power.

    Returns:
        The maximum power time-series.
    """
    return self._service.get_maxpower(self.area_id)

get_mingen

get_mingen() -> DataFrame

Get minimum generation time-series.

Returns:

DataFrame –

Minimum generation time-series.

Source code in src/antares/craft/model/hydro.py

def get_mingen(self) -> pd.DataFrame:
    """Get minimum generation time-series.

    Returns:
        Minimum generation time-series.
    """
    return self._service.get_mingen(self.area_id)

get_mod_series

get_mod_series() -> DataFrame

Source code in src/antares/craft/model/hydro.py

def get_mod_series(self) -> pd.DataFrame:
    """"""
    return self._service.get_mod_series(self.area_id)

get_reservoir

get_reservoir() -> DataFrame

Get reservoir levels.

Returns:

DataFrame –

The reservoir level time-series.

Source code in src/antares/craft/model/hydro.py

def get_reservoir(self) -> pd.DataFrame:
    """Get reservoir levels.

    Returns:
        The reservoir level time-series.
    """
    return self._service.get_reservoir(self.area_id)

get_ror_series

get_ror_series() -> DataFrame

Get run-of-river generation time-series.

Returns:

DataFrame –

Run-of-river time-series.

Source code in src/antares/craft/model/hydro.py

def get_ror_series(self) -> pd.DataFrame:
    """Get run-of-river generation time-series.

    Returns:
        Run-of-river time-series.
    """
    return self._service.get_ror_series(self.area_id)

get_water_values

get_water_values() -> DataFrame

Get water values.

Returns:

DataFrame –

Water values time-series which depend on the date (365 days) and the reservoir fill percentage.

Source code in src/antares/craft/model/hydro.py

def get_water_values(self) -> pd.DataFrame:
    """Get water values.

    Returns:
        Water values time-series which depend on the date (365 days) and the reservoir fill percentage.
    """
    return self._service.get_water_values(self.area_id)

set_allocation

set_allocation(allocation: list[HydroAllocation]) -> None

Set allocation.

Parameters:

allocation
(list[HydroAllocation]) –

list of the hydro allocation

Source code in src/antares/craft/model/hydro.py

def set_allocation(self, allocation: list[HydroAllocation]) -> None:
    """Set allocation.

    Args:
        allocation: list of the hydro allocation
    """
    new_allocation = self._service.set_allocation(self.area_id, allocation)
    self._allocation = new_allocation

set_credits_modulation

set_credits_modulation(series: DataFrame) -> None

Set credit_modulation.

Parameters:

series
(DataFrame) –

A matrix of the generating power and the pumping power depending on the reservoir fill level.

Source code in src/antares/craft/model/hydro.py

def set_credits_modulation(self, series: pd.DataFrame) -> None:
    """Set credit_modulation.

    Args:
        series: A matrix of the generating power and the pumping power depending on the reservoir fill level.
    """
    return self._service.set_credits_modulation(self.area_id, series)

set_energy

set_energy(series: DataFrame) -> None

Set energy.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_energy(self, series: pd.DataFrame) -> None:
    """Set energy.

    Args:
        series: The time-series."""
    return self._service.set_energy(self.area_id, series)

set_inflow_pattern

set_inflow_pattern(series: DataFrame) -> None

Set inflow pattern.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_inflow_pattern(self, series: pd.DataFrame) -> None:
    """Set inflow pattern.

    Args:
        series: The time-series.
    """
    return self._service.set_inflow_pattern(self.area_id, series)

set_maxpower

set_maxpower(series: DataFrame) -> None

Set maximum power.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_maxpower(self, series: pd.DataFrame) -> None:
    """Set maximum power.

    Args:
        series: The time-series.
    """
    return self._service.set_maxpower(self.area_id, series)

set_mingen

set_mingen(series: DataFrame) -> None

Set minimum generation series.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_mingen(self, series: pd.DataFrame) -> None:
    """Set minimum generation series.

    Args:
        series: The time-series."""
    return self._service.set_mingen(self.area_id, series)

set_mod_series

set_mod_series(series: DataFrame) -> None

Set modulation series.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_mod_series(self, series: pd.DataFrame) -> None:
    """Set modulation series.

    Args:
        series: The time-series.
    """
    return self._service.set_mod_series(self.area_id, series)

set_reservoir

set_reservoir(series: DataFrame) -> None

Set reservoir.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_reservoir(self, series: pd.DataFrame) -> None:
    """Set reservoir.

    Args:
        series: The time-series.
    """
    return self._service.set_reservoir(self.area_id, series)

set_ror_series

set_ror_series(series: DataFrame) -> None

Set run-of-river generation series.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_ror_series(self, series: pd.DataFrame) -> None:
    """Set run-of-river generation series.

    Args:
        series: The time-series.
    """
    return self._service.set_ror_series(self.area_id, series)

set_water_values

set_water_values(series: DataFrame) -> None

Set water values.

Parameters:

series
(DataFrame) –

The time-series.

Source code in src/antares/craft/model/hydro.py

def set_water_values(self, series: pd.DataFrame) -> None:
    """Set water values.

    Args:
        series: The time-series.
    """
    return self._service.set_water_values(self.area_id, series)

update_inflow_structure

update_inflow_structure(inflow_structure: InflowStructureUpdate) -> None

Update inflow structure.

Parameters:

inflow_structure
(InflowStructureUpdate) –

Inflow structure to update.

Source code in src/antares/craft/model/hydro.py

def update_inflow_structure(self, inflow_structure: InflowStructureUpdate) -> None:
    """Update inflow structure.

    Args:
        inflow_structure: Inflow structure to update.
    """

    self._service.update_inflow_structure(self.area_id, inflow_structure)
    self._inflow_structure = replace(
        self._inflow_structure, intermonthly_correlation=inflow_structure.intermonthly_correlation
    )

update_properties

update_properties(properties: HydroPropertiesUpdate) -> None

Update hydro properties.

Parameters:

properties
(HydroPropertiesUpdate) –

Hydro properties to update.

Source code in src/antares/craft/model/hydro.py

def update_properties(self, properties: HydroPropertiesUpdate) -> None:
    """Update hydro properties.

    Args:
        properties: Hydro properties to update.
    """
    self._service.update_properties(self.area_id, properties)
    self._properties = self._properties.from_update_properties(properties)

HydroAllocation `dataclass`

HydroAllocation(area_id: str, coefficient: float = 1)

Diagonal term of the hydro allocations matrix used during a heuristic pre-allocation process, regardless of whether the stochastic time-series generator is used or not.

Attributes:

area_id (str) –

ID of the area.
coefficient (float) –

Coefficient.

HydroProperties `dataclass`

HydroProperties(
    inter_daily_breakdown: float = 1,
    intra_daily_modulation: float = 24,
    inter_monthly_breakdown: float = 1,
    reservoir: bool = False,
    reservoir_capacity: float = 0,
    follow_load: bool = True,
    use_water: bool = False,
    hard_bounds: bool = False,
    initialize_reservoir_date: int = 0,
    use_heuristic: bool = True,
    power_to_level: bool = False,
    use_leeway: bool = False,
    leeway_low: float = 1,
    leeway_up: float = 1,
    pumping_efficiency: float = 1,
    overflow_spilled_cost_difference: Optional[float] = None,
)

Hydro properties.

Attributes:

inter_daily_breakdown (float) –

Inter daily brekdown.
intra_daily_modulation (float) –

Intra daily modulation.
inter_monthly_breakdown (float) –

Inter monthly breakdown.
reservoir (bool) –

Whether or not use reservoir management.
reservoir_capacity (float) –

Reservoir capacity in MWh.
follow_load (bool) –

Whether or not follow load modulations.
use_water (bool) –

Whether or not use water values.
hard_bounds (bool) –

Whether or not use hard bounds on rule curves.
initialize_reservoir_date (int) –

The number of the month (0 to 11).
use_heuristic (bool) –

Whether or not use the hydro heuristic in the simulation. See more on the hydro heuristic here.
power_to_level (bool) –

Whether or not use power to level modulations.
use_leeway (bool) –

Whether or not use leeway.
leeway_low (float) –

Leeway low bound.
leeway_up (float) –

Leeway upper bound.
pumping_efficiency (float) –

Pumping efficiency ratio.
overflow_spilled_cost_difference (Optional[float]) –

(Introduced in v9.2)

Methods:

from_update_properties –

Create a new HydroProperties instance by updating the current properties.
to_update_properties –

Converts the current HydroProperties instance into a HydroPropertiesUpdate object.

from_update_properties

from_update_properties(update_properties: HydroPropertiesUpdate) -> HydroProperties

Create a new HydroProperties instance by updating the current properties.

Parameters:

update_properties
(HydroPropertiesUpdate) –

An object containing the properties to update. Only non-None fields in update_properties will override the current values.

Returns:

HydroProperties –

A new instance with updated properties.

Source code in src/antares/craft/model/hydro.py

def from_update_properties(self, update_properties: HydroPropertiesUpdate) -> "HydroProperties":
    """Create a new `HydroProperties` instance by updating the current properties.

    Args:
        update_properties: An object containing the properties to update.
                           Only non-None fields in `update_properties` will override the current values.

    Returns:
        A new instance with updated properties.
    """
    current_properties = asdict(self)
    current_properties.update({k: v for k, v in asdict(update_properties).items() if v is not None})
    return HydroProperties(**current_properties)

to_update_properties

to_update_properties() -> HydroPropertiesUpdate

Converts the current HydroProperties instance into a HydroPropertiesUpdate object.

Returns:

HydroPropertiesUpdate –

An instance of HydroPropertiesUpdate with all properties initialized
HydroPropertiesUpdate –

to the current values of this HydroProperties instance.

Source code in src/antares/craft/model/hydro.py

def to_update_properties(self) -> HydroPropertiesUpdate:
    """Converts the current `HydroProperties` instance into a `HydroPropertiesUpdate` object.

    Returns:
        An instance of `HydroPropertiesUpdate` with all properties initialized
        to the current values of this `HydroProperties` instance.
    """
    return HydroPropertiesUpdate(
        inter_daily_breakdown=self.inter_daily_breakdown,
        intra_daily_modulation=self.intra_daily_modulation,
        inter_monthly_breakdown=self.inter_monthly_breakdown,
        reservoir=self.reservoir,
        reservoir_capacity=self.reservoir_capacity,
        follow_load=self.follow_load,
        use_water=self.use_water,
        hard_bounds=self.hard_bounds,
        initialize_reservoir_date=self.initialize_reservoir_date,
        use_heuristic=self.use_heuristic,
        power_to_level=self.power_to_level,
        use_leeway=self.use_leeway,
        leeway_low=self.leeway_low,
        leeway_up=self.leeway_up,
        pumping_efficiency=self.pumping_efficiency,
        overflow_spilled_cost_difference=self.overflow_spilled_cost_difference,
    )

HydroPropertiesUpdate `dataclass`

HydroPropertiesUpdate(
    inter_daily_breakdown: Optional[float] = None,
    intra_daily_modulation: Optional[float] = None,
    inter_monthly_breakdown: Optional[float] = None,
    reservoir: Optional[bool] = None,
    reservoir_capacity: Optional[float] = None,
    follow_load: Optional[bool] = None,
    use_water: Optional[bool] = None,
    hard_bounds: Optional[bool] = None,
    initialize_reservoir_date: Optional[int] = None,
    use_heuristic: Optional[bool] = None,
    power_to_level: Optional[bool] = None,
    use_leeway: Optional[bool] = None,
    leeway_low: Optional[float] = None,
    leeway_up: Optional[float] = None,
    pumping_efficiency: Optional[float] = None,
    overflow_spilled_cost_difference: Optional[float] = None,
)

Update hydro properties.

Attributes:

inter_daily_breakdown (Optional[float]) –

Inter daily brekdown.
intra_daily_modulation (Optional[float]) –

Intra daily modulation.
inter_monthly_breakdown (Optional[float]) –

Inter monthly breakdown.
reservoir (Optional[bool]) –

Whether or not use reservoir management.
reservoir_capacity (Optional[float]) –

Reservoir capacity in MWh.
follow_load (Optional[bool]) –

Whether or not follow load modulations.
use_water (Optional[bool]) –

Whether or not use water values.
hard_bounds (Optional[bool]) –

Whether or not use hard bounds on rule curves.
initialize_reservoir_date (Optional[int]) –

The number of the month (0 to 11).
use_heuristic (Optional[bool]) –

Whether or not use the hydro heuristic in the simulation.
power_to_level (Optional[bool]) –

Whether or not use power to level modulations.
use_leeway (Optional[bool]) –

Whether or not use leeway.
leeway_low (Optional[float]) –

Leeway low bound.
leeway_up (Optional[float]) –

Leeway upper bound.
pumping_efficiency (Optional[float]) –

Pumping efficiency ratio.
overflow_spilled_cost_difference (Optional[float]) –

(Introduced in v9.2)

InflowStructure `dataclass`

InflowStructure(intermonthly_correlation: float = 0.5)

The inflow structure.

Attributes:

intermonthly_correlation (float) –

Inter-monthly correlation.

InflowStructureUpdate `dataclass`

InflowStructureUpdate(intermonthly_correlation: float)

Update the inflow structure.

Attributes:

intermonthly_correlation (float) –

Inter-monthly correlation.

hydro

Hydro

allocation property

area_id property

inflow_structure property

properties property

get_credit_modulations

get_energy

get_inflow_pattern

get_maxpower

get_mingen

get_mod_series

get_reservoir

get_ror_series

get_water_values

set_allocation

allocation

set_credits_modulation

series

set_energy

series

set_inflow_pattern

series

set_maxpower

series

set_mingen

series

set_mod_series

series

set_reservoir

series

set_ror_series

series

set_water_values

series

update_inflow_structure

inflow_structure

update_properties

properties

HydroAllocation dataclass

HydroProperties dataclass

from_update_properties

update_properties

to_update_properties

HydroPropertiesUpdate dataclass

InflowStructure dataclass

InflowStructureUpdate dataclass

allocation `property`

area_id `property`

inflow_structure `property`

properties `property`

`allocation`

`series`

`series`

`series`

`series`

`series`

`series`

`series`

`series`

`series`

`inflow_structure`

`properties`

HydroAllocation `dataclass`

HydroProperties `dataclass`

`update_properties`

HydroPropertiesUpdate `dataclass`

InflowStructure `dataclass`

InflowStructureUpdate `dataclass`