Command-Line Options

Top  Previous  Next

CONVERGE accepts a number of command-line options. To invoke an option, append the argument to the CONVERGE executable (e.g., converge-mpich --help on Linux or powershell converge-intelmpi.ps1 --help on Windows).

 

Each version has a slightly different set of options and arguments, as detailed in Tables 4-6.

 

Table 4: Command line options for CONVERGE 3.0.

Argument for CONVERGE 3.0

Option description

--help or -h

Show help text.

--version or -v

Show version information.

N/A

Run CONVERGE with a base/child license set (default).

--super or -S

Run CONVERGE with a single superbase license.

--restricted or -e

Run CONVERGE with a single restricted license.

Refer to help text or

CONVERGE 3.0 Manual

Run the specified utility. Use the --help option to see a list of supported utilities or refer to the CONVERGE 3.0 Manual for more information.

 

Table 5: Command line options for CONVERGE 3.1.

Argument for CONVERGE 3.1

Option description

--help or -h

Show help text.

--version or -v

Show version information.

--license base

or -l base

Run CONVERGE with a base/child license set (default).

--license super

or -l super

Run CONVERGE with a single superbase license.

--license restricted

or -l restricted

Run CONVERGE with a single restricted license.

--utility <utility name>

or -u <utility name>

Run the specified utility. Use the --help option to see a list of supported utilities or refer to the CONVERGE 3.1 Manual for more information.

 

Table 6: Command line options for CONVERGE 3.2.

Argument for CONVERGE 3.2

Option description

--help or -h

Show help text.

--version or -v

Show version information.

--license base

or -l base

Run CONVERGE with a base/child license set (default).

--license super

or -l super

Run CONVERGE with a single superbase license.

--license restricted

or -l restricted

Run CONVERGE with a single restricted license.

--utility <utility name>

or -u <utility name>

Run the specified utility. Use the --help option to see a list of supported utilities or refer to the CONVERGE 3.2 Manual for more information.

--output-dir <path>

or -d <path>

Write output to the specified directory.

--serial-output

Write all output files in serial through rank 0. This option might not be available for some simulations. Refer to the CONVERGE 3.2 Manual for more information.