From 48d3cfeae31f36837f4afa87d083a8f7d32ce98a Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Tue, 20 Dec 2022 13:49:54 -0700
Subject: [PATCH] config docs edits
---
docs/pages/Calculation-Configuration.md | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index 56ad1e78..74a5c5f4 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -14,16 +14,19 @@ 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]
+ `.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)
- `.gmmDampingRatio` |`Double` | `0.05` (5%) | [3](#notes)
- `.gmmSigmaScale` |`Double` | `1.0` (100%, no scaling) |
- `.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`][url-valueformat]
+ `.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
__`disagg`__
`.retrunPeriod` |`Double` | `2475` |
`.bins` |`Object` | | [4](#notes)
@@ -31,18 +34,18 @@ __`disagg`__
__`rate`__
`.bins` |`Object` | | [6](#notes)
`.distance` |`Double` | `20` km
- `.distributionFormat` |`String` | `INCREMENTAL` | [`DistributionFormat`][url-distribution]
+ `.distributionFormat` |`String` | `"INCREMENTAL"` | [`DistributionFormat`][url-distribution]
`.timespan` |`Double` | `30` years
- `.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`][url-valueformat]
+ `.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]
+ `.dataTypes` |`String[]` | `["TOTAL","MAP"]` | [`DataType`][url-datatype]
+ `.returnPeriods` |`Double[]` | `[475,975,2475,10000]` | [`ReturnPeriods`][url-returnperiods]
__`performance`__
`.optimizeGrids` |`Boolean` | `true` | [7](#notes)
`.smoothGrids` |`Boolean` | `true` | [8](#notes)
`.systemPartition` |`Integer` | `1000` | [9](#notes)
- `.threadCount` |`String` | `ALL` | [`ThreadCount`][url-sheets]
+ `.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
--
GitLab