rhessys_command: Executes single RHESSys run on command line

View source: R/rhessys_command.R

rhessys_commandR Documentation

Executes single RHESSys run on command line

Description

rhessys_command Assembles command line RHESSys call, and runs it. See the RHESSys wiki: https://github.com/RHESSys/RHESSys/wiki/RHESSys-command-line-options

Usage

rhessys_command(
  rhessys_version,
  world_file,
  world_hdr_file,
  tec_file,
  flow_file,
  start_date,
  end_date,
  output_file = NULL,
  input_parameters,
  output_filter = NULL,
  par_option_ID = NULL,
  command_options,
  prefix_command = NULL,
  return_cmd = FALSE
)

Arguments

rhessys_version

Path and file name of compiled version of RHESSys.

world_file

Oath and file name of RHESSys world_file.

world_hdr_file

Path and file name of RHESSys header file

tec_file

Path and file name of RHESSys temporal event control (tec) file

flow_file

Path and file name of RHESSys flow table file

start_date

Start date character vector in format <year> <month> <day> <hour>, delimited by spaces. Ex. '1990 12 30 01'

end_date

End date character vector, same format as start_date

output_file

Path and base file name of RHESSys output

input_parameters

Soil parameters passed to RHESSys command line.

output_filter

Path to a yaml formatted output filter.

command_options

RHESSys command line options, ex. '-g' or '-p'.

prefix_command

A shell command to be run previous to the RHESSys command line call.

return_cmd

true/false passed from run_rhessys_single This can be used to source a shell script, which itself can run multiple commands if needed.


RHESSys/RHESSysIOinR documentation built on March 26, 2024, 10:14 a.m.