Edit an 'Antares' Simulation

Edit an 'Antares' simulation before running it : create new areas, links, thermal clusters or binding constraints or edit existing ones. Update 'Antares' general & optimization settings. 'Antares' is an open source power system generator, more information available here : < https://antares-simulator.org/>.

Overview

This package provide methods to create (and remove) area, links between them, thermal cluster and binding constraints. These steps maybe usefull before running an Antares simulation.

Install from CRAN:

install.packages("antaresEditObject")

Or install dev version from GitHub :

# with remotes
remotes::install_github("rte-antares-rpackage/antaresEditObject")
 
# or with install-github.me service (based on remotes) (Works well with RTE proxy)
source("https://install-github.me/rte-antares-rpackage/antaresEditObject")
 
# or with devtools
devtools::install_github("rte-antares-rpackage/antaresEditObject")

Prerequisites

You need to set the path to an Antares simulation in "input" mode :

antaresRead::setSimulationPath(path = "path/to/study", simulation = "input")

Or you can simply create a new study :

createStudy("path/to/study")

Save simulation

Before modifying your simulation, you can save it in an archive :

backupStudy(what = "input")

This will create a .tar.gz file in your simulation folder.

Create a new area

You can create a new area with :

library("antaresEditObject")
 
createArea(name = "myarea")
 
# The new area should appear here :
antaresRead::getAreas()

You can specify the localization of the area on the map, and also color.

There are two helper function for area parameters :

filteringOptions() for filtering options, like filter-year-by-year
nodalOptimizationOptions() for nodal optimizations options.

Create a new cluster

You can initialize a cluster with some parameters :

createCluster(
  area = "myarea", 
  cluster_name = "myareacluster",
  group = "other",
  unitcount = 1,
  nominalcapacity = 8400,
  `min-down-time` = 0,
  `marginal-cost` = 0.010000,
  `market-bid-cost` = 0.010000
)

You can edit the settings of an existing cluster :

editCluster(
  area = "myarea", 
  cluster_name = "myareacluster", 
  nominalcapacity = 10600.000
)

Create a new link

createLink(
  from = "area1", 
  to = "area2", 
  propertiesLink = propertiesLinkOptions(
    hurdles_cost = FALSE,
    transmission_capacities = "enabled"
  ), 
  dataLink = NULL
)

You can edit the settings of an existing link :

editLink(
  from = "area1",
  to = "area2",
  transmission_capacities = "infinite"
)

Create a binding constraint

createBindingConstraint(
  name = "myconstraint", 
  values = matrix(data = c(rep(c(19200, 0, 0), each = 366)), ncol = 3), 
  enabled = FALSE, 
  timeStep = "daily",
  operator = "both",
  coefficients = c("fr%myarea" = 1)
)

Create several Pumped Storage Power plant (PSP)

pspData <- data.frame(
  area = c("a", "b"), 
  installedCapacity = c(800,900)
)
 
createPSP(
  areasAndCapacities = pspData, 
  efficiency = 0.75
)

Create several Demand Side Response (DSR)

dsrData <- data.frame(
  area = c("a", "b"),
  unit = c(10,20), 
  nominalCapacity = c(100, 120),
  marginalCost = c(52, 65),
  hour = c(3, 7)
)
  
createDSR(dsrData)

Update general settings

For example, set the output of simulation year by year, and limit the number of Monte-Carlo years to 10 :

updateGeneralSettings(year.by.year = TRUE, nbyears = 10)

Remove methods

You can remove from input folder areas, links, clusters and binding constraints with remove* functions, e.g. :

removeArea("myarea")

Run Time-Series Generator

First, update general settings to activate time series to generate :

updateGeneralSettings(generate = "thermal")

Then run TS-generator:

runTsGenerator(
  path_solver = "C:/path/to/antares-solver.exe", 
  show_output_on_console = TRUE
)

Run an Antares simulation

Launch an Antares simulation from R :

runSimulation(
  name = "myAwesomeSimulation", 
  mode = "economy",
  path_solver = "C:/path/to/antares-solver.exe", 
  show_output_on_console = TRUE
)

News

antaresEditObject 0.1.6

Compatibility with Antares version 7

antaresEditObject 0.1.4

Initial release.
Added a NEWS.md file to track changes to the package.

Reference manual

install.packages("antaresEditObject")

0.2.2 by Veronique Bachelier, a month ago

Browse source code at https://github.com/cran/antaresEditObject

Authors: Veronique Bachelier [aut, cre] , Frederic Breant [aut] , Victor Perrier [aut] , Baptiste Seguinot [ctb] , Benoit Thieurmel [ctb] , Titouan Robert [ctb] , Jalal-Edine Zawam [ctb] , Etienne Sanchez [ctb] , Janus De Bondt [ctb] , RTE [cph]

Documentation: PDF Manual

GPL (>= 2) | file LICENSE license

Imports assertthat, grDevices, data.table, whisker, fs, doParallel, pbapply, parallel

Depends on antaresRead

Suggests testthat, covr, knitr, rmarkdown

See at CRAN

antaresEditObject

Edit an 'Antares' Simulation

Overview

Prerequisites

Save simulation

Create a new area

Create a new cluster

Create a new link

Create a binding constraint

Create several Pumped Storage Power plant (PSP)

Create several Demand Side Response (DSR)

Update general settings

Remove methods

Run Time-Series Generator

Run an Antares simulation

News

antaresEditObject 0.1.6

antaresEditObject 0.1.4

Reference manual

R links

R homepage

Download R

Mailing lists

R documentation

R manuals

R FAQs

The R Journal

CRAN links

CRAN homepage

CRAN repository policy

Submit a package

METACRAN stuff

About METACRAN

At github

Report a bug