Package: antaresRead 2.9.0

Tatiana Vargas

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

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 : <https://antares-simulator.org/>).

Authors:Tatiana Vargas [aut, cre], Jalal-Edine ZAWAM [aut], Frederic Breant [ctb], Francois Guillem [aut], Benoit Thieurmel [aut], Titouan Robert [aut], Victor Perrier [ctb], Etienne Sanchez [ctb], Assil Mansouri [ctb], Clement Berthet [ctb], Kamel Kemiha [ctb], Abdallah Mahoudi [ctb], Nicolas Boitard [ctb], RTE [cph]

antaresRead_2.9.0.tar.gz
antaresRead_2.9.0.zip(r-4.5)antaresRead_2.9.0.zip(r-4.4)antaresRead_2.9.0.zip(r-4.3)
antaresRead_2.9.0.tgz(r-4.5-any)antaresRead_2.9.0.tgz(r-4.4-any)antaresRead_2.9.0.tgz(r-4.3-any)
antaresRead_2.9.0.tar.gz(r-4.5-noble)antaresRead_2.9.0.tar.gz(r-4.4-noble)
antaresRead_2.9.0.tgz(r-4.4-emscripten)antaresRead_2.9.0.tgz(r-4.3-emscripten)
antaresRead.pdf |antaresRead.html✨
antaresRead/json (API)
NEWS

# Install 'antaresRead' in R:
install.packages('antaresRead', repos = c('https://rte-antares-rpackage.r-universe.dev', 'https://cloud.r-project.org'))

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

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

On CRAN:

infrastructuredataimportadequacybilanelectricityenergyhdf5linear-algebramonte-carlo-simulationoptimisationprevisionnelrhdf5rtesimulationtyndp

9.32 score 13 stars 3 packages 148 scripts 953 downloads 48 exports 54 dependencies

Last updated 6 days agofrom:47b6c3ed52. Checks:8 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKFeb 13 2025
R-4.5-winOKFeb 13 2025
R-4.5-macOKFeb 13 2025
R-4.5-linuxOKFeb 13 2025
R-4.4-winOKFeb 13 2025
R-4.4-macOKFeb 13 2025
R-4.3-winOKFeb 13 2025
R-4.3-macOKFeb 13 2025

Exports:aggregateResultapi_deleteapi_getapi_postapi_putas.antaresDataListas.antaresDataTablechangeTimeStepcopyToClipboardextractDataListgetAliasgetAreasgetDistrictsgetGeographicTrimminggetIdColsgetLinkshvdcModificationmergeDigestsparAggregateMCallponderateMcAggregationreadAntaresreadAntaresAreasreadAntaresClustersreadAntaresSTClustersreadBindingConstraintsreadClusterDescreadClusterResDescreadClusterSTDescreadDigestFilereadInireadIniAPIreadIniFilereadInputRESreadInputThermalreadInputTSreadLayoutreadOptimCriteriaremoveVirtualAreassetAliassetHvdcAreassetRamsetSimulationPathsetSimulationPathAPIsetTimeoutAPIshowAliasessimOptionsviewAntareswriteDigest

Dependencies:askpassassertthatbase64encbitbit64bslibcachemclicodetoolscommonmarkcpp11crayoncurldata.tabledigestdoParallelfastmapfontawesomeforeachfsgenericsgluehtmltoolshttpuvhttriteratorsjquerylibjsonlitelaterlifecyclelubridatemagrittrmemoisememusemimeopensslpbapplyplyrpromisespurrrR6rappdirsRcpprlangsassshinysourcetoolsstringistringrsystimechangevctrswithrxtable

The 'antaresRead' Package

François Guillem

Rendered fromantaresRead.Rmdusingknitr::rmarkdownon Feb 13 2025.

Last update: 2020-02-21
Started: 2020-02-21

Readme and manuals

Help Manual

Help pageTopics
API methodsAPI-methods api_delete api_get api_post api_put
Convert objects to antaresDataTableas.antaresDataList as.antaresDataList.antaresDataTable as.antaresDataList.data.frame
Convert objects to antaresDataTableas.antaresDataTable as.antaresDataTable.data.frame
Change the timestep of an outputchangeTimeStep
Copy data to the clipboardcopyToClipboard copyToClipboard.antaresDataList
Format data PPSE-styleextractDataList
Select and exclude areasgetAreas getDistricts
Read geographic trimming (filtering) optionsgetGeographicTrimming
get Id columnsgetIdCols
Retrieve links connected to a set of areasgetLinks
hvdc straitementhvdcModification
Merge two digestsmergeDigests
Creation of Mc_all new (only antares > V6)aggregateResult parAggregateMCall
Mcyear aggregation weigthed by wdponderateMcAggregation
Read configuration options from file or APIread-ini readIni readIniAPI readIniFile
Read the data of an Antares simulationreadAntares
Read output for a list of areasreadAntaresAreas
Read output for a list of clustersreadAntaresClusters
Read output for a list of short-term storage clustersreadAntaresSTClusters
Read binding constraintsreadBindingConstraints
Import clusters descriptionreadClusterDesc readClusterResDesc readClusterSTDesc
Read digest filereadDigestFile
Read Input RES time seriesreadInputRES
Read Input thermal time seriesreadInputThermal
Read Input time seriesreadInputTS
Read areas layoutreadLayout
Read Optimization CriteriareadOptimCriteria
Remove virtual areasremoveVirtualAreas
Set hvdc areassetHvdcAreas
Specify RAM limitsetRam
Set Path to an Antares simulationsetSimulationPath setSimulationPathAPI
Change API TimeoutsetTimeoutAPI
show aliases for variablesgetAlias setAlias showAliases
Extract simulation optionssimOptions
Subset an antaresDataListsubset.antaresDataList
Display equation of binding constraintsummary.bindingConstraints
View the content of an antares outputviewAntares
Write digest filewriteDigest