Skip to content

general

Classes:

BuildingMode

Building modes.

Attributes:

  • AUTOMATIC –

    Time-series are randomly drawn.

  • CUSTOM –

    The simulation will be carried out on a mix of deterministic and probabilistic conditions, with some time-series randomly drawn and others set to user-defined values. This option allows setting up detailed "what if" simulations that may help to understand the phenomena at work and quantify various kinds of risk indicators. To set up the simulation profile, use the scenario builder.

  • DERATED –

    All time-series will be replaced by their general average and the number of MC years set to 1. If the TS are ready-made or Antares-generated but are not to be stored in the INPUT folder, no time-series will be written over the original ones (if any). If the time-series are built by Antares and if it is specified that they should be stored in the INPUT, a single average-out time series will be stored instead of the whole set.

GeneralParameters dataclass 

GeneralParameters(
    mode: Mode = ECONOMY,
    horizon: str = "",
    nb_years: int = 1,
    simulation_start: int = 1,
    simulation_end: int = 365,
    january_first: WeekDay = MONDAY,
    first_month_in_year: Month = JANUARY,
    first_week_day: WeekDay = MONDAY,
    leap_year: bool = False,
    year_by_year: bool = False,
    simulation_synthesis: bool = True,
    building_mode: BuildingMode = AUTOMATIC,
    user_playlist: bool = False,
    thematic_trimming: bool = False,
    geographic_trimming: bool = False,
    store_new_set: bool = False,
    nb_timeseries_thermal: int = 1,
)

General parameters for the simulation.

Attributes:

  • mode (Mode) –

    Choice of the simulation mode (economy, adequacy or expansion).

  • horizon (str) –

    Horizon of the study (static tag, not used in the calculations).

  • nb_years (int) –

    Number of Monte-Carlo scenarios/years.

  • simulation_start (int) –

    First day of the simulation in 1, 2, ..., 366.

  • simulation_end (int) –

    Last day of the simulation in 1, 2, ..., 366.

  • january_first (WeekDay) –

    Choice of the weekday of the year.

  • first_month_in_year (Month) –

    Choice of the first month in the year depending on the type of study.

  • first_week_day (WeekDay) –

    Choice of the first day of the week.

  • leap_year (bool) –

    Whether to decide that the year is a leap year.

  • year_by_year (bool) –

    Whether to enable year-by-year the output profile.

  • simulation_synthesis (bool) –

    Whether there is a simulation synthesis in the output profile.

  • building_mode (BuildingMode) –

    Choice of the building mode (AUTOMATIC, CUSTOM or DERATED).

  • user_playlist (bool) –
  • thematic_trimming (bool) –

    Whether to enable thematic trimming.

  • geographic_trimming (bool) –

    Whether to enable geographic trimming.

  • store_new_set (bool) –
  • nb_timeseries_thermal (int) –

    Number of time-series to be generated stochastically.

GeneralParametersUpdate dataclass 

GeneralParametersUpdate(
    mode: Optional[Mode] = None,
    horizon: Optional[str] = None,
    nb_years: Optional[int] = None,
    simulation_start: Optional[int] = None,
    simulation_end: Optional[int] = None,
    january_first: Optional[WeekDay] = None,
    first_month_in_year: Optional[Month] = None,
    first_week_day: Optional[WeekDay] = None,
    leap_year: Optional[bool] = None,
    year_by_year: Optional[bool] = None,
    simulation_synthesis: Optional[bool] = None,
    building_mode: Optional[BuildingMode] = None,
    user_playlist: Optional[bool] = None,
    thematic_trimming: Optional[bool] = None,
    geographic_trimming: Optional[bool] = None,
    store_new_set: Optional[bool] = None,
    nb_timeseries_thermal: Optional[int] = None,
)

Update general parameters.

See field details in GeneralParameters.

Mode

Modes to run the simulation.

Attributes:

  • ECONOMY –

    Antares simulator will try to ensure balance between load and generation, while minimizing the economical cost of the grid's operation (more on this here). Economy simulations make a full use of Antares optimization capabilities. They require economic as well as technical input data and may demand a lot of computer resources.

  • ADEQUACY –

    All power plant operational costs are considered zero. Antares only objective is to ensure balance between load and generation. Adequacy simulations are faster and require only technical input data. Their results are limited to adequacy indicators.

  • EXPANSION –

    Antares simulator will optimize the investments on the grid, minimizing both investments and operational costs.

Month

Months of the year.

OutputChoices

Output choices.

Attributes:

  • LOAD –
  • WIND –
  • HYDRO –
  • THERMAL –
  • SOLAR –
  • RENEWABLES –
  • NTC –
  • MAX_POWER –

WeekDay

Week days.