Package: antaresEditObject 1.0.1

Tatiana Vargas

antaresEditObject: Edit an 'Antares' Simulation

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/>.

Authors:Tatiana Vargas [aut, cre], Frederic Breant [ctb], Victor Perrier [ctb], Baptiste Seguinot [ctb], Benoit Thieurmel [ctb], Titouan Robert [ctb], Jalal-Edine Zawam [ctb], Etienne Sanchez [ctb], Janus De Bondt [ctb], Assil Mansouri [ctb], Abdallah Mahoudi [ctb], Clement Berthet [ctb], Kamel Kemiha [ctb], Nicolas Boitard [ctb], RTE [cph]

antaresEditObject_1.0.1.tar.gz
antaresEditObject_1.0.1.zip(r-4.7)antaresEditObject_1.0.1.zip(r-4.6)antaresEditObject_1.0.1.zip(r-4.5)
antaresEditObject_1.0.1.tgz(r-4.6-any)antaresEditObject_1.0.1.tgz(r-4.5-any)
antaresEditObject_1.0.1.tar.gz(r-4.7-any)antaresEditObject_1.0.1.tar.gz(r-4.6-any)
antaresEditObject_1.0.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
antaresEditObject/json (API)

# Install 'antaresEditObject' in R:

install.packages('antaresEditObject', repos = c('https://rte-antares-rpackage.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/rte-antares-rpackage/antareseditobject/issues

Pkgdown/docs site:https://rte-antares-rpackage.github.io

On CRAN:

antares-simulation cluster energy monte-carlo-simulation rte

8.99 score 8 stars 90 scripts 647 downloads 94 exports 67 dependencies

Last updated from:05e7761f20. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	230
source / vignettes	OK	214
linux-release-x86_64	OK	283
macos-release-arm64	OK	172
macos-oldrel-arm64	OK	129
windows-devel	OK	236
windows-release	OK	276
windows-oldrel	OK	229
wasm-release	OK	157

Exports:activateRES activateST adequacyOptions api_patch backupStudy checkRemovedArea cleanUpOutput clearScenarioBuilder computeOtherFromHourlyMulti computeOtherFromHourlyYear computeTimeStampFromHourly convertConfigToAdq copyOutput copyStudyWeb create_scb_referential_series_type createArea createBindingConstraint createBindingConstraintBulk createCluster createClusterBulk createClusterRES createClusterST createDistrict createDSR createLink createPSP createStudy createStudyAPI createVariant deduplicateScenarioBuilder deleteStudy dicoGeneralSettings dicoOptimizationSettings dicoOutputSettings editArea editBindingConstraint editCluster editClusterRES editClusterST editDistrict editDSR editLink editPSP filteringOptions getCapacityDSR getCapacityPSP getJobLogs getJobs getPlaylist getVariantCommands group_values_meta_check importZipStudyWeb is_antares_v7 is_antares_v820 list_pollutants_values mockSimulationAPI nodalOptimizationOptions propertiesLinkOptions readScenarioBuilder removeArea removeBindingConstraint removeCluster removeClusterRES removeClusterST removeDistrict removeLink runSimulation runTsGenerator scenarioBuilder searchStudy setAPImode setPlaylist setSolverPath setThematicTrimming storage_values_default updateAdequacySettings updateGeneralSettings updateInputSettings updateOptimizationSettings updateOutputSettings updateScenarioBuilder useVariant writeEconomicOptions writeHydroValues writeIni writeIniAPI writeIniFile writeIniHydro writeInputTS writeMiscGen writeOutputValues writeSeriesPrepro writeVariantCommands writeWaterValues

Dependencies:antaresRead arrow askpass assertthat base64enc bit bit64 bslib cachem cli codetools commonmark cpp11 curl data.table digest doFuture doParallel fastmap fontawesome foreach fs future future.apply generics globals glue htmltools httpuv httr iterators jquerylib jsonlite later lifecycle listenv lubridate magrittr memoise memuse mime openssl otel parallelly pbapply plyr progressr promises purrr R6 rappdirs Rcpp rlang sass shiny sourcetools stringi stringr sys tidyselect timechange vctrs whisker withr xtable yaml zip

Antares new features v9.2

Rendered fromAntares_new_features_v920.Rmdusingknitr::rmarkdown

Last update: 2025-10-24
Started: 2025-04-24

Antares new features v9.3

Rendered fromAntares_new_features_v930.Rmdusingknitr::rmarkdown

Last update: 2025-10-24
Started: 2025-10-24

Antares new features v8.6.0

Rendered fromAntares_new_features_v860.Rmdusingknitr::rmarkdown

Last update: 2025-04-24
Started: 2023-09-15

Variant management with API

Rendered fromapi-variant-management.Rmdusingknitr::rmarkdown

Last update: 2025-04-24
Started: 2022-02-07

User guide

Rendered fromantaresEditObject.Rmdusingknitr::rmarkdown

Last update: 2024-10-03
Started: 2019-12-11

Renewables Energy Sources

Activate RES | Manipulate clusters | Scenario builder

Rendered fromrenewables-energy-sources.Rmdusingknitr::rmarkdown

Last update: 2023-10-03
Started: 2021-10-19

Scenario Builder

Rendered fromscenario-builder.Rmdusingknitr::rmarkdown

Last update: 2023-10-03
Started: 2021-10-19

Help page	Topics
Edit area's parameters in API mode.	.api_command_execute_edit_area
Edit area's ui in API mode.	.api_command_execute_edit_area_ui
Format a value to a suitable format to rhs in an .ini file.	.format_ini_rhs
Generate playlist_year_weight section in the appropriate format.	.format_playlist_weights
Generate the data for the ui part by study mode.	.format_ui_data_by_mode
Initialize links data for a new area. For disk mode only.	.initializeLinksArea
Initialize renewables data for a new area. For disk mode only.	.initializeRenewablesArea
Initialize thermal data for a new area. For disk mode only.	.initializeThermalArea
Split list nodalOptimization by target file.	.split_nodalOptimization_by_target
Activate RES in an Antares study	activateRES
Activate st-storage in an Antares study	activateST
Add week number column to a data.time of time series type	add_week_number_column_to_ts
Adequacy patch parameters for creating an area	adequacyOptions
API methods	api_patch
Create a backup with an Antares Study	backupStudy
For a given area, check consistency between reservoir and reservoir capacity values	check_consistency_reservoir_values
Check if mingen data and hydro storage data are consistent	check_mingen_vs_hydro_storage
Check if mingen data and maxpower data are consistent	check_mingen_vs_maxpower
Is study an Antares v7 study ?	check-version is_antares_v7 is_antares_v820
Seek for a removed area	checkRemovedArea
Clean up output based on geographic trimming	cleanUpOutput
Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)	computeOtherFromHourlyMulti
Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)	computeOtherFromHourlyYear
Compute daily, weekly, monthly and annual mc-ind from hourly data.	computeTimeStampFromHourly
Read adequacy patch config.yml into Antares (v8.5+)	convertConfigToAdq
Copy of the output files of an Antares study	copyOutput
Import physical study to Antares Web (managed study)	copyStudyWeb
Create the correspondence data frame between the symbol and the type in scenario builder	create_scb_referential_series_type
Create an empty Antares study	create-study createStudy createStudyAPI
Create an area in an Antares study	createArea
Create a binding constraint	createBindingConstraint
Create multiple binding constraint at once.	createBindingConstraintBulk
Create a cluster	createCluster createClusterRES
Create serial thermal cluster	createClusterBulk
Create a short-term storage cluster	createClusterST
Create a district	createDistrict
Create a Demand Side Response (DSR)	createDSR editDSR getCapacityDSR
Create a link between two areas	createLink
Create a Pumped Storage Power plant (PSP)	createPSP editPSP getCapacityPSP
Delete a study or a simulation	deleteStudy
Detect a pattern in a binding constraint coefficient	detect_pattern_in_binding_constraint
Correspondence between arguments of 'updateAdequacySettings' and actual Antares parameters.	dicoAdequacySettings
Correspondence between arguments of 'updateGeneralSettings' and actual Antares parameters.	dicoGeneralSettings
Correspondence between arguments of 'updateOptimizationSettings' and actual Antares parameters.	dicoOptimizationSettings
Correspondence between arguments of 'updateOutputSettings' and actual Antares parameters.	dicoOutputSettings
Edit an area in an Antares study	editArea
Update an existing binding constraint	editBindingConstraint
Edit an existing cluster	editCluster editClusterRES
Edit a short-term storage cluster	editClusterST
Edit a district in an Antares study	editDistrict
Edit a link between two areas	editLink
Write default values in hydro.ini file if the section is empty	fill_empty_hydro_ini_file
Write default input time series if 'mingen.txt' or/and 'mod.txt' is empty	fill_empty_hydro_ts_file
Output profile options for creating an area	filteringOptions
Get default hydro.ini values	get_default_hydro_ini_values
Get the type of control to execute using the 3 necessary booleans	get_type_check_mingen_vs_hydrostorage
Get the type of control to execute between mingen data and hydro storage data	get_type_check_mingen_vs_hydrostorage_to_trigger
Get the type of control to execute between mingen data and maxpower data	get_type_check_mingen_vs_maxpower_to_trigger
Retrieve job log from API	getJobLogs
Retrieve API jobs	getJobs
Import a local study to Antares Web	importZipStudyWeb
Output pollutants list for thermal clusters	list_pollutants_values
Mock API usage	mockSimulationAPI
Nodal optimization parameters for creating an area	nodalOptimizationOptions
Get the playlist of an Antares study	getPlaylist playlist setPlaylist
Properties for creating a link	propertiesLinkOptions
Remove an area from an Antares study	removeArea
Remove a Binding Constraint	removeBindingConstraint
Remove a cluster	removeCluster removeClusterRES removeClusterST
Remove a district	removeDistrict
Remove a link between two areas	removeLink
Replicate a data.table as many times as needed to get the same number of time series between 2 data.tables	replicate_missing_ts
Rollback to previous hydro data if the data is not consistent	rollback_to_previous_data
Run an Antares Simulation	runSimulation
Run Time-Series Generator	runTsGenerator
Read, create, update & deduplicate scenario builder	clearScenarioBuilder deduplicateScenarioBuilder readScenarioBuilder scenario-builder scenarioBuilder updateScenarioBuilder
Search study in AntaREST	searchStudy
Set API mode	setAPImode
Set path to Antares Solver	setSolverPath
Set the thematic trimming of an Antares Study	setThematicTrimming
Short Term Storage Property List	storage_values_default
Update a specific section in generaldata.ini file	update_generaldata_by_section
Update adequacy parameters of an Antares study	updateAdequacySettings
Update general parameters of an Antares study	updateGeneralSettings
Update input parameters of an Antares study	updateInputSettings
Update optimization parameters of an Antares study	updateOptimizationSettings
Update output parameters of an Antares study	updateOutputSettings
Create a study's variant	createVariant useVariant variant
Get API commands generated	getVariantCommands variant-commands writeVariantCommands
Write configuration options in file or API	write-ini writeIni writeIniAPI writeIniFile
Write Economic Options	writeEconomicOptions
Write Hydro Values	writeHydroValues
Edit hydro.ini values	writeIniHydro
Write input time series	writeInputTS
Write Misc Gen data	writeMiscGen
Write output value for Antares	writeOutputValues
Write prepro data	writeSeriesPrepro
Write water values	writeWaterValues

Package: antaresEditObject 1.0.1

antaresEditObject: Edit an 'Antares' Simulation

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)