Command Line Options

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

hwcfdReport --img aero.img (Linux)
hmcfdreport –img aero.ing (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:

Accepted Arguments:
    help:
        help
        h

        Help description with definition of all the accepted arguments.

    input file:
        input_file <file>
        img <file>

        Input file used to define the report (Required argument).

    output directory:
        run_directory <directory>
        dir <directory>

        Location to store output images and report, if no directory is given, it will create output.dir in the current working directory.

    compare directory:
        compare <directory>

        Relative or absolute path to comparison directory. If this is given, images in given directory will be used to generate a comparison pptx.
        if no_run is used, a list of two existing directories (separated by comma) is required as the value.
        
    compare display format:
        compare_format <string>
        
        Comparison format used when compare is utilized, 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,  
 
    append directory:
       append_directory <directories> 
       
       List of directories to concatenate multiple existing output directories into a single 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> must be defined if append_directory is utilized.
            
    report generation
        rep <bool>
        generate_report <bool>

        Determines whether a report is generated or not. Acceptable values are "true" or "false".  Default to true.

    animation
        animation_format <string>
        
        Type of output animation file format, Acceptable values are "mp4" or "avi. Default is mp4.
            
    picture resolution:
        res <string>
        picture_resolution <string>
        
        Determines the resolution of the resulting image file (.png). 
        Default: "medium". 
        value:  "high"    as high,   7680 x 4320  (8K)
 "medium"  as medium, 3840 x 2160  (4K)
 "low"     as low,    1920 x 1080  (Full HD)
 
        For animation, 4K is the only option supported.

    powerpoint report file name:
        report_name <string>

        Determines the name of the PowerPoint report file name.
        Default: Report_auto

    other:
        --delete            : If provided, all files in output directory are deleted. If not given 
               and output directory is not empty, exit signal is given.

        --no_run            : if provided, no new pictures or animations are created, instead they are taken from existing locations.
               "compare" or/and "append_directory" commands are required to provide the paths of existing pictures and animations.

    Example use cases:
        hmcfdreport aero.img --output_directory aero.output.dir  --res low

        Reads file aero.img in <local_directory>/
        outputs to <local_directory>/aero.output.dir
        output includes images (low resolution) and report PowerPoint
        
        hmcfdreport aero.img --delete --res high --animation_format avi

        Reads file aero.img in <local_directory>/
        deletes existing <local_directory>/output.dir and outputs to <local_directory>/output.dir
        output includes images (high resolution), animation with avi file and report PowerPoint
        
        hmcfdreport aero_design_2.img --delete --res high --compare_directory aero.output.dir --compare_format seq

        Reads file aero_design_2.img in <local_directory>/
        deletes existing <local_directory>/output.dir and outputs to <local_directory>/output.dir
        makes comparison type report with existing images from aero.output.dir with sequential format 
        output includes images (high resolution) and report PowerPoint
        
        hmcfdreport aero_design_2.img --append_directory aero.output.dir,aero_design_2.output.dir --no_run

        Creates PowerPoint with exising image directories (aero.ouput.dir and aero_design_2.output.dir) without creating new images 
        output is written to output.dir (default), contains only PowerPoint file

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 img (string)

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

run_directory or dir (string)

The location to store output images and report, if no directory is given, it will create output.dir in the current working directory.

compare (string)

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

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 PowerPoint 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, 7680 x 4320; "medium" as medium, 3840 x 2160; "low" as low, 1920 x 1080

delete (boolean)

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

no_run (boolean)

If given, no new pictures or animations are created. "compare" or/and "append_directory" commands are required to provide the paths of existing pictures and animations.