runWaterValuesSimulation.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/runWaterValuesSimulation.R
\name{runWaterValuesSimulation}
\alias{runWaterValuesSimulation}
\title{Run a simulation for calculating water values for a specific area}
\usage{
runWaterValuesSimulation(
  area,
  simulation_name = "weekly_water_amount_\%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,
  ...
)
}
\arguments{
\item{area}{The area concerned by the simulation.}

\item{simulation_name}{The name of the simulation, \code{s} is a placeholder for the constraint value defined by \code{nb_disc_stock}.}

\item{nb_disc_stock}{Number of simulation to launch, a vector of energy constraint
will be created from maximum pumping power to the hydro storage maximum and of length this parameter.}

\item{nb_mcyears}{Number of Monte Carlo years to simulate or a vector of years indexes to launch.}

\item{binding_constraint}{Name of the binding constraint.}

\item{fictive_area}{Name of the fictive area to create, argument passed to \code{\link{setupWaterValuesSimulation}}.}

\item{thermal_cluster}{Name of the thermal cluster to create, argument passed to \code{\link{setupWaterValuesSimulation}}.}

\item{path_solver}{Character containing the Antares Solver path, argument passed to \code{\link[antaresEditObject]{runSimulation}}.}

\item{wait}{Argument passed to \code{\link[antaresEditObject]{runSimulation}}.}

\item{show_output_on_console}{Argument passed to \code{\link[antaresEditObject]{runSimulation}}.}

\item{overwrite}{If area or cluster already exists, should they be overwritten?}

\item{link_from}{area that will be linked to the created fictive area. If it's
\code{NULL} it will takes the area concerned by the simulation.}

\item{remove_areas}{Character vector of area(s) to remove from the created district.}

\item{opts}{List of simulation parameters returned by the function
\code{antaresRead::setSimulationPath}}

\item{shiny}{Boolean. True to run the script in shiny mod.}

\item{otp_dest}{the path in which the script save Rdata file.}

\item{file_name}{the Rdata file name.}

\item{pumping}{Boolean. True to take into account the pumping.}

\item{efficiency}{in [0,1]. efficient ratio of pumping.}

\item{launch_simulations}{Boolean. True to to run the simulations.}

\item{reset_hydro}{Boolean. True to reset hydro inflow to 0 before the simulation.}

\item{...}{further arguments passed to or from other methods.}
}
\description{
Run a simulation for calculating water values for a specific area
}
\note{
This function have side effects on the Antares study used, a fictive area is created and a new district as well.
}