runWaterValuesSimulation: Run a simulation for calculating water values for a specific...

In rte-antares-rpackage/antaresWaterValues: Generating water values for Antares

Run a simulation for calculating water values for a specific area

Description

Run a simulation for calculating water values for a specific area

Usage

runWaterValuesSimulation(
  area,
  simulation_name = "wv_sim_%s",
  nb_disc_stock = 10,
  nb_mcyears = NULL,
  binding_constraint = "WeeklyWaterAmount",
  fictive_area = NULL,
  thermal_cluster = NULL,
  path_solver = NULL,
  wait = TRUE,
  show_output_on_console = FALSE,
  overwrite = FALSE,
  link_from = NULL,
  remove_areas = NULL,
  opts = antaresRead::simOptions(),
  shiny = F,
  otp_dest = NULL,
  file_name = NULL,
  pumping = F,
  efficiency = NULL,
  launch_simulations = T,
  reset_hydro = T,
  constraint_values = NULL,
  expansion = T,
  ...
)

Arguments

area	area
simulation_name	character
nb_disc_stock	integer
nb_mcyears	list
binding_constraint	character
fictive_area	Name of the fictive area to create, argument passed to setupWaterValuesSimulation.
thermal_cluster	Name of the thermal cluster to create, argument passed to setupWaterValuesSimulation.
path_solver	Character containing the Antares Solver path, argument passed to runSimulation.
wait	Argument passed to runSimulation.
show_output_on_console	Argument passed to runSimulation.
overwrite	If area or cluster already exists, should they be overwritten?
link_from	area that will be linked to the created fictive area. If it's NULL it will takes the area concerned by the simulation.
remove_areas	Character vector of area(s) to remove from the created district.
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath
shiny	Boolean. True to run the script in shiny mod.
otp_dest	the path in which the script save Rdata file.
file_name	the Rdata file name.
pumping	Boolean. True to take into account the pumping.
efficiency	in [0,1]. efficient ratio of pumping.
launch_simulations	Boolean. True to to run the simulations.
reset_hydro	Boolean. True to reset hydro inflow to 0 before the simulation.
constraint_values	constraint values to use to run simulations, generated by the function constraint_generator
expansion	Binary. True if mode expansion was used to run simulations
...	further arguments passed to or from other methods.

Note

This function have side effects on the Antares study used, a fictive area is created and a new district as well.

rte-antares-rpackage/antaresWaterValues documentation built on Nov. 6, 2024, 11:17 p.m.