antaresEditObject0.9.2 package

Edit an 'Antares' Simulation

activateRES

Activate RES in an Antares study

activateST

Activate st-storage in an Antares study

add_week_number_column_to_ts

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

adequacyOptions

Adequacy patch parameters for creating an area

antaresEditObject-package

antaresEditObject: Edit an 'Antares' Simulation

api_patch

API methods

backupStudy

Create a backup with an Antares Study

check_consistency_reservoir_values

For a given area, check consistency between reservoir and reservoir ca...

check_mingen_vs_hydro_storage

Check if mingen data and hydro storage data are consistent

check_mingen_vs_maxpower

Check if mingen data and maxpower data are consistent

check-version

Is study an Antares v7 study ?

checkRemovedArea

Seek for a removed area

cleanUpOutput

Clean up output based on geographic trimming

computeOtherFromHourlyMulti

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

computeOtherFromHourlyYear

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

computeTimeStampFromHourly

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

convertConfigToAdq

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

copyOutput

Copy of the output files of an Antares study

copyStudyWeb

Import physical study to Antares Web (managed study)

create_scb_referential_series_type

Create the correspondence data frame between the symbol and the type i...

create-study

Create an empty Antares study

createArea

Create an area in an Antares study

createBindingConstraint

Create a binding constraint

createBindingConstraintBulk

Create multiple binding constraint at once.

createCluster

Create a cluster

createClusterBulk

Create serial thermal cluster

createClusterST

Create a short-term storage cluster

createDistrict

Create a district

createDSR

Create a Demand Side Response (DSR)

createLink

Create a link between two areas

createPSP

Create a Pumped Storage Power plant (PSP)

deleteStudy

Delete a study or a simulation

detect_pattern_in_binding_constraint

Detect a pattern in a binding constraint coefficient

dicoAdequacySettings

Correspondence between arguments of updateAdequacySettings and actua...

dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual...

dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and a...

dicoOutputSettings

Correspondence between arguments of updateOutputSettings and actual ...

dot-api_command_execute_edit_area_ui

Edit area's ui in API mode.

dot-api_command_execute_edit_area

Edit area's parameters in API mode.

dot-dailyToWeekly

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

dot-format_ini_rhs

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

dot-format_playlist_weights

Generate playlist_year_weight section in the appropriate format.

dot-format_ui_data_by_mode

Generate the data for the ui part by study mode.

dot-hourlyToOther

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

dot-initializeLinksArea

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

dot-initializeRenewablesArea

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

dot-initializeThermalArea

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

dot-is_version_9

function that ensures the transition to 9

dot-split_nodalOptimization_by_target

Split list nodalOptimization by target file.

editArea

Edit an area in an Antares study

editBindingConstraint

Update an existing binding constraint

editCluster

Edit an existing cluster

editClusterST

Edit a short-term storage cluster

editLink

Edit a link between two areas

fill_empty_hydro_ini_file

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

fill_empty_hydro_ts_file

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

filteringOptions

Output profile options for creating an area

get_default_hydro_ini_values

Get default hydro.ini values

get_type_check_mingen_vs_hydrostorage_to_trigger

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

get_type_check_mingen_vs_hydrostorage

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

get_type_check_mingen_vs_maxpower_to_trigger

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

getJobLogs

Retrieve job log from API

getJobs

Retrieve API jobs

group_values_meta_check

Check dimension of time series for binding constraints

importZipStudyWeb

Import a local study to Antares Web

list_pollutants_values

Output pollutants list for thermal clusters

mockSimulationAPI

Mock API usage

nodalOptimizationOptions

Nodal optimization parameters for creating an area

playlist

Get the playlist of an Antares study

propertiesLinkOptions

Properties for creating a link

removeArea

Remove an area from an Antares study

removeBindingConstraint

Remove a Binding Constraint

removeCluster

Remove a cluster

removeDistrict

Remove a district

removeLink

Remove a link between two areas

replicate_missing_ts

Replicate a data.table as many times as needed to get the same number ...

rollback_to_previous_data

Rollback to previous hydro data if the data is not consistent

runSimulation

Run an Antares Simulation

runTsGenerator

Run Time-Series Generator

scenario-builder

Read, create, update & deduplicate scenario builder

searchStudy

Search study in AntaREST

setAPImode

Set API mode

setSolverPath

Set path to Antares Solver

setThematicTrimming

Set the thematic trimming of an Antares Study

storage_values_default

Short Term Storage Property List

update_generaldata_by_section

Update a specific section in generaldata.ini file

updateAdequacySettings

Update adequacy parameters of an Antares study

updateGeneralSettings

Update general parameters of an Antares study

updateInputSettings

Update input parameters of an Antares study

updateOptimizationSettings

Update optimization parameters of an Antares study

updateOutputSettings

Update output parameters of an Antares study

variant-commands

Get API commands generated

variant

Create a study's variant

write-ini

Write configuration options in file or API

writeEconomicOptions

Write Economic Options

writeHydroValues

Write Hydro Values

writeIniHydro

Edit hydro.ini values

writeInputTS

Write input time series

writeMiscGen

Write Misc Gen data

writeOutputValues

Write output value for Antares

writeSeriesPrepro

Write prepro data

writeWaterValues

Write water values

Edit an 'Antares' simulation before running it : create new areas, links, thermal clusters or binding constraints or edit existing ones. Update 'Antares' general & optimization settings. 'Antares' is an open source power system generator, more information available here : <https://antares-simulator.org/>.

  • Maintainer: Tatiana Vargas
  • License: GPL (>= 2)
  • Last published: 2025-09-24