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

561

Version

0.9.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 14th, 2025

Functions in antaresEditObject (0.9.0)

computeTimeStampFromHourly

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

Create an empty Antares study

convertConfigToAdq

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

Create a Demand Side Response (DSR)

Create a link between two areas

Create a Pumped Storage Power plant (PSP)

Copy of the output files of an Antares study

createBindingConstraintBulk

Create multiple binding constraint at once.

Create a cluster

dicoOutputSettings

Correspondence between arguments of updateOutputSettings and actual Antares parameters.

Create an area in an Antares study

.api_command_execute_edit_area

Edit area's parameters in API mode.

createBindingConstraint

Create a binding constraint

dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.

editBindingConstraint

Update an existing binding constraint

dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.

Edit an existing cluster

createClusterBulk

Create serial thermal cluster

.initializeLinksArea

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

.format_playlist_weights

Generate playlist_year_weight section in the appropriate format.

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

Create a district

.initializeRenewablesArea

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

detect_pattern_in_binding_constraint

Detect a pattern in a binding constraint coefficient

dicoAdequacySettings

Correspondence between arguments of updateAdequacySettings and actual Antares parameters.

.format_ini_rhs

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

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

filteringOptions

Output profile options for creating an area

Retrieve API jobs

mockSimulationAPI

Retrieve job log from API

nodalOptimizationOptions

Nodal optimization parameters for creating an area

get_default_hydro_ini_values

Get default hydro.ini values

createClusterST

Create a short-term storage cluster

create_scb_referential_series_type

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

.split_nodalOptimization_by_target

Split list nodalOptimization by target file.

Delete a study or a simulation

function that ensures the transition to 9

.initializeThermalArea

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

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

Get the playlist of an Antares study

propertiesLinkOptions

Properties for creating a link

list_pollutants_values

Output pollutants list for thermal clusters

importZipStudyWeb

Import a local study to Antares Web

Edit an area in an Antares study

Edit a link between two areas

group_values_meta_check

Check dimension of time series for binding constraints

get_type_check_mingen_vs_maxpower_to_trigger

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

Edit a short-term storage cluster

Run an Antares Simulation

get_type_check_mingen_vs_hydrostorage

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

get_type_check_mingen_vs_hydrostorage_to_trigger

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

Remove an area from an Antares study

removeBindingConstraint

Remove a Binding Constraint

scenario-builder

Read, create, update & deduplicate scenario builder

Run Time-Series Generator

update_generaldata_by_section

Update a specific section in generaldata.ini file

variant-commands

Get API commands generated

Remove a cluster

Remove a link between two areas

Set path to Antares Solver

Create a study's variant

Write configuration options in file or API

updateGeneralSettings

Update general parameters of an Antares study

replicate_missing_ts

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

Search study in AntaREST

updateOptimizationSettings

Update optimization parameters of an Antares study

updateOutputSettings

Update output parameters of an Antares study

writeEconomicOptions

Write Economic Options

rollback_to_previous_data

Rollback to previous hydro data if the data is not consistent

updateInputSettings

Update input parameters of an Antares study

Edit hydro.ini values

Write input time series

storage_values_default

Short Term Storage Property List

writeWaterValues

Write water values

writeHydroValues

Write Hydro Values

writeSeriesPrepro

Write prepro data

updateAdequacySettings

Update adequacy parameters of an Antares study

Write Misc Gen data

writeOutputValues

Write output value for Antares

adequacyOptions

Adequacy patch parameters for creating an area

add_week_number_column_to_ts

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

antaresEditObject-package

antaresEditObject: Edit an 'Antares' Simulation

Clean up output based on geographic trimming

computeOtherFromHourlyMulti

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

Activate RES in an Antares study

computeOtherFromHourlyYear

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

Activate st-storage in an Antares study

checkRemovedArea

Seek for a removed area

check_consistency_reservoir_values

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

Import physical study to Antares Web (managed study)

Is study an Antares v7 study ?

Create a backup with an Antares Study

check_mingen_vs_maxpower

Check if mingen data and maxpower data are consistent

check_mingen_vs_hydro_storage

Check if mingen data and hydro storage data are consistent