Newer
Older
A `calc-config.json` file _may_ reside at the root of every [hazard model](./Hazard-Model.md). This
file, if present, will override any built-in default calculation configuration parameters, as
listed below. See the [examples](../../etc/examples/README.md) directory, or any
[USGS model](./Usgs-Models.md), for concrete examples.
## Calculation Configuration Parameters
Calculation configuration parameters are optional (i.e. defaults are used for missing values) and
may be overridden. See [building and running](./Building-&-Running.md) and the
Parameter | Type | Default | Notes |
--------- | ---- | ------- | ----- |
__`hazard`__
`.exceedanceModel` |`String` | `"TRUNCATION_3SIGMA_UPPER"`| [`ExceedanceModel`][url-exceedance]
`.truncationLevel` |`Double` | `3.0` | [1](#notes)
`.imts` |`String[]` | `["PGV","PGA","SA0P01","SA0P02",`<br>`"SA0P03","SA0P05","SA0P075",`<br>`"SA0P1","SA0P15","SA0P2","SA0P25",`<br>`"SA0P3","SA0P4","SA0P5","SA0P75",`<br>`"SA1P0","SA1P5","SA2P0","SA3P0",`<br>`"SA4P0","SA5P0","SA7P5","SA10P0"]` | [`Imt`][url-imt]
`.tectonicSettings` |`String[]` | `[]` | [`TectonicSetting`][url-tectonicsetting] filter
`.sourceTypes` |`String[]` | `[]` | [`SourceType`][url-sourcetype] filter
`.vs30s` |`Double[]` | `[]` | Vs30s to use for batch jobs
`.useSiteData` |`Boolean` | `true` | Enable site data (e.g. basin depths)
`.customImls` |`Map<String, Double[]>` | `{}` (empty object) | [2](#notes)
`.valueFormat` |`String` | `"ANNUAL_RATE"` | [`ValueFormat`][url-valueformat]
__`gmm`__
`.dampingRatio` |`Double` | `0.05` (5%) | Limited to range [0.005..0.3] 0.5% to 30%
`.sigmaScale` |`Double` | `1.0` (100%, no scaling) | Limited to range [0.5..1.0] 50% to 100%
`.vertical` |`Boolean` | `false` | Compute vertical ground motions
`.returnPeriod` |`Double` | `2475` |
`.bins` |`Object` | | [4](#notes)
`.contributorLimit` |`Double` | `0.1` | [5](#notes)
`.bins` |`Object` | | [6](#notes)
`.distributionFormat` |`String` | `"INCREMENTAL"` | [`DistributionFormat`][url-distribution]
`.valueFormat` |`String` | `"ANNUAL_RATE"` | [`ValueFormat`][url-valueformat]
__`output`__ |
`.directory` |`String` | `hazout`
`.dataTypes` |`String[]` | `["TOTAL","MAP"]` | [`DataType`][url-datatype]
`.returnPeriods` |`Double[]` | `[475,975,2475,10000]` | [`ReturnPeriods`][url-returnperiods]
`.optimizeGrids` |`Boolean` | `true` | [7](#notes)
`.smoothGrids` |`Boolean` | `true` | [8](#notes)
`.systemPartition` |`Integer` | `1000` | [9](#notes)
`.threadCount` |`String` | `"ALL"` | [`ThreadCount`][url-sheets]
[url-exceedance]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/ExceedanceModel.html
[url-imt]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/Imt.html
[url-tectonicsetting]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/model/TectonicSetting.html
[url-sourcetype]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/model/SourceType.html
[url-valueformat]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/ValueFormat.html
[url-distribution]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/DistributionFormat.html
[url-datatype]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/DataType.html
[url-returnperiods]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/CalcConfig.Output.html#returnPeriods
[url-sheets]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/ThreadCount.html
Altekruse, Jason Morgan
committed
### Notes
1. `hazard.truncationLevel`: This value is only used if the `hazard.exceedanceModel` requires a
limit (e.g. `TRUNCATION_UPPER_ONLY`)
2. `hazard.customImls`: Hazard is computed at default intensity measure levels (IMLs) for every
supported intenisty measure type (IMT), but a user can specify different IMLs as needed (see
Altekruse, Jason Morgan
committed
[example 2](../../etc/examples/2-custom-config/README.md) and the
3. `hazard.gmmDampingRatio` currently has no effect.
4. `disagg.bins`: This field maps to a data container that specifies the following default ranges
and intervals for distance, magnitude, and epsilon binning: `"bins": { "rMin": 0.0, "rMax":
1000.0, "Δr": 20.0, "mMin": 4.4, "mMax": 9.4, "Δm": 0.2, "εMin": -3.0, "εMax": 3.0, "Δε": 0.5 }`.
The `bins` object must be fully specified; partial overrides do not apply to nested JSON objects.
5. `disagg.contributorLimit`: Specifies the cutoff (in %) below which contributing sources are not
listed in disaggregation results.
6. `rate.bins`: This field maps to a data container that specifies the following default magnitude
binning range and interval: `"bins": { "mMin": 4.2, "mMax": 9.4, "Δm": 0.1 }`. The `bins` object
must be fully specified; partial overrides do not apply to nested JSON objects.
7. `performance.optimizeGrids`: Gridded seismicity source optimizations are currently implemented
for any non-fixed strike grid source. For any site, rates across all azimuths are aggregated
in tables of distance and magnitude.
8. `performance.smoothGrids`: Resample gridded seismicity sources close to a site.
9. `performance.systemPartition`: The number of ruptures in a fault-system source to process
concurrently.
## Default Intensity Measure Levels (IMLs)
Units of PGV IMLs are cm/s; all other IMTs are in units of g. Spectral acceleration IMTs that are
not listed use the values of the next highest spectral period.
PGV | 0.237, 0.355, 0.532, 0.798, 1.19, 1.80, 2.69, 4.04, <br>6.06, 9.09, 13.6, 20.5, 30.7, 46.0, 69.0, 103.0, 155.0, <br>233.0, 349.0, 525.0
PGA | 0.00233, 0.00350, 0.00524, 0.00786, 0.0118, 0.0177, <br>0.0265, 0.0398, 0.0597, 0.0896, 0.134, 0.202, 0.302, 0.454, <br>0.680, 1.02, 1.53, 2.30, 3.44, 5.17
T ≤ 0.01 s | 0.00233, 0.00350, 0.00524, 0.00786, 0.0118, 0.0177, <br>0.0265, 0.0398, 0.0597, 0.0896, 0.134, 0.202, 0.302, 0.454, <br>0.680, 1.02, 1.53, 2.30, 3.44, 5.17
T ≤ 0.02 s | 0.00283, 0.00424, 0.00637, 0.00955, 0.0143, 0.0215, <br>0.0322, 0.0483, 0.0725, 0.109, 0.163, 0.245, 0.367, 0.551, 0.826, <br>1.24, 1.86, 2.79, 4.18, 6.27
T ≤ 0.05 s | 0.00333, 0.00499, 0.00749, 0.0112, 0.0169, 0.0253, <br>0.0379, 0.0569, 0.0853, 0.128, 0.192, 0.288, 0.432, 0.648, 0.972, <br>1.46, 2.19, 3.28, 4.92, 7.38
T ≤ 2 s | 0.00250, 0.00375, 0.00562, 0.00843, 0.0126, 0.0190, <br>0.0284, 0.0427, 0.0640, 0.0960, 0.144, 0.216, 0.324, 0.486, <br>0.729, 1.09, 1.64, 2.46, 3.69, 5.54
T ≤ 3 s | 0.00200, 0.00300, 0.00449, 0.00674, 0.0101, 0.0152, <br>0.0228, 0.0341, 0.0512, 0.0768, 0.115, 0.173, 0.259, 0.389, <br>0.583, 0.875, 1.31, 1.97, 2.95, 4.43
T ≤ 4 s | 0.00133, 0.00200, 0.00300, 0.00449, 0.00674, 0.0101, <br>0.0152, 0.0228, 0.0341, 0.0512, 0.0768, 0.115, 0.173, 0.259, <br>0.389, 0.583, 0.875, 1.31, 1.97, 2.95
T ≤ 5 s | 0.000999, 0.00150, 0.00225, 0.00337, 0.00506, 0.00758, <br>0.0114, 0.0171, 0.0256, 0.0384, 0.0576, 0.0864, 0.130, 0.194, <br>0.292, 0.437, 0.656, 0.984, 1.48, 2.21
T ≤ 7.5 s | 0.000499, 0.000749, 0.00112, 0.00169, 0.00253, 0.00379, <br>0.00569, 0.00853, 0.0128, 0.0192, 0.0288, 0.0432, 0.0648, <br>0.0972, 0.146, 0.219, 0.328, 0.492, 0.738, 1.11
T ≤ 10 s | 0.000333, 0.000499, 0.000749, 0.00112, 0.00169, 0.00253, <br>0.00379, 0.00569, 0.00853, 0.0128, 0.0192, 0.0288, 0.0432, <br>0.0648, 0.0972, 0.146, 0.219, 0.328, 0.492, 0.738
Altekruse, Jason Morgan
committed
---
Altekruse, Jason Morgan
committed
## Related Pages
* [Building & Running](./Building-&-Running.md#building-&-running)
* [Developer Basics](./Developer-Basics.md#developer-basics)
* [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration)
* [Site Specification](./Site-Specification.md#site-specification)
* [Using Docker](./Using-Docker.md#using-docker)
* See also the [examples](../../etc/examples) directory
Altekruse, Jason Morgan
committed
---
 [U.S. Geological Survey](https://www.usgs.gov)
Altekruse, Jason Morgan
committed
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))