Skip to content

CLI

flepimop2

flepimop2 - Flexible Epidemic Modeling Pipeline (version 2).

Usage:

flepimop2 [OPTIONS] COMMAND [ARGS]...

Options:

  --version  Show the version and exit.
  --help     Show this message and exit.

flepimop2 build

Compile and build a model defined in a configuration file.

Usage:

flepimop2 build [OPTIONS] [CONFIG]

Options:

  --dry-run        Should this command be run using dry run?
  -v, --verbosity  The verbosity level to use for this command.
  --help           Show this message and exit.

flepimop2 format

Format a configuration file into flepimop2's normalized YAML style.

By default this command rewrites the input file in place. Use --check to validate formatting without modifying the file, or --dry-run to print the formatted configuration to stdout.

Usage:

flepimop2 format [OPTIONS] [CONFIG]

Options:

  --dry-run        Should this command be run using dry run?
  --check          Check whether the configuration is already formatted.
  -v, --verbosity  The verbosity level to use for this command.
  --help           Show this message and exit.

flepimop2 patch

Patch one or more configuration files together.

This command applies configuration files from left to right. The first file is used as the base configuration, and each subsequent file is patched onto the accumulated result.

Usage:

flepimop2 patch [OPTIONS] CONFIGS...

Options:

  --dry-run                       Should this command be run using dry run?
  -o, --output FILE               Write the patched configuration to this file
                                  instead of stdout.
  --patch-mode [error|merge|replace]
                                  How to handle duplicate configuration keys
                                  while patching.  [default: error]
  -v, --verbosity                 The verbosity level to use for this command.
  --help                          Show this message and exit.

flepimop2 process

Execute a processing step based on a configuration file.

The CONFIG argument should point to a valid configuration file.

Usage:

flepimop2 process [OPTIONS] [CONFIG]

Options:

  --dry-run          Should this command be run using dry run?
  -t, --target TEXT  The target to use for this command.
  -v, --verbosity    The verbosity level to use for this command.
  --help             Show this message and exit.

flepimop2 simulate

Run simulations based on a configuration file.

This command runs epidemic simulations specified from a provided configuration file. The CONFIG argument should point to a valid configuration file.

Usage:

flepimop2 simulate [OPTIONS] [CONFIG]

Options:

  --dry-run          Should this command be run using dry run?
  -t, --target TEXT  The target to use for this command.
  -v, --verbosity    The verbosity level to use for this command.
  --help             Show this message and exit.

flepimop2 skeleton

Create a project skeleton with directory structure and template files.

This command scaffolds a new flepimop2 project by creating the necessary directory structure and populating it with template configuration files, environment specifications, and other boilerplate files needed to get started.

The PATH argument specifies where to create the project. If omitted, the skeleton will be created in the current working directory.

Examples: # Create an empty project in a new directory $ flepimop2 skeleton foobar # Create a project in the current directory $ mkdir fizzbuzz && cd fizzbuzz $ flepimop2 skeleton

Usage:

flepimop2 skeleton [OPTIONS] [PATH]

Options:

  --dry-run        Should this command be run using dry run?
  -v, --verbosity  The verbosity level to use for this command.
  --help           Show this message and exit.