run_gotm: Run the GOTM model

In tadhg-moore/GOTMr: Work with GOTM in R

Run the GOTM model

Description

This runs the GOTM model on the specific simulation stored in sim_folder. The specified sim_folder must contain valid NML files.

Usage

run_gotm(sim_folder = ".", yaml = TRUE, yaml_file = "gotm.yaml",
  verbose = FALSE, args = character())

Arguments

sim_folder	the directory where simulation files are contained
yaml	logical; If true will use 'gotm.yaml' file for set up otherwise it will use namelist files. Defaults to TRUE
yaml_file	filepath; to file with GOTM setup. Defaults to 'gotm.yaml'
verbose	Save output as character vector. Defaults to FALSE
args	Optional arguments to pass to GOTM executable

Author(s)

Tadhg Moore

Examples

sim_folder <- system.file('extdata', package = 'GOTMr')
run_gotm(sim_folder)

tadhg-moore/GOTMr documentation built on June 4, 2023, 1:52 p.m.