run_hisafe: Run one or more Hi-sAFe simulations

Description Usage Arguments Value Examples

View source: R/run.R

Description

Runs one or more Hi-sAFe simulations

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
run_hisafe(
  hip = NULL,
  path = NULL,
  simu.names = "all",
  capsis.path,
  parallel = FALSE,
  num.cores = NULL,
  mem.spec = FALSE,
  quietly = FALSE,
  launch.call = "ScriptGen",
  default.folder = ""
)

Arguments

hip

An object of class "hip". Required if path is not provided.

path

A character string of the path (relative or absolute) to the directory containing the simulation folders. Required if hip is not provided.

simu.names

Names of the simulations to run. If "all", the default, then all simulations are run.

capsis.path

A character string of the path (relative or absolute) to the Capsis folder

parallel

Logical, should parallel computing be used.

num.cores

Numbers of cores to use in parallel computing. If not provided, will default to one less than the total number of available cores.

mem.spec

An integer indicating the maximum memory use (Mb) permitted for an individual instance of Capsis/Hi-sAFe. If TRUE, will default to the system's total memory divided by the number of cores. If FALSE, a memory specification will not be made, and Capsis/Hi-sAFe will run with defaults.

quietly

Logical indicating whether status messages should printed to the console.

Value

Invisibly returns a list of console logs from simulation runs.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# Once a group Hi-sAFe simulations (experiment) is defined...
myexp <- define_hisafe(path = "./simulations", exp.name = "lat_exp", latitude = c(30,60))

# ...and built...
build_hisafe(myexp)

# the simulations can all be run:
run_hisafe(myexp)

## End(Not run)

kevinwolz/hisafer documentation built on Oct. 19, 2020, 4:43 p.m.