Stages

Workflow Stages

The workflow repository contains all the tools necessary to build a workflow for ground motion model simulations. We build and maintain a Cybershake workflow, but researchers may wish to build their own. For this reason, the workflow is build out of composable parts we intend for anyone to reuse to build their own workflow based on the Cybershake workflow. Below you will find documentation for all the workflow stages, their inputs, outputs and environments.

graph LR
    A[<a href="#nshm-to-realisation">NSHM To Realisation</a>] --> B[<a href="#srf-generation">SRF Generation</a>]
    A --> C[Domain Generation]
    B --> D[Stoch Generation]
    C --> E[Velocity Model Generation]
    C --> F[Station Coordinate Generation]
    C --> G[Model Coordinate Generation]
    B --> H[Create EMOD3D Parameters]
    E --> H
    F --> H
    G --> H
    H --> I[Run EMOD3D]
    D --> J[Run HF Simulation]
    I -->|Optionally| K[Run Merge TS]
    K --> L[Create Simulation Video]

Loading

Many of the stages will run in a container. A container is a self-contained execution environment with all the system and Python libraries required to execute workflow stages. It is also isolated from the host system and may not be able to access certain directories. We maintain a cybershake container that has a copy of the latest validated workflow, and environment. Use this container as much as possible in your own scripts to run your code.

NSHM To Realisation

• Description: Construct a realisation from a rupture in the NSHM 2022.
• Inputs:
  1. A copy of the NSHM 2022 database.
  2. A rupture id to simulate. You can find a rupture id from the rupture explorer. Alternatively, you can use the visualisation tools to find one.
  3. The version of the scientific defaults to use. If you don't know what version to use, choose the latest version. Versions are specified as YY.M.D.R, where R is the resolution of the simulation (1 = 100m). For example 24.2.2.1. The special develop version is for testing workflow iterations and not to be used for accurate scientific simulation.
• Outputs: A realisation file containing:
  1. The definition of all the faults in the the rupture,
  2. A rupture propagation plan (i.e. how the rupture jumps between faults, and where),
  3. The estimated rupture magnitude and apportionment to the involved faults.
  4. The definition of the rakes.
• Environment: Can be run in the cybershake container. Can also be run from your own computer using the nshm2022-to-realisation command which is installed after running pip install workflow@git+https://github.com/ucgmsim/workflow.
• For More Help: See the output of nshm2022-to-realisation --help or nshm2022_to_realisation.py.

SRF Generation

• Description: Produce an SRF from a realisation.

• Inputs: A realisation file containing:

  1. A source configuration,
  2. A rupture propagation configuration,
  3. A metadata configuration.

  Typically, this information comes from a stage like NSHM To Realisation.

• Outputs:

  1. An SRF file containing the source slip definition for the realisation,
  2. An updated realisation file containing the parameters used for SRF generation copied from the scientific defaults.

• Environment: Can be run in the cybershake container. Can also be run from your own computer using the realisation-to-srf command which is installed after running pip install workflow@git+https://github.com/ucgmsim/workflow. If you are executing on your own computer you also need to specify the work directory (with the --work-directory flag), a 1D velocity model (--velocity-model-ffp), and the path to a genslip binary (--genslip-path).

• For More Help: See the output of realisation-to-srf --help or realisation_to_srf.py