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 (Linux)
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.

    compare display format:
        compare_format <string>

        determines the display format of comparison slides.
        Defaults to "parallel".
        value:  "para"   as parallel,    side by side on one slide
                "seq"   as sequential,   one after one on two slides,

        this is an optional argument

    append directory:
       append_directory <directories>

       concatenates multiple existing output directories into a single PowerPoint report.
       append_directory can be a single directory (Local or absolute path) or a comma separated
       list of directories to pull .png and .avi/.mp4 files from.
       <directories> could not empty.

       this is an optional argument


    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

    picture resolution:
        res <string>
        picture_resolution <string>

        determines the resolution of picture file.
        Defaults to "high".
        value:  "high"    as high,   9000 x 6000
                "medium"  as medium, 6000 x 4000
                "low"     as low,    3000 x 2000

        this is an optional argument

    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:
        .\launcher input_file "../smxMixer.img" run_directory "../output.dir"  res "low"

    reads file smxMixer.img in <local_directory>/
    outputs to <local_directory>/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.

compare_format (string)

Valid options are "seq" or "para".

Changes the report generator comparison format between sequential and parallel (default). When you select compare_format to seq, the images from each report will be compared in sequential order, one after the other. When you select compare_format to para, the images from each report will be compared in parallel order, side by side.

append_directory (string)

Concatenates multiple existing output directories into a single PowerPoint report, where (string) is a single directory (local or absolute path) or a comma separated list of directories to pull .png and .avi/.mp4 files from.

generate_report or rep (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.

picture_resolution or res (string)

Determines the resolution of picture file.

Defaults to "high".

Value: "high" as high, 9000 x 6000; "medium" as medium, 6000 x 4000; "low" as low, 3000 x 2000

delete (boolean)

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