Using the CLI¶

rtmf6 provides a command-line interface.

The simplest way is to change to directory with the configuration file rtmf6.toml and type:

rtmf6

Alternatively, you provide the path the configuration file:

rtmf6 run path/to/rtmf6.toml

The command:

rtmf6

is equivalent to:

rtmf6 run

CLI options¶

Usage:

$ rtmf6 [OPTIONS] [CONFIG_FILE] COMMAND [ARGS]...

Arguments:

[CONFIG_FILE]: Path to the configuration file. Defaults to rtmf6.toml in the current directory.

Options:

-n, --no-reactions: Disable chemical reactions.
-p, --preprocess-only: Only create input files, do not run the model.
-r, --run-only: Skip preprocessing, run the model only.
-V, --version: Show version and exit.
--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.
--help: Show this message and exit.

Commands:

Run the rtmf6 model.

Usage:

$ rtmf6 run [OPTIONS] [CONFIG_FILE]

Arguments:

[CONFIG_FILE]: Path to the configuration file. Defaults to rtmf6.toml in the current directory.

Options:

Show version and other information.

Usage:

$ rtmf6 info [OPTIONS]

Options:

Show configuration information.

Usage:

$ rtmf6 config [OPTIONS] [CONFIG_FILE]

Arguments:

[CONFIG_FILE]: Path to the configuration file. Defaults to rtmf6.toml in the current directory.

Options: