CLI

The primary way of interacting with runzi is via the command line interface (CLI). The top level command is runzi. Similar operations are grouped under sub commands (e.g. hazard, inversion, etc.). Under each sub command are the operations that runzi can perform. Use the --help flag to get more information on available commands, arguments, and options.

Most job types require an input file to define arguments.

Usage:

$ runzi [OPTIONS] COMMAND [ARGS]...

Options:

--cluster-mode [LOCAL|CLUSTER|AWS]: Execution target: LOCAL machine, HPC CLUSTER, or AWS cloud. [default: LOCAL]
--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:

inversion: inversion
hazard: hazard calculations
ipp: inversion post processing
rupset: create rupture sets
reports: create inversion and rupture set reports
utils: utilities

`inversion`¶

inversion

Usage:

$ runzi inversion [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

crustal: Run crustal inversions.
subduction: Run subduction inversions.

`inversion crustal`¶

Run crustal inversions.

Usage:

$ runzi inversion crustal [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`inversion subduction`¶

Run subduction inversions.

Usage:

$ runzi inversion subduction [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`hazard`¶

hazard calculations

Usage:

$ runzi hazard [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

oq-hazard: Calculate hazard realizations using the...
oq-disagg: Calculate hazard disaggregation...

`hazard oq-hazard`¶

Calculate hazard realizations using the OpenQuake engine.

Usage:

$ runzi hazard oq-hazard [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`hazard oq-disagg`¶

Calculate hazard disaggregation realizations using the OpenQuake engine.

Usage:

$ runzi hazard oq-disagg [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`ipp`¶

inversion post processing

Usage:

$ runzi ipp [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

avg-sol: Average multiple solutions by taking the...
time-dependent: Create time dependent inversion solutions...
scale: Scale rupture rates of inversion solutions.
oq-convert: Convert OpenSHA inversion solutions to...

`ipp avg-sol`¶

Average multiple solutions by taking the mean rate of all ruptures.

Usage:

$ runzi ipp avg-sol [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`ipp time-dependent`¶

Create time dependent inversion solutions by modifying rupture rates.

Usage:

$ runzi ipp time-dependent [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`ipp scale`¶

Scale rupture rates of inversion solutions.

Usage:

$ runzi ipp scale [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`ipp oq-convert`¶

Convert OpenSHA inversion solutions to OpenQuake source input files.

Usage:

$ runzi ipp oq-convert [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`rupset`¶

create rupture sets

Usage:

$ runzi rupset [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

coulomb: Create Coulomb (crustal) rupture sets.
subduction: Create subduction rupture sets.

`rupset coulomb`¶

Create Coulomb (crustal) rupture sets.

Usage:

$ runzi rupset coulomb [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`rupset subduction`¶

Create subduction rupture sets.

Usage:

$ runzi rupset subduction [OPTIONS] INPUT_FILEPATH

Arguments:

INPUT_FILEPATH: [required]

Options:

--help: Show this message and exit.

`reports`¶

create inversion and rupture set reports

Usage:

$ runzi reports [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

rupset: Create diagnostic reports for rupture sets.
inversion: Create diagnostic reports for inversion.

`reports rupset`¶

Create diagnostic reports for rupture sets.

Usage:

$ runzi reports rupset [OPTIONS] TOSHI_ID

Arguments:

TOSHI_ID: id of rupture set or general task used to create rupture sets [required]

Options:

--help: Show this message and exit.

`reports inversion`¶

Create diagnostic reports for inversion.

Usage:

$ runzi reports inversion [OPTIONS] GENERAL_TASK_ID

Arguments:

GENERAL_TASK_ID: [required]

Options:

--help: Show this message and exit.

`utils`¶

utilities

Usage:

$ runzi utils [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

container: Build runzi-opensha Docker image, push to...
save-file: Zip a file and save as a ToshiAPI File...
index-inv: Add inversions to the index (static web...

`utils container`¶

Build runzi-opensha Docker image, push to ECR, update Batch job definition.

Usage:

$ runzi utils container [OPTIONS]

Options:

--fatjar-tag TEXT: OpenSHA fatjar tag [default: bf70d35]
--runzi-gitref TEXT: Git branch, tag, or commit to build [default: main]
--python-version TEXT: Python version [default: 3.11]
--oq-version TEXT: OpenQuake version [default: 3.23.4]
--install-converter / --no-install-converter: Set to install UCERF converter [default: no-install-converter]
--region TEXT: AWS region [default: us-east-1]
--aws-account-id TEXT: AWS account ID [default: 461564345538]
--ecr-repo TEXT: ECR repository [default: nzshm22/runzi]
--job-definition TEXT: Batch job definition [default: runzi_32GB_8VCPU_JD]
--dockerfile TEXT: Path to Dockerfile [default: docker/Dockerfile]
--skip-build / --no-skip-build: Skip Docker build [default: no-skip-build]
--skip-push / --no-skip-push: Skip ECR push [default: no-skip-push]
--skip-job-update / --no-skip-job-update: Skip job definition update [default: no-skip-job-update]
--help: Show this message and exit.

`utils save-file`¶

Zip a file and save as a ToshiAPI File object.

Can provide single target file run_save_file_archive(target, tag, input_csv_file, output_csv_file, dry_run)

Usage:

$ runzi utils save-file [OPTIONS] TARGET

Arguments:

TARGET: path of file to be archived [required]

Options:

--tag TEXT: add tag to metadata
--input-csv-file / --no-input-csv-file: target is CSV list of files to archive; must have header: ['fullpath', 'grandparent', 'parent', 'filename'] [default: no-input-csv-file]
--output-csv-file PATH: write CSV of archived files with assigned toshi IDs
--dry-run / --no-dry-run: mock run [default: no-dry-run]
--help: Show this message and exit.

`utils index-inv`¶

Add inversions to the index (static web page).

Usage:

$ runzi utils index-inv [OPTIONS] GT_IDS...

Arguments:

GT_IDS...: whitespace seprated list of inversion genarl task IDs [required]

Options:

--help: Show this message and exit.

CLI

inversion¶

inversion crustal¶

inversion subduction¶

hazard¶

hazard oq-hazard¶

hazard oq-disagg¶

ipp¶

ipp avg-sol¶

ipp time-dependent¶

ipp scale¶

ipp oq-convert¶

rupset¶

rupset coulomb¶

rupset subduction¶

reports¶

reports rupset¶

reports inversion¶

utils¶

utils container¶

utils save-file¶

utils index-inv¶

`inversion`¶

`inversion crustal`¶

`inversion subduction`¶

`hazard`¶

`hazard oq-hazard`¶

`hazard oq-disagg`¶

`ipp`¶

`ipp avg-sol`¶

`ipp time-dependent`¶

`ipp scale`¶

`ipp oq-convert`¶

`rupset`¶

`rupset coulomb`¶

`rupset subduction`¶

`reports`¶

`reports rupset`¶

`reports inversion`¶

`utils`¶

`utils container`¶

`utils save-file`¶

`utils index-inv`¶