Run OptirrigPTGE scenarios

Usage

run_optirrigptge(
  verbose = TRUE,
  parallelize = FALSE,
  parallel_strategy = future::multicore,
  parallel_workers = future::availableCores() - 1,
  scenarios_groups_ids,
  scenarios_subgroups_ids = get_scenarios_subgroups_ids(scenarios_groups_ids =
    scenarios_groups_ids, ..., cfg = cfg),
  timestamp = format(Sys.time(), "%Y%m%d_%H%M%S"),
  running_scenarios = get_running_scenarios(scenarios_subgroups_ids =
    scenarios_subgroups_ids, timestamp = timestamp, ..., cfg = cfg),
  data_storage = "s3",
  recreate = FALSE,
  optirrig_core_package = "OptirrigPTGE",
  ...,
  write_results = cfg$data$write_results,
  return_outputs = FALSE,
  cfg = loadConfig()
)

Arguments

verbose: logical Whether to print logs to the console.
parallelize: logical Whether to parallelize process
parallel_strategy: function The parallel strategy to use. See future::plan()
parallel_workers: integer The number of workers to use for parallelization.
scenarios_groups_ids: character The scenario groups IDs to run.
scenarios_subgroups_ids: character The scenario subgroups IDs to run. See get_scenarios_subgroups_ids()
timestamp: character The timestamp to use for the running scenarios.
running_scenarios: data.frame A data frame containing the scenarios to run. See get_running_scenarios()
data_storage: character The data storage to use.
recreate: logical Whether to recreate the outputs if they already exist.
optirrig_core_package: character The Optirrig core package to use.
...: Additional arguments to pass to the run_scenario_with_* function.
write_results: logical If TRUE writes the results in the data folder. See returned value of loadConfig.
return_outputs: logical Whether to return the simulation outputs
cfg: a config object. Configuration to use. See loadConfig for details

Value

list A list of outputs for each scenario if return_outputs is TRUE, otherwise NULL.