editClusterST: Edit a short-term storage cluster

In rte-antares-rpackage/antaresEditObject: Edit an 'Antares' Simulation

Edit a short-term storage cluster

Description

Edit parameters and time series of an existing st-storage cluster (Antares studies >= v8.6.0).

Usage

editClusterST(
  area,
  cluster_name,
  group = NULL,
  storage_parameters = NULL,
  PMAX_injection = NULL,
  PMAX_withdrawal = NULL,
  inflows = NULL,
  lower_rule_curve = NULL,
  upper_rule_curve = NULL,
  add_prefix = TRUE,
  opts = antaresRead::simOptions()
)

Arguments

area	The area where to create the cluster.
cluster_name	Name for the cluster, it will prefixed by area name, unless you set add_prefix = FALSE.
group	Group of the cluster, one of : "PSP_open", "PSP_closed", "Pondage", "Battery", "Other". It corresponds to the type of stockage.
storage_parameters	Parameters to write in the Ini file.
PMAX_injection	modulation of charging capacity on an 8760-hour basis. The values are float between 0 and 1.
PMAX_withdrawal	modulation of discharging capacity on an 8760-hour basis. The values are float between 0 and 1.
inflows	imposed withdrawals from the stock for other uses, The values are integer.
lower_rule_curve	This is the lower limit for filling the stock imposed each hour. The values are float between 0 and 1.
upper_rule_curve	This is the upper limit for filling the stock imposed each hour. The values are float between 0 and 1.
add_prefix	If TRUE (the default), cluster_name will be prefixed by area name.
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath()

Value

An updated list containing various information about the simulation.

See Also

createClusterST() to edit existing clusters, removeClusterST() to remove clusters.

rte-antares-rpackage/antaresEditObject documentation built on Feb. 19, 2025, 6:47 p.m.