Skip to content

advanced_parameters

Classes:

AdvancedParameters dataclass 

AdvancedParameters(
    hydro_heuristic_policy: HydroHeuristicPolicy = ACCOMMODATE_RULES_CURVES,
    hydro_pricing_mode: HydroPricingMode = FAST,
    power_fluctuations: PowerFluctuation = FREE_MODULATIONS,
    shedding_policy: SheddingPolicy = SHAVE_PEAKS,
    unit_commitment_mode: UnitCommitmentMode = FAST,
    number_of_cores_mode: SimulationCore = MEDIUM,
    renewable_generation_modelling: RenewableGenerationModeling = CLUSTERS,
    accuracy_on_correlation: set[OutputChoices] = set(),
    initial_reservoir_levels: InitialReservoirLevel | None = None,
    accurate_shave_peaks_include_short_term_storage: bool | None = None,
)

Advanced parameters.

Attributes:

AdvancedParametersUpdate dataclass 

AdvancedParametersUpdate(
    initial_reservoir_levels: Optional[InitialReservoirLevel] = None,
    hydro_heuristic_policy: Optional[HydroHeuristicPolicy] = None,
    hydro_pricing_mode: Optional[HydroPricingMode] = None,
    power_fluctuations: Optional[PowerFluctuation] = None,
    shedding_policy: Optional[SheddingPolicy] = None,
    unit_commitment_mode: Optional[UnitCommitmentMode] = None,
    number_of_cores_mode: Optional[SimulationCore] = None,
    renewable_generation_modelling: Optional[RenewableGenerationModeling] = None,
    accuracy_on_correlation: Optional[set[OutputChoices]] = None,
    accurate_shave_peaks_include_short_term_storage: Optional[bool] = None,
)

Update advanced parameters.

See the class AdvancedParameters for details of the fields.

HydroHeuristicPolicy

Heuristic policy of hydro.

This parameter is meant to define how the reservoir level should be managed throughout the year, either with emphasis put on the respect of rule curves or on the maximization of the use of natural inflows.

Attributes:

  • ACCOMMODATE_RULES_CURVES –

    Upper and lower rule curves are accommodated in both monthly and daily heuristic stages. In the second stage, violations of the lower rule curve are avoided as much as possible (penalty cost on \(\Psi\) higher than penalty cost on \(Y\)). This policy may result in a restriction of the overall yearly energy generated from the natural inflows.

  • MAXIMIZE_GENERATION –

    Upper and lower rule curves are accommodated in both monthly and daily heuristic stages. In the second stage, incomplete use of natural inflows is avoided as much as possible (penalty cost on \(Y\) higher than penalty cost on \(\Psi\)). This policy may result in violations of the lower rule curve.

HydroPricingMode

Hydro pricing mode.

This parameter is meant to define how the reservoir level difference between the beginning and the end of an optimization week should be reflected in the hydro economic signal (water value) used in the computation of optimal hourly generated /pumped power during this week.

Attributes:

  • FAST –

    The water value is taken to remain about the same throughout the week, and a constant value equal to that found at the date and for the level at which the week begins is used in the course of the optimization. A value interpolated from the reference table for the exact level reached at each time step within the week is used ex-post in the assessment of the variable "H.COST" (positive for generation, negative for pumping). This option should be reserved to simulations in which computation resources are an issue or to simulations in which level-dependent water value variations throughout a week are known to be small.

  • ACCURATE –

    The water value is considered as variable throughout the week. As a consequence, a different cost is used for each "layer" of the stock from/to which energy can be withdrawn/injected, in an internal hydro merit-order involving the 100 tabulated water-values found at the date at which the week ends. A value interpolated from the reference table for the exact level reached at each time step within the week is used ex-post in the assessment of the variable "H.COST" (positive for generation, negative for pumping). This option should be used if computation resources are not an issue and if level-dependent water value variations throughout a week must be accounted for.

InitialReservoirLevel

Initial reservoir level.

Note that the reservoir level is now always determined with cold start behaviour since v9.2. See more here

Attributes:

  • COLD_START –

    On starting the simulation of a new Monte-Carlo year, the reservoir level to consider in each Area on the first day of the initialization month is randomly drawn between the extreme levels defined for the Area on that day.

  • HOT_START –

    On starting the simulation of a new Monte-Carlo year, the reservoir level to consider in each Area on the first day of the initialization month is set to the value reached at the end of the previous simulated year (see the conditions here)

PowerFluctuation

Power fluctuations.

Attributes:

  • FREE_MODULATIONS –
  • MINIMIZE_EXCURSIONS –
  • MINIMIZE_RAMPING –

RenewableGenerationModeling

Renewable generation modelling.

Attributes:

  • AGGREGATED –

    Deprecated since v8.1. Aggregate view of wind and solar generation per node.

  • CLUSTERS –

    Allow to create several subsets of production means with specific characteristics, for the same area (or node).

SeedParameters dataclass 

SeedParameters(
    seed_tsgen_thermal: int = 3005489,
    seed_tsnumbers: int = 5005489,
    seed_unsupplied_energy_costs: int = 6005489,
    seed_spilled_energy_costs: int = 7005489,
    seed_thermal_costs: int = 8005489,
    seed_hydro_costs: int = 9005489,
    seed_initial_reservoir_levels: int = 10005489,
)

Random seeds used for the random number generation by the simulator.

Attributes:

  • seed_tsgen_thermal (int) –

    Seed for the generation of thermal time-series.

  • seed_tsnumbers (int) –

    Seed for the generation of time-series (wind, load, hydro, solar, draws).

  • seed_unsupplied_energy_costs (int) –

    Seed for the noise on unsupplied energy cost.

  • seed_spilled_energy_costs (int) –

    Seed for the noise on spilled energy costs.

  • seed_thermal_costs (int) –

    Seed for the noise on thermal plants costs.

  • seed_hydro_costs (int) –

    Seed for the noise on virtual hydro costs.

  • seed_initial_reservoir_levels (int) –

    Seed for initial reservoir levels.

SeedParametersUpdate dataclass 

SeedParametersUpdate(
    seed_tsgen_thermal: Optional[int] = None,
    seed_tsnumbers: Optional[int] = None,
    seed_unsupplied_energy_costs: Optional[int] = None,
    seed_spilled_energy_costs: Optional[int] = None,
    seed_thermal_costs: Optional[int] = None,
    seed_hydro_costs: Optional[int] = None,
    seed_initial_reservoir_levels: Optional[int] = None,
)

Update random seeds used for the random number generation by the simulator.

See the class SeedParameters for details of the fields.

SheddingPolicy

Shedding policy.

Attributes:

  • SHAVE_PEAKS –
  • MINIMIZE_DURATION –
  • ACCURATE_SHAVE_PEAKS –

    Introduced in v9.2 of Antares Simulator.

SimulationCore

Simulation core.

Useful to select multi-threading option. See more here.

Attributes:

  • MINIMUM –
  • LOW –
  • MEDIUM –
  • HIGH –
  • MAXIMUM –

UnitCommitmentMode

Unit commitment mode.

See more here.

Attributes:

  • FAST –

    Heuristic in which 2 LP (Linear Programming) problems are solved. No explicit modelling for the number of ON/OFF units.

  • ACCURATE –

    Heuristic in which 2 LP (Linear Programming) problems are solved. Explicit modelling for the number of ON/OFF units. Slower than fast.

  • MILP –

    A single MILP (Mixed Integer Linear Program) problem is solved, with explicit modelling for the number of ON/OFF units. Slower than accurate