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

415

Version

0.9.2

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

September 24th, 2025

Functions in antaresEditObject (0.9.2)

convertConfigToAdq

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

Create an empty Antares study

Create a link between two areas

computeTimeStampFromHourly

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

createBindingConstraintBulk

Create multiple binding constraint at once.

Clean up output based on geographic trimming

computeOtherFromHourlyYear

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

Create a cluster

.api_command_execute_edit_area

Edit area's parameters in API mode.

Create a Pumped Storage Power plant (PSP)

createClusterST

Create a short-term storage cluster

.initializeRenewablesArea

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

Create a Demand Side Response (DSR)

detect_pattern_in_binding_constraint

Detect a pattern in a binding constraint coefficient

dicoAdequacySettings

Correspondence between arguments of updateAdequacySettings and actual Antares parameters.

.initializeThermalArea

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

editBindingConstraint

Update an existing binding constraint

dicoOutputSettings

Correspondence between arguments of updateOutputSettings and actual Antares parameters.

.split_nodalOptimization_by_target

Split list nodalOptimization by target file.

dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

Edit an area in an Antares study

createBindingConstraint

Create a binding constraint

.initializeLinksArea

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

get_default_hydro_ini_values

Get default hydro.ini values

Retrieve API jobs

function that ensures the transition to 9

mockSimulationAPI

nodalOptimizationOptions

Nodal optimization parameters for creating an area

get_type_check_mingen_vs_hydrostorage

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

Edit a short-term storage cluster

Edit an existing cluster

get_type_check_mingen_vs_maxpower_to_trigger

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

group_values_meta_check

Check dimension of time series for binding constraints

fill_empty_hydro_ts_file

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

fill_empty_hydro_ini_file

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

scenario-builder

Read, create, update & deduplicate scenario builder

rollback_to_previous_data

Rollback to previous hydro data if the data is not consistent

updateOptimizationSettings

Update optimization parameters of an Antares study

create_scb_referential_series_type

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

Run Time-Series Generator

importZipStudyWeb

Import a local study to Antares Web

.format_ini_rhs

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

Delete a study or a simulation

.format_playlist_weights

Generate playlist_year_weight section in the appropriate format.

Edit a link between two areas

list_pollutants_values

Output pollutants list for thermal clusters

get_type_check_mingen_vs_hydrostorage_to_trigger

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

updateInputSettings

Update input parameters of an Antares study

Remove a district

Remove a cluster

updateGeneralSettings

Update general parameters of an Antares study

updateOutputSettings

Update output parameters of an Antares study

Remove an area from an Antares study

removeBindingConstraint

Remove a Binding Constraint

storage_values_default

Short Term Storage Property List

Run an Antares Simulation

update_generaldata_by_section

Update a specific section in generaldata.ini file

Set path to Antares Solver

.api_command_execute_edit_area_ui

Edit area's ui in API mode.

updateAdequacySettings

Update adequacy parameters of an Antares study

Create a district

writeEconomicOptions

Write Economic Options

Write configuration options in file or API

Create a study's variant

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

writeHydroValues

Write Hydro Values

variant-commands

Get API commands generated

setThematicTrimming

Set the thematic trimming of an Antares Study

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

writeWaterValues

Write water values

writeSeriesPrepro

Write prepro data

Edit hydro.ini values

Write input time series

Get the playlist of an Antares study

.format_ui_data_by_mode

Generate the data for the ui part by study mode.

Remove a link between two areas

Retrieve job log from API

replicate_missing_ts

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

filteringOptions

Output profile options for creating an area

propertiesLinkOptions

Properties for creating a link

Search study in AntaREST

Write Misc Gen data

writeOutputValues

Write output value for Antares

Copy of the output files of an Antares study

antaresEditObject-package

antaresEditObject: Edit an 'Antares' Simulation

checkRemovedArea

Seek for a removed area

Activate st-storage in an Antares study

Import physical study to Antares Web (managed study)

check_consistency_reservoir_values

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

check_mingen_vs_hydro_storage

Check if mingen data and hydro storage data are consistent

Activate RES in an Antares study

add_week_number_column_to_ts

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

Create a backup with an Antares Study

adequacyOptions

Adequacy patch parameters for creating an area

Is study an Antares v7 study ?

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

createClusterBulk

Create serial thermal cluster

Create an area in an Antares study