Command Line Options

For example, to invoke hwCFDReport for problem with input file aero.img, you can either issue the command:

hwcfdReport --img aero.img
hwcfdReport.bat –img aero.img (Windows)

To get the list of executable options along with their current values, issue the command with the -h (or --help) option. This causes the executable to print a usage message and exit. For example,

hwcfdReport --help

prints a message such as the following and exits:

MESSAGE:
Accepted Arguments:
    help:
        help
        h
        outputs all accepted arguments
    input file:
        input_file <file>
        img <file>
        this is a required argument
    output directory:
        run_directory <directory>
        dir <directory>
        if no directory is given, it will create output.dir in the current working directory
    compare directory:
        compare <directory>
        if this is given, images in given directory will be used to generate a comparison pptx
    report generation
        rep <bool>
        generate_report <bool>
        determines whether report is generated or not. Defaults to true. Values passed are either "true" or "false"
animation
        animation_format <string>
            can be either mp4 or avi. Default is mp4
other
        --delete            : if given, all files in output directory are deleted. If not given and output directory is not empty, exit signal is given

    Example use case:
        hwcfdReport --input_file "../aero.img" --run_directory "../output.dir"

    reads file aero.img in <local_directory>/
    outputs to ../output.dir
        output includes images and report PowerPoint, if generated

help or h (boolean)

If set, the program prints a usage message and exits. The usage message includes all available options, their current values, and the place where each option is set.

input_file or inp (string)

The input file name (file.inp) to be used in the templated report generation

run_directory or dir (string)

The location of the run directory

compare (string)

If this is given, images in given directory will be used to generate a comparison .pptx.

rep or generate_report (boolean)

Generate report containing images.

animation_format (string)

This option sets the format of the animation. Valid options are .mp4 and .avi. Default is .mp4.

delete (boolean)

If given, all files in output directory are deleted. If not given and output directory is not empty, exit signal is given.