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.3.0

License

GPL (>= 2) | file LICENSE

Issues

3

Pull Requests

1

Stars

8

Forks

6

Maintainer

Veronique Bachelier

Last Published

November 8th, 2021

Functions in antaresEditObject (0.3.0)

checkRemovedArea

Seek for a removed area
copyOutput

Copy of the output files of an Antares study
createDSR

Create a Demand Side Response (DSR)
createArea

Create An Area In An Antares Study
activateRES

Activate RES in an Antares study
create-cluster

Create a cluster
createBindingConstraint

Create a Binding Constraint
createDistrict

Create a district
computeTimeStampFromHourly

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

Create a backup with an Antares Study
editLink

Edit a link between two areas
createStudy

Create an empty Antares study
removeBindingConstraint

Remove a Binding Constraint
removeArea

Remove An Area From inputs
createPSP

Create a Pumped Storage Power plant (PSP)
createLink

Create a link between two areas
readIniFile

Read a INI file
editArea

Edit An Existing Area In An Antares Study
editBindingConstraint

Update An Existing Binding Constraint
remove-cluster

Remove a cluster
runTsGenerator

Run Time-Series Generator
scenario-builder

Read, create & update scenario builder
writeIni

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

Write Economic Options
filteringOptions

Output profile options for creating an area
writeSeriesPrepro

Write prepro data
writeWaterValues

Write water values
updateGeneralSettings

Update general parameters of an Antares study
getPlaylist

Get the playlist of an Antares study
is_antares_v7

Is study an Antares v7 study ?
updateInputSettings

Update input parameters of an Antares study
dicoOptimizationSettings

Correspondence between arguments of updateOptimizationSettings and actual Antares parameters.
dicoGeneralSettings

Correspondence between arguments of updateGeneralSettings and actual Antares parameters.
runSimulation

Run an Antares Simulation
removeLink

Remove a link between two areas
edit-cluster

Edit an existing cluster
nodalOptimizationOptions

Nodal optimization parameters for creating an area
setSolverPath

Set path to Antares Solver
writeOutputValues

Write output value for Antares
writeInputTS

Write input time series
setPlaylist

Set the playlist of an Antares Study
propertiesLinkOptions

Properties for creating a link
updateOutputSettings

Update output parameters of an Antares study
updateOptimizationSettings

Update optimization parameters of an Antares study