Skip to content

Using CRHMcode Command Line Interface

jhs507 edited this page Feb 25, 2022 · 2 revisions

Command signature

crhm [-options] PROJECT_FILE

Basic usage

CRHM can be invoked on the command line with the ./crhm file on Unix variants or ./crhm.exe on Windows. CRHM requires a single argument which is the path to the .prj file to be run.

Available Options

-h, --help

Displays a usage information message.

-t TIME_FORMAT

Allows you to select a format for the date time outputs produced by CRHM.

Time Formats supported are.
  • MS - Microsoft Excel floating point representation.
  • ISO - ISO 8601 extended format YYYY-MM-DDThh:mm
  • YYYYMMDD - Custom format YYYY MM DD hh mm

-f OUTPUT_FORMAT

Select the file format for the output default is STD.

Output Formats supported are.
  • STD - Standard output format tab delimited columns. First row has variable names and second has variable units.
  • OBS - Observation file .obs format. Creates an .obs file that can be used by CRHM.

-o PATH

Specify the name for the output file. Default is ./CRHM_output_1.txt

-d DELIMITER

Specify a single character delimiter to use in the generated output. Default is the tab character.

--obs_file_directory DIRECTORY_PATH

Specify a directory where the obs files for this project are found. This directory will be prepended to the obsfile names specified in the project file.

-p UPDATE_FREQUENCY

Show percentage of progress towards completion during simulation run. UPDATE_FREQUENCY specifies after how many days to update the percentage.