run_air2water: Run the air2water model

Description Usage Arguments Author(s) Examples

Description

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

Usage

1
run_air2water(sim_folder = ".", mode = "pso", use_pars = TRUE, verbose = FALSE)

Arguments

sim_folder

filepath; the directory where simulation files are contained

mode

character; mode in which the model will be run. There are three options:

  1. "pso" - Particle swarm operator which runs a calibration routine and then a model simulation with the best parameters (default)

  2. "forward" - runs the model once with a set of provided parameters.

  3. "lhc" - Uses Latin hypercube sampling to calibrate the model and then a model simulation with the best parameters.

use_pars

boolean; use the parameters from the recent calibration. Only in "forward" mode. This will use the results from calibration routine in file "1_XXX_xxx.out" and write to "parameters_forward.txt" before running the model. Defaults to TRUE.

verbose

Save output as character vector. Defaults to FALSE

Author(s)

Tadhg Moore

Examples

1
2
3
4
5
6
## Not run: 
sim_folder <- system.file('extdata', package = 'air2wateR')
gen_param(sim_folder = sim_folder, mean_depth = 147)
run_air2water(sim_folder = sim_folder)

## End(Not run)

aemon-j/air2wateR documentation built on Sept. 20, 2020, 11:49 a.m.