View source: R/runSimulation.R
runSimulation | R Documentation |
Run an ANTARES study
runSimulation( name, mode = "economy", path_solver = getOption("antares.solver"), wait = TRUE, show_output_on_console = FALSE, parallel = TRUE, ..., opts = antaresRead::simOptions() )
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
|
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.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.