scenario-builder | R Documentation |
Read, create & update scenario builder.
scenarioBuilder( n_scenario, n_mc = NULL, areas = NULL, areas_rand = NULL, opts = antaresRead::simOptions() ) readScenarioBuilder( ruleset = "Default Ruleset", as_matrix = TRUE, opts = antaresRead::simOptions() ) updateScenarioBuilder( ldata, ruleset = "Default Ruleset", series = NULL, clusters_areas = NULL, links = NULL, opts = antaresRead::simOptions() ) clearScenarioBuilder( ruleset = "Default Ruleset", opts = antaresRead::simOptions() )
n_scenario |
Number of scenario. |
n_mc |
Number of Monte-Carlo years. |
areas |
Areas to use in scenario builder, if |
areas_rand |
Areas for which to use |
opts |
List of simulation parameters returned by the function
|
ruleset |
Ruleset to read. |
as_matrix |
If |
ldata |
A |
series |
Name(s) of the serie(s) to update if |
clusters_areas |
A |
links |
Links to use if series is |
scenarioBuilder
: a matrix
readScenarioBuilder
: a list
of matrix
or list
according to as_matrix
parameters.
series = "ntc"
is only available with Antares >= 8.2.0.
## Not run: library(antaresRead) library(antaresEditObject) # simulation path setSimulationPath( path = "pat/to/simulation", simulation = "input" ) # Create a scenario builder matrix sbuilder <- scenarioBuilder( n_scenario = 51, n_mc = 2040, areas_rand = c("fr", "be") ) sbuilder[, 1:6] dim(sbuilder) # Read previous scenario builder # in a matrix format prev_sb <- readScenarioBuilder() # Update scenario builder # for load serie updateScenarioBuilder(ldata = sbuilder, series = "load") # equivalent as updateScenarioBuilder(ldata = list(l = sbuilder)) # update several series # same input sbuilder updateScenarioBuilder( ldata = sbuilder, series = c("load", "hydro", "solar") ) # different input updateScenarioBuilder(ldata = list( l = load_sb, h = hydro_sb, s = solar_sb )) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.