Parameters
Parameter {{ element.name }} Type {{ element.type }}
Cloud Configuration (cloudConfig)
instanceType
The AWS EC2 instance type to run nshmp-haz on

Common instance types:

    @for (instance of commonInstances; track instance) {
  • {{ instance.type }} (CPU: {{ instance.cpu }}, Memory: {{ instance.mem }} GB)
  • }

Example: m7g.8xlarge

Required: no
Default: {{ defaultFormValues.cloudConfig.instanceType }}
NSHMP Configuration (nshmpConfig)
className
The Java class name to run in nshmp-haz

Example: HazardCalc

Required: no
Default: {{ defaultFormValues.nshmpConfig.className }}
modelGitUrl
The Git URL to the NSHM GitLab repository.
Must end in .git. These would be the same URL for HTTPS clone.

Example: {{ defaultFormValues.nshmpConfig.modelGitUrl }}

Required: no
Default: {{ defaultFormValues.nshmpConfig.modelGitUrl }}
modelPath
Path inside the model TAR file for nshmp-haz to use
Required: no
nshmpLibGitUrl
The Git URL to the nshmp-lib GitLab repository.

This will override the nshmp-lib dependency that is defined in nshmp-haz.

Must end in .git. These would be the same URL for HTTPS clone.

Example: https://code.usgs.gov/ghsc/nshmp/nshmp-lib.git

Required: no
nshmpLibSha
The branch, tag, or commit of the nshmp-lib repository to use as a dependency of nshmp-haz.

Example: {{ defaultFormValues.nshmpConfig.sourceCodeSha }}

Required: no
modelSha
The branch, tag, or commit of the NSHM repository to use.

Example: {{ defaultFormValues.nshmpConfig.modelSha }}

Required: no
Default: {{ defaultFormValues.nshmpConfig.modelSha }}
siteFileUrl
The URL to a CSV or GeoJSON site file .
To get a file from a private GitLab the URL must be properly encoded, see Get raw file from repository .

Example: {{ exampleConfig.nshmpConfig.siteFileUrl }}

Example: {{ siteFileEncoded }}

Required: yes
sourceCodeGitUrl
The Git URL to the nshmp-haz source code GitLab repository.
Must end in .git. These would be the same URL for HTTPS clone.

Example: {{ defaultFormValues.nshmpConfig.sourceCodeGitUrl }}

Required: no
Default: {{ defaultFormValues.nshmpConfig.sourceCodeGitUrl }}
sourceCodeSha
The branch, tag, or commit of the nshmp-haz repository to use.

Example: {{ defaultFormValues.nshmpConfig.sourceCodeSha }}

Required: no
Default: {{ defaultFormValues.nshmpConfig.sourceCodeSha }}
GMT Map Configuration (mapConfig)
createMap
Whether to create a hazard map from results.
Required: no
Default: true
region
The region bounds for the GMT hazard map.

Values:

    @for (region of mapRegions; track region) {
  • {{ region }}
  • }

Example: CONUS

Required: no
Default: fits data
title
The first row of the GMT hazard map title

Example: {{ defaultFormValues.mapConfig.title }}

Required: no
Default: {{ defaultFormValues.mapConfig.title }}
vs30
Vs30 for the bottom row of the title for the GMT hazard map.

Example: 760

Required: no
Calculation Configuration (calcConfig)
nshmp-haz calculation configuration
Calculation configuration object or arrary of calculation configuration objects.
Example:
            
              {{calcConfigJson}}
            
          
Example array:
            
              {{calcConfigArrayJson}}