Learn R Programming

antaresRead (version 3.0.0)

Import, Manipulate and Explore the Results of an 'Antares' Simulation

Description

Import, manipulate and explore results generated by 'Antares', a powerful open source software developed by RTE (Réseau de Transport d’Électricité) to simulate and study electric power systems (more information about 'Antares' here : ).

Copy Link

Version

Install

install.packages('antaresRead')

Monthly Downloads

794

Version

3.0.0

License

GPL (>= 2) | file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Tatiana Vargas

Last Published

January 28th, 2026

Functions in antaresRead (3.0.0)

list_thematic_variables

List of thematic trimming variables available according to study version
getAreas

Select and exclude areas
setRam

Specify RAM limit
setSimulationPath

Set Path to an Antares simulation
summary.bindingConstraints

Display equation of binding constraint
readClusterDesc

Import clusters description
subset.antaresDataList

Subset an antaresDataList
readAntaresAreas

Read output for a list of areas
removeVirtualAreas

Remove virtual areas
readAntares

Read the data of an Antares simulation
setTimeoutAPI

Change API Timeout
readOptimCriteria

Read Optimization Criteria
readLayout

Read areas layout
read_storages_constraints

Read Short-term storages / additional constraints
readDigestFile

Read digest file
mergeDigests

Merge two digests
readInputRES

Read Input RES time series
simOptions

Extract simulation options
getGeographicTrimming

Read geographic trimming (filtering) options
showAliases

show aliases for variables
readAntaresSTClusters

Read output for a list of short-term storage clusters
readAntaresClusters

Read output for a list of clusters
setHvdcAreas

Set hvdc areas
writeDigest

Write digest file
viewAntares

View the content of an antares output
readInputThermal

Read Input thermal time series
readInputTS

Read Input time series
.filter_bindingConstraints_by_names

Filter a list of binding constraints by names by a exact match
changeTimeStep

Change the timestep of an output
API-methods

API methods
antaresRead-package

antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation
parAggregateMCall

Creation of Mc_all new (only antares > V6)
as.antaresDataList

Convert objects to antaresDataTable
copyToClipboard

Copy data to the clipboard
as.antaresDataTable

Convert objects to antaresDataTable
.download_api_aggregate_result

Retrieve information on a file's state of preparation and retrieve download file.
getIdCols

get Id columns
hvdcModification

hvdc straitement
getThematicTrimming

Get the Thematic trimming of an Antares study
extractDataList

Format data PPSE-style
getLinks

Retrieve links connected to a set of areas
ponderateMcAggregation

Mcyear aggregation weigthed by wd
readBindingConstraints

Read binding constraints
read-ini

Read configuration options from file or API
.writeIni

Write ini file from list obtain by antaresRead::readIniFile and modify by user
.transform_antares_version

Convert the Antares number version