antaresEditObject

Edit an Antares study before running simulation.

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.

You can install the package with :

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")

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 = "fr", 
  cluster_name = "myareacluster",
  group = "other",
  unitcount = 1,
  nominalcapacity = 8400,
  `min-down-time` = 0,
  `marginal-cost` = 0.010000,
  `market-bid-cost` = 0.010000
)

Create a new link

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

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)
)

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")