Learn R Programming

antaresEditObject

Edit an Antares study before running a simulation.

Installation

Install from CRAN:

install.packages("antaresEditObject")

Or install dev version from GitHub:

remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)

Goal

This package allows to edit an Antares study. Methods are provided to create (and remove) areas, links between them, thermal clusters and binding constraints. These steps may be useful before running an Antares simulation.

See website for more documentation: https://rte-antares-rpackage.github.io/antaresEditObject/

Usage

Usage of the package is detailed in the vignette: vignette("antaresEditObject").

Copy Link

Version

Install

install.packages('antaresEditObject')

Monthly Downloads

428

Version

1.0.0

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/rte-antares-rpackage/antaresEditObject

Homepage

https://rte-antares-rpackage.github.io/antaresEditObject/

Maintainer

Tatiana Vargas

Last Published

February 3rd, 2026

Functions in antaresEditObject (1.0.0)

Create an empty Antares study

createBindingConstraintBulk

Create multiple binding constraint at once.

Delete a study or a simulation

create_scb_referential_series_type

Create the correspondence data frame between the symbol and the type in scenario builder

Create a Pumped Storage Power plant (PSP)

Create a link between two areas

.initializeThermalArea

Initialize thermal data for a new area. For disk mode only.

function that ensures the transition to 9

Create an area in an Antares study

createBindingConstraint

Create a binding constraint

dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

createClusterBulk

Create serial thermal cluster

createClusterST

Create a short-term storage cluster

Edit a short-term storage cluster

Edit a district in an Antares study

.format_ui_data_by_mode

Generate the data for the ui part by study mode.

.split_nodalOptimization_by_target

Split list nodalOptimization by target file.

Edit an area in an Antares study

dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

.api_command_execute_edit_area_ui

Edit area's ui in API mode.

Computation function for rebuild mc-ind weekly from daily data.

Computation function for rebuild mc-ind daily, monthly and annual from hourly data.

Create a cluster

get_type_check_mingen_vs_hydrostorage_to_trigger

Get the type of control to execute between mingen data and hydro storage data

Create a Demand Side Response (DSR)

Create a district

get_type_check_mingen_vs_maxpower_to_trigger

Get the type of control to execute between mingen data and maxpower data

get_default_hydro_ini_values

Get default hydro.ini values

Remove a link between two areas

Remove a district

propertiesLinkOptions

Properties for creating a link

filteringOptions

Output profile options for creating an area

Remove an area from an Antares study

fill_empty_hydro_ts_file

Write default input time series if mingen.txt or/and mod.txt is empty

.api_command_execute_edit_area

Edit area's parameters in API mode.

.initializeRenewablesArea

Initialize renewables data for a new area. For disk mode only.

dicoOutputSettings

Correspondence between arguments of updateOutputSettings and actual Antares parameters.

list_pollutants_values

Output pollutants list for thermal clusters

Run Time-Series Generator

get_type_check_mingen_vs_hydrostorage

Get the type of control to execute using the 3 necessary booleans

Run an Antares Simulation

Retrieve API jobs

Retrieve job log from API

.initializeLinksArea

Initialize links data for a new area. For disk mode only.

mockSimulationAPI

writeHydroValues

Write Hydro Values

.format_ini_rhs

Format a value to a suitable format to rhs in an .ini file.

dicoAdequacySettings

Correspondence between arguments of updateAdequacySettings and actual Antares parameters.

detect_pattern_in_binding_constraint

Detect a pattern in a binding constraint coefficient

Edit hydro.ini values

.format_playlist_weights

Generate playlist_year_weight section in the appropriate format.

variant-commands

Get API commands generated

Edit a link between two areas

Search study in AntaREST

scenario-builder

Read, create, update & deduplicate scenario builder

fill_empty_hydro_ini_file

Write default values in hydro.ini file if the section is empty

Create a study's variant

Set path to Antares Solver

nodalOptimizationOptions

Nodal optimization parameters for creating an area

Get the playlist of an Antares study

rollback_to_previous_data

Rollback to previous hydro data if the data is not consistent

replicate_missing_ts

Replicate a data.table as many times as needed to get the same number of time series between 2 data.tables

group_values_meta_check

Check dimension of time series for binding constraints

Edit an existing cluster

editBindingConstraint

Update an existing binding constraint

importZipStudyWeb

Import a local study to Antares Web

writeWaterValues

Write water values

removeBindingConstraint

Remove a Binding Constraint

Remove a cluster

updateInputSettings

Update input parameters of an Antares study

updateAdequacySettings

Update adequacy parameters of an Antares study

updateOptimizationSettings

Update optimization parameters of an Antares study

updateGeneralSettings

Update general parameters of an Antares study

Write input time series

storage_values_default

Short Term Storage Property List

setThematicTrimming

Set the thematic trimming of an Antares Study

updateOutputSettings

Update output parameters of an Antares study

update_generaldata_by_section

Update a specific section in generaldata.ini file

Write Misc Gen data

writeEconomicOptions

Write Economic Options

Write configuration options in file or API

writeSeriesPrepro

Write prepro data

writeOutputValues

Write output value for Antares

check_consistency_reservoir_values

For a given area, check consistency between reservoir and reservoir capacity values

Is study an Antares v7 study ?

Activate RES in an Antares study

Create a backup with an Antares Study

adequacyOptions

Adequacy patch parameters for creating an area

Activate st-storage in an Antares study

antaresEditObject-package

antaresEditObject: Edit an 'Antares' Simulation

add_week_number_column_to_ts

Add week number column to a data.time of time series type

checkRemovedArea

Seek for a removed area

check_mingen_vs_hydro_storage

Check if mingen data and hydro storage data are consistent

computeOtherFromHourlyMulti

Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)

check_mingen_vs_maxpower

Check if mingen data and maxpower data are consistent

Clean up output based on geographic trimming

computeTimeStampFromHourly

Compute daily, weekly, monthly and annual mc-ind from hourly data.

computeOtherFromHourlyYear

Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)

Import physical study to Antares Web (managed study)

convertConfigToAdq

Read adequacy patch config.yml into Antares (v8.5+)

Copy of the output files of an Antares study