runSimulation {antaresEditObject} | R Documentation |
Run an Antares Simulation
Description
Run an ANTARES study
Usage
runSimulation(
name,
mode = "economy",
path_solver = getOption("antares.solver"),
wait = TRUE,
show_output_on_console = FALSE,
parallel = TRUE,
...,
opts = antaresRead::simOptions()
)
Arguments
name |
Name of the simulation. In API mode, |
mode |
Simulation mode, can take value "economy", "adequacy" or "draft". |
path_solver |
Character containing the Antares Solver path |
wait |
Logical, indicating whether the R interpreter should wait for the simulation to finish, or run it asynchronously. |
show_output_on_console |
Logical, indicating whether to capture the ANTARES log and show it on the R console. |
parallel |
Logical. If |
... |
Additional arguments (API only), such as |
opts |
List of simulation parameters returned by the function
|
Value
In API mode it return a list
with either the job id in case of success of
the command or details about the error produce.
In non-API mode the function does not return anything, it is used to launch an
ANTARES simulation.