Skip to content

renewable

Classes:

RenewableCluster 

RenewableCluster(
    renewable_service: BaseRenewableService,
    area_id: str,
    name: str,
    properties: Optional[RenewableClusterProperties] = None,
)

Renewable clusters (solar, wind and other types of generation).

Methods:

Attributes:

Source code in src/antares/craft/model/renewable.py 
109
110
111
112
113
114
115
116
117
118
119
120
def __init__(
    self,
    renewable_service: BaseRenewableService,
    area_id: str,
    name: str,
    properties: Optional[RenewableClusterProperties] = None,
):
    self._area_id = area_id
    self._renewable_service = renewable_service
    self._name = name
    self._id = transform_name_to_id(name)
    self._properties = properties or RenewableClusterProperties()

area_id property 

area_id: str

Area ID.

id property 

id: str

Renewable cluster's ID.

name property 

name: str

Renewable cluster's name.

properties property 

properties: RenewableClusterProperties

Renewable cluster's properties.

get_timeseries 

get_timeseries() -> DataFrame

Get renewable availability time-series.

Returns:

  • DataFrame –

    Renewable time-series.

Source code in src/antares/craft/model/renewable.py 
152
153
154
155
156
157
158
def get_timeseries(self) -> pd.DataFrame:
    """Get renewable availability time-series.

    Returns:
        Renewable time-series.
    """
    return self._renewable_service.get_renewable_matrix(self.id, self.area_id)

set_series 

set_series(matrix: DataFrame) -> None

Set renewable availability time-series.

Parameters:

  • matrix

    (DataFrame) –

    Renewable time-series.

Source code in src/antares/craft/model/renewable.py 
160
161
162
163
164
165
166
def set_series(self, matrix: pd.DataFrame) -> None:
    """Set renewable availability time-series.

    Args:
        matrix: Renewable time-series.
    """
    self._renewable_service.set_series(self, matrix)

update_properties 

update_properties(
    properties: RenewableClusterPropertiesUpdate,
) -> RenewableClusterProperties

Update renewable cluster's properties.

Parameters:

Source code in src/antares/craft/model/renewable.py 
142
143
144
145
146
147
148
149
150
def update_properties(self, properties: RenewableClusterPropertiesUpdate) -> RenewableClusterProperties:
    """Update renewable cluster's properties.

    Args:
        properties: Renewable cluster properties to update.
    """
    new_properties = self._renewable_service.update_renewable_clusters_properties({self: properties})
    self._properties = new_properties[self]
    return self._properties

RenewableClusterGroup

Renewable cluster groups. These groups are case insensitive.

Attributes:

  • THERMAL_SOLAR –

    Thermal solar generation.

  • PV_SOLAR –

    Photovoltaic solar generation.

  • ROOFTOP_SOLAR –

    Rooftop solar generation.

  • WIND_ON_SHORE –

    On shore wind generation.

  • WIND_OFF_SHORE –

    Off-shore wind generation.

  • OTHER1 –

    Other 1

  • OTHER2 –

    Other 2

  • OTHER3 –

    Other 3

  • OTHER4 –

    Other 4

RenewableClusterProperties dataclass 

RenewableClusterProperties(
    enabled: bool = True,
    unit_count: int = 1,
    nominal_capacity: float = 0,
    group: str = value,
    ts_interpretation: TimeSeriesInterpretation = POWER_GENERATION,
)

Renewable cluster properties.

Attributes:

  • enabled (bool) –

    Whether the cluster is enabled in the simulation.

  • unit_count (int) –

    Number of generation units in the cluster.

  • nominal_capacity (float) –

    Nominal capacity of a single unit in MW.

  • group (str) –

    Group of the renewables.

  • ts_interpretation (TimeSeriesInterpretation) –

    Either power_generation or production_factor.

enabled_capacity property 

enabled_capacity: float

The enabled capacity is the installed capacity if the cluster is enabled, otherwise it's 0.

installed_capacity property 

installed_capacity: float

Installed capacity corresponding to the product of the nominal capacity times the number of units.

RenewableClusterPropertiesUpdate dataclass 

RenewableClusterPropertiesUpdate(
    enabled: Optional[bool] = None,
    unit_count: Optional[int] = None,
    nominal_capacity: Optional[float] = None,
    group: Optional[str] = None,
    ts_interpretation: Optional[TimeSeriesInterpretation] = None,
)

Update the renewable cluster properties.

Attributes:

TimeSeriesInterpretation

Timeseries mode.

Attributes:

  • POWER_GENERATION –

    Power generation means that the unit of the timeseries is in MW

  • PRODUCTION_FACTOR –

    Production factor means that the unit of the timeseries is in p.u. (between 0 and 1, 1 meaning the full installed capacity).