-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsimulation_names_values.Rd
34 lines (30 loc) · 1.03 KB
/
simulation_names_values.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/constraints_functions.R
\name{simulation_names_values}
\alias{simulation_names_values}
\title{simulations names and values generator}
\usage{
simulation_names_values(
area,
simulation_name,
nb_disc_stock,
pumping = F,
opts = antaresRead::simOptions()
)
}
\arguments{
\item{area}{The area concerned by the simulation.}
\item{simulation_name}{The used name of the simulation.}
\item{nb_disc_stock}{Number of simulation launched.}
\item{pumping}{Boolean. True to take into account the pumping.}
\item{opts}{List of simulation parameters returned by the function
\code{antaresRead::setSimulationPath}}
}
\description{
simulations names and values generator
}
\note{
This function have no side effects on the Antares study used.
It's used in case you forget to save the output of script \code{runWaterValuesSimulation} to generate the output.
The results are meaningless unless you already launched the \code{runWaterValuesSimulation} with the same parameters.
}