run_ensemble: Run Ensemble of lake models

View source: R/run_ensemble.R

run_ensembleR Documentation

Run Ensemble of lake models

Description

Run each of the lake models

Usage

run_ensemble(
  config_file,
  model = c("GOTM", "GLM", "Simstrat", "FLake", "MyLake"),
  folder = ".",
  verbose = FALSE,
  parallel = FALSE,
  ncores = NULL,
  return_list = FALSE,
  create_output = TRUE,
  add = FALSE
)

Arguments

config_file

filepath; to LakeEnsemblr yaml master config file

model

vector; model to export driving data. Options include c('GOTM', 'GLM', 'Simstrat', 'FLake', 'MyLake')

folder

filepath; to folder which contains the model folders generated by export_config()

verbose

Boolean; Should model output be shown in the console. Defaults to FALSE

parallel

Boolean; should the model calibration be parallelized

ncores

integer; number of cores to use for parallelization. Defaults to NULL. If NULL then the number of cores used is either the number of models selecte or the number of cores on the machine, whichever is smaller.

return_list

boolean; Return a list of dataframes of model output. Defaults to FALSE

create_output

boolean; Create ensemble output file otherwise it just runs the models and generates model output in their respective folders. Defaults to TRUE

add

boolean; Add results to an existing netcdf file with new dimension "member"


aemon-j/LakeEnsemblR documentation built on April 11, 2025, 10:09 p.m.