Learn R Programming

antaresRead (version 3.2.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

897

Version

3.2.0

License

GPL (>= 2) | file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Tatiana Vargas

Last Published

November 16th, 2026

Functions in antaresRead (3.2.0)

readOptimCriteria

Read Optimization Criteria
setRam

Specify RAM limit
readLayout

Read areas layout
setSimulationPath

Set Path to an Antares simulation
readInputTS

Read Input time series
readInputThermal

Read Input thermal time series
showAliases

show aliases for variables
read_storages_constraints

Read Short-term storages / additional constraints
setTimeoutAPI

Change API Timeout
subset.antaresDataList

Subset an antaresDataList
setHvdcAreas

Set hvdc areas
removeVirtualAreas

Remove virtual areas
writeDigest

Write digest file
viewAntares

View the content of an antares output
summary.bindingConstraints

Display equation of binding constraint
simOptions

Extract simulation options
API-methods

API methods
parAggregateMCall

Creation of Mc_all new (only antares > V6)
.filter_bindingConstraints_by_names

Filter a list of binding constraints by names by a exact match
.transform_antares_version

Convert the Antares number version
changeTimeStep

Change the timestep of an output
as.antaresDataTable

Convert objects to antaresDataTable
getAreas

Select and exclude areas
hvdcModification

hvdc straitement
getThematicTrimming

Get the Thematic trimming of an Antares study
readAntaresAreas

Read output for a list of areas
getGeographicTrimming

Read geographic trimming (filtering) options
getIdCols

get Id columns
getLinks

Retrieve links connected to a set of areas
readDigestFile

Read digest file
.download_api_aggregate_result

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

Copy data to the clipboard
antaresRead-package

antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation
as.antaresDataList

Convert objects to antaresDataTable
readInputRES

Read Input RES time series
list_thematic_variables

List of thematic trimming variables available according to study version
.writeIni

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

Merge two digests
extractDataList

Format data PPSE-style
readAntares

Read the data of an Antares simulation
readAntaresClusters

Read output for a list of clusters
ponderateMcAggregation

Mcyear aggregation weigthed by wd
read-ini

Read configuration options from file or API
readAntaresSTClusters

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

Read binding constraints
readClusterDesc

Import clusters description