runWaterValuesSimulationMultiStock: 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

runWaterValuesSimulationMultiStock(
  list_areas,
  list_pumping,
  list_efficiency,
  simulation_name = "wv_sim_%s",
  nb_mcyears = NULL,
  binding_constraint = "WeeklyWaterAmount",
  path_solver = NULL,
  wait = TRUE,
  show_output_on_console = FALSE,
  overwrite = FALSE,
  opts = antaresRead::simOptions(),
  shiny = F,
  otp_dest = NULL,
  file_name = NULL,
  launch_simulations = T,
  reset_hydro = T,
  constraint_values = NULL,
  ...
)

Arguments

list_areas	List of areas concerned by the simulation.
list_pumping	List of bools to tell if pumping is available in areas
list_efficiency	List of pumping efficiency
simulation_name	character
nb_mcyears	list
binding_constraint	character
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?
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.
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
...	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 April 24, 2024, 7:25 a.m.