Skip to content
Snippets Groups Projects

Production Release | nshmp-haz

Merged Production Release | nshmp-haz
main into production
Merged Clayton, Brandon Scott requested to merge main into production
Compare
and
7 files
+ 262
− 19
Compare changes
  • Side-by-side
  • Inline
Files
7
docs/pages/Calculation-Configuration.md
+ 18
− 13
@@ -14,38 +14,43 @@ 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]
   `.exceedanceModel` |`String` | `"TRUNCATION_3SIGMA_UPPER"`| [`ExceedanceModel`][url-exceedance]
   `.truncationLevel` |`Double` | `3.0` | [1](#notes)
   `.imts` |`String[]` | `[ PGV, PGA, SA0P01, SA0P02, SA0P03, SA0P05, SA0P075, SA0P1, SA0P15, SA0P2, SA0P25, SA0P3, SA0P4, SA0P5, SA0P75, SA1P0, SA1P5, SA2P0, SA3P0, SA4P0, SA5P0, SA7P5, SA10P0 ]` | [`Imt`][url-imt]
   `.tectonicSettings` |`String[]` | `[]` | Tectonic setting filter
   `.sourceTypes` |`String[]` | `[]` | Source type filter
&nbsp;&nbsp;&nbsp;`.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]
&nbsp;&nbsp;&nbsp;`.tectonicSettings` |`String[]` | `[]` | [`TectonicSetting`][url-tectonicsetting] filter
&nbsp;&nbsp;&nbsp;`.sourceTypes` |`String[]` | `[]` | [`SourceType`][url-sourcetype] filter
&nbsp;&nbsp;&nbsp;`.vs30s` |`Double[]` | `[]` | Vs30s to use for batch jobs
&nbsp;&nbsp;&nbsp;`.useSiteData` |`Boolean` | `true` | Enable site data (e.g. basin depths)
&nbsp;&nbsp;&nbsp;`.customImls` |`Map<String, Double[]>` | `{}` (empty object) | [2](#notes)
&nbsp;&nbsp;&nbsp;`.gmmDampingRatio` |`Double` | `0.05` (5%) | [3](#notes)
&nbsp;&nbsp;&nbsp;`.gmmSigmaScale` |`Double` | `1.0` (100%, no scaling) |
&nbsp;&nbsp;&nbsp;`.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`][url-valueformat]
&nbsp;&nbsp;&nbsp;`.valueFormat` |`String` | `"ANNUAL_RATE"` | [`ValueFormat`][url-valueformat]
__`gmm`__
&nbsp;&nbsp;&nbsp;`.dampingRatio` |`Double` | `0.05` (5%) | Limited to range [0.005..0.3] 0.5% to 30%
&nbsp;&nbsp;&nbsp;`.sigmaScale` |`Double` | `1.0` (100%, no scaling) | Limited to range [0.5..1.0] 50% to 100%
&nbsp;&nbsp;&nbsp;`.vertical` |`Boolean` | `false` | Compute vertical ground motions
__`disagg`__
&nbsp;&nbsp;&nbsp;`.retrunPeriod` |`Double` | `2475` |
&nbsp;&nbsp;&nbsp;`.returnPeriod` |`Double` | `2475` |
&nbsp;&nbsp;&nbsp;`.bins` |`Object` | | [4](#notes)
&nbsp;&nbsp;&nbsp;`.contributorLimit` |`Double` | `0.1` | [5](#notes)
__`rate`__
&nbsp;&nbsp;&nbsp;`.bins` |`Object` | | [6](#notes)
&nbsp;&nbsp;&nbsp;`.distance` |`Double` | `20` km
&nbsp;&nbsp;&nbsp;`.distributionFormat` |`String` | `INCREMENTAL` | [`DistributionFormat`][url-distribution]
&nbsp;&nbsp;&nbsp;`.distributionFormat` |`String` | `"INCREMENTAL"` | [`DistributionFormat`][url-distribution]
&nbsp;&nbsp;&nbsp;`.timespan` |`Double` | `30` years
&nbsp;&nbsp;&nbsp;`.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`][url-valueformat]
&nbsp;&nbsp;&nbsp;`.valueFormat` |`String` | `"ANNUAL_RATE"` | [`ValueFormat`][url-valueformat]
__`output`__ |
&nbsp;&nbsp;&nbsp;`.directory` |`String` | `hazout`
&nbsp;&nbsp;&nbsp;`.dataTypes` |`String[]` | `[ TOTAL, MAP ]` | [`DataType`][url-datatype]
&nbsp;&nbsp;&nbsp;`.returnPeriods` |`Double[]` | `[ 475, 975, 2475, 10000]` | [`ReturnPeriods`][url-returnperiods]
&nbsp;&nbsp;&nbsp;`.dataTypes` |`String[]` | `["TOTAL","MAP"]` | [`DataType`][url-datatype]
&nbsp;&nbsp;&nbsp;`.returnPeriods` |`Double[]` | `[475,975,2475,10000]` | [`ReturnPeriods`][url-returnperiods]
__`performance`__
&nbsp;&nbsp;&nbsp;`.optimizeGrids` |`Boolean` | `true` | [7](#notes)
&nbsp;&nbsp;&nbsp;`.smoothGrids` |`Boolean` | `true` | [8](#notes)
&nbsp;&nbsp;&nbsp;`.systemPartition` |`Integer` | `1000` | [9](#notes)
&nbsp;&nbsp;&nbsp;`.threadCount` |`String` | `ALL` | [`ThreadCount`][url-sheets]
&nbsp;&nbsp;&nbsp;`.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