xargs_apsimx: Provide extra arguments for APSIM-X

In femiguez/apsimx: Inspect, Read, Edit and Run 'APSIM' "Next Generation" and 'APSIM' Classic

Provide extra arguments for APSIM-X

Description

This provides additinoal command line arguments when running the model

Usage

xargs_apsimx(
  verbose = FALSE,
  csv = FALSE,
  merge.db.files = FALSE,
  list.simulations = FALSE,
  list.referenced.filenames = FALSE,
  single.threaded = FALSE,
  cpu.count = -1L,
  simulation.names = FALSE,
  dotnet = FALSE,
  mono = FALSE,
  exe.path = NA
)

Arguments

verbose	Write detailed messages to stdout when a simulation starts/finishes.
csv	Export all reports to .csv files.
merge.db.files	Merge multiple .db files into a single .db file.
list.simulations	List simulation names without running them.
list.referenced.filenames	List all files that are referenced by an .apsimx file(s).
single.threaded	Run all simulations sequentially on a single thread.
cpu.count	(Default: -1) Maximum number of threads/processes to spawn for running simulations.
simulation.names	Only run simulations if their names match this regular expression.
dotnet	Logical. There is a global option for this argument, but this will override it. This can be useful if the goal is to compare an old version of Next Gen (before Sept 2021) with a more recent version in the same script. This might be needed if you have your own compiled version of APSIM Next Gen.
mono	Logical. Should be set to TRUE if running a version of APSIM Next Gen from Aug 2021 or older on Mac or Linux.
exe.path	executable path. This can be useful for having both a global option through ‘apsimx.options’ and a local option that will override that. This option will take precedence.

Details

Extra arguments for running APSIM-X

Value

it returns a character vector with the extra arguments.

femiguez/apsimx documentation built on April 13, 2024, 12:04 a.m.