Learn R Programming
⚠️There's a newer version (0.9.0) of this package.Take me there.

antaresEditObject

Edit an Antares study before running a simulation.

Installation

Install from CRAN:

install.packages("antaresEditObject")

Or install dev version from GitHub:

remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)

Goal

This package allows to edit an Antares study. Methods are provided to create (and remove) areas, links between them, thermal clusters and binding constraints. These steps may be useful before running an Antares simulation.

See website for more documentation: https://rte-antares-rpackage.github.io/antaresEditObject/

Usage

Usage of the package is detailed in the vignette: vignette("antaresEditObject").

Copy Link

Version

Install

install.packages('antaresEditObject')

Monthly Downloads

506

Version

0.5.1

License

GPL (>= 2) | file LICENSE

Issues

3

Pull Requests

1

Stars

8

Forks

6

Maintainer

Veronique Bachelier

Last Published

April 6th, 2023

Functions in antaresEditObject (0.5.1)

createDistrict

Create a district
create-study

Create an empty Antares study
edit-cluster

Edit an existing cluster
.hourlyToOther

Computation function for rebuild mc-ind daily, monthly and annual from hourly data.
deleteStudy

Delete a study
dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.
filteringOptions

Output profile options for creating an area
copyOutput

Copy of the output files of an Antares study
createLink

Create a link between two areas
createPSP

Create a Pumped Storage Power plant (PSP)
editLink

Edit a link between two areas
playlist

Get the playlist of an Antares study Antares API OK
remove-cluster

Remove a cluster
editBindingConstraint

Update an existing binding constraint
getJobs

Retrieve API jobs
getJobLogs

Retrieve job log from API
createClusterBulk

Create serial thermal cluster
editArea

Edit an area in an Antares study
propertiesLinkOptions

Properties for creating a link
removeArea

Remove an area from an Antares study
runSimulation

Run an Antares Simulation
runTsGenerator

Run Time-Series Generator
setAPImode

Set API mode
nodalOptimizationOptions

Nodal optimization parameters for creating an area
mockSimulationAPI

Mock API usage
writeHydroValues

Write Hydro Values
writeEconomicOptions

Write Economic Options
setSolverPath

Set path to Antares Solver
writeWaterValues

Write water values
updateOptimizationSettings

Update optimization parameters of an Antares study
updateInputSettings

Update input parameters of an Antares study
scenario-builder

Read, create & update scenario builder
variant

Create a study's variant
searchStudy

Search study in AntaREST
writeOutputValues

Write output value for Antares
write-ini

Write configuration options in file or API
writeSeriesPrepro

Write prepro data
updateGeneralSettings

Update general parameters of an Antares study
updateAdequacySettings

Update adequacy parameters of an Antares study
variant-commands

Get API commands generated
updateOutputSettings

Update output parameters of an Antares study
.dailyToWeekly

Computation function for rebuild mc-ind weekly from daily data.
removeLink

Remove a link between two areas
writeInputTS

Write input time series
dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.
removeBindingConstraint

Remove a Binding Constraint
writeMiscGen

Write Misc Gen data
copyStudyWeb

Import physical study to Antares Web (managed study)
checkRemovedArea

Seek for a removed area
adequacyOptions

Adequacy patch parameters for creating an area
computeOtherFromHourlyYear

Compute daily, weekly, monthly and annual mc-ind from hourly data for one year. (new)
computeTimeStampFromHourly

Compute daily, weekly, monthly and annual mc-ind from hourly data.
backupStudy

Create a backup with an Antares Study
activateRES

Activate RES in an Antares study
antaresRead-reexports

Re-exports from antaresRead
computeOtherFromHourlyMulti

Compute daily, weekly, monthly and annual mc-ind from hourly data multiyear. (new)
check-version

Is study an Antares v7 study ?
cleanUpOutput

Clean up output based on geographic trimming
createArea

Create an area in an Antares study
convertConfigToAdq

Read adequacy patch config.yml into Antares (v8.5+)
createDSR

Create a Demand Side Response (DSR)
create-cluster

Create a cluster
create-binding-constraint

Create a binding constraint