Learn R Programming

antaresRead (version 2.9.2)

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

1,522

Version

2.9.2

License

GPL (>= 2) | file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Tatiana Vargas

Last Published

September 23rd, 2025

Functions in antaresRead (2.9.2)

mergeDigests

Merge two digests
ponderateMcAggregation

Mcyear aggregation weigthed by wd
readClusterDesc

Import clusters description
readBindingConstraints

Read binding constraints
readDigestFile

Read digest file
readInputRES

Read Input RES time series
readAntaresClusters

Read output for a list of clusters
readAntaresSTClusters

Read output for a list of short-term storage clusters
read-ini

Read configuration options from file or API
readInputTS

Read Input time series
showAliases

show aliases for variables
setHvdcAreas

Set hvdc areas
readAntaresAreas

Read output for a list of areas
readInputThermal

Read Input thermal time series
readAntares

Read the data of an Antares simulation
readOptimCriteria

Read Optimization Criteria
readLayout

Read areas layout
read_storages_constraints

Read Short-term storages / additional constraints
removeVirtualAreas

Remove virtual areas
subset.antaresDataList

Subset an antaresDataList
simOptions

Extract simulation options
setTimeoutAPI

Change API Timeout
summary.bindingConstraints

Display equation of binding constraint
setRam

Specify RAM limit
writeDigest

Write digest file
viewAntares

View the content of an antares output
setSimulationPath

Set Path to an Antares simulation
as.antaresDataTable

Convert objects to antaresDataTable
parAggregateMCall

Creation of Mc_all new (only antares > V6)
copyToClipboard

Copy data to the clipboard
as.antaresDataList

Convert objects to antaresDataTable
antaresRead-package

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

Filter a list of binding constraints by names by a exact match
API-methods

API methods
.download_api_aggregate_result

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

Change the timestep of an output
getThematicTrimming

Get the Thematic trimming of an Antares study
hvdcModification

hvdc straitement
list_thematic_variables

List of thematic trimming variables available according to study version
getIdCols

get Id columns
extractDataList

Format data PPSE-style
getLinks

Retrieve links connected to a set of areas
getAreas

Select and exclude areas
.transform_antares_version

Convert the Antares number version
.writeIni

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

Read geographic trimming (filtering) options