Command line usage

Run a simulation

usage: itzi run [-h] [-o] [-v | -q]
                [--resume-from HOTSTART_PATH | CONFIG_PATH=HOTSTART_PATH]
                config_file [config_file ...]

Positional Arguments

config_file: An Itzï configuration file (if several given, run in batch mode.)

Named Arguments

-o: Overwrite files if exist.
-v: Increase verbosity.
-q: Decrease verbosity.
--resume-from: Resume a simulation from a hotstart file. If only the path to a hotstart file is given, batch is not allowed. For batch processing, use the ‘CONFIG_PATH=HOTSTART_PATH’ construct.

Hotstart usage

Added in version 26.6.

Use --resume-from to resume a run from a hotstart file created by a previous simulation. The hotstart file does not replace the configuration file: you still pass the normal Itzi configuration file(s), and Itzi validates the resumed configuration against the hotstart before starting.

Checkpoint creation and resume-time configuration constraints are documented in Configuration file. Known restart limitations are summarized in Frequently Asked Questions.

Single simulation

Resume a single configuration file from one hotstart file:

itzi run my_case.ini --resume-from checkpoints/latest_hotstart.zip

Batch mode

For batch runs, map each resumed simulation explicitly:

itzi run a.ini b.ini \
   --resume-from a.ini=checkpoints/a_hotstart.zip \
   --resume-from b.ini=checkpoints/b_hotstart.zip

Rules

With a single configuration file, --resume-from HOTSTART_PATH is valid.
With multiple configuration files, each --resume-from value must use the CONFIG_PATH=HOTSTART_PATH form.
The CONFIG_PATH part may be either the config path or a basename such as a.ini. When basenames are not unique, use the config path.
At most one hotstart file may be mapped to a given configuration file.
When multiple CONFIG_PATH=HOTSTART_PATH mappings are supplied, any batch configuration file left unmapped still runs from scratch.

Get the version number

usage: itzi version [-h]