From 91da47cd70c1d58fec5236ea9454400094c6ab1e Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Fri, 25 Jun 2021 11:55:59 -0600
Subject: [PATCH 01/17] this is to work out relative doc links on gitlab
---
docs/pages/USGS-Models.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md
index b7659a3f5..b8d88c95e 100644
--- a/docs/pages/USGS-Models.md
+++ b/docs/pages/USGS-Models.md
@@ -27,10 +27,10 @@ Each model region has a dedicated repository with version tags marking different
## Related Pages
-* [Model Editions](model-editions)
-* [Logic Trees & Uncertainty](logic-trees-&-uncertainty)
+* [Model Editions](model-editions.md)
+* [Logic Trees & Uncertainty](logic-trees-&-uncertainty.md)
-[**Documentation Index**](docs)
+[**Documentation Index**](docs/README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
--
GitLab
From a94f3e9196751ed79bedee326275bcced01f6b3f Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Fri, 25 Jun 2021 12:13:35 -0600
Subject: [PATCH 02/17] link to docs is local, then navigation works in checked
out local copy or on gitlab, but does not take users to gitlab from a local
copy
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c6523b5ba..849cd483d 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,4 @@ command line applications and web service classes and relies on the
[*nshmp-lib*](https://code.usgs.gov/ghsc/nshmp/nshmp-lib) hazard library, among other
dependencies.
-Please see the [docs](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/docs) for more information.
+Please see the [docs](docs/README.md) for more information.
--
GitLab
From 73e7e8589d3a71fe2d146f27ebb06dc8e834aa8f Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Fri, 25 Jun 2021 12:45:19 -0600
Subject: [PATCH 03/17] updating links, cleanup
---
docs/README.md | 10 +++++-----
docs/pages/Building-&-Running.md | 19 ++++++++++---------
.../Magnitude-Frequency-Distributions.md | 6 ++++--
3 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 3ef557e3b..3b01c8111 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,9 +1,9 @@
# Documentation: nshmp-haz
-***nshmp-haz*** is a USGS developed software stack that supports probabilistic seismic hazard
-(PSHA) and related analyses. It is maintained by the National Seismic Hazard Model Project
-([NSHMP](https://earthquake.usgs.gov/hazards/)) within the U.S. Geological Survey's
-([USGS](https://www.usgs.gov)) earthquake hazards program ([EHP](http://earthquake.usgs.gov)).
+***nshmp-haz*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack
+that supports probabilistic seismic hazard (PSHA) and related analyses. It is maintained by the
+National Seismic Hazard Model Project ([NSHMP](https://earthquake.usgs.gov/hazards/)) within the
+USGS's earthquake hazards program ([EHP](http://earthquake.usgs.gov)).
*nshmp-haz* supports high performance seismic hazard calculations required to generate detailed
maps over large areas and supports a variety of USGS web services and applications related to
@@ -31,7 +31,7 @@ to use *nshmp-haz* as well as underlying model implementation details.
## Other Pages & References
-* [nshmp-lib](/ghsc/nshmp/nshmp-lib): USGS hazard modeling library
+* [nshmp-lib](https://code.usgs.gov/ghsc/nshmp/nshmp-lib): USGS hazard modeling library
* [Functional PSHA](pages/Functional-PSHA.md)
* [Probabilistic Seismic Hazard Analysis, a Primer
[PDF]](http://www.opensha.org/sites/opensha.org/files/PSHA_Primer_v2_0.pdf)
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index 2184c25f1..8983bde40 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -40,15 +40,16 @@ measures. For example:
java -cp path/to/nshmp-haz.jar gov.usgs.earthquake.nshmp.HazardCalc model sites [config]
```
-At a minimum, the hazard source [model](hazard-model) and the [site](site-specification)(s) at
+At a minimum, the hazard source [model](Hazard-Model.md) and the [site](Site-Specification.md)(s) at
which to perform calculations must be specified. The source model should specified a path to a
directory. A single site may be specified with a string; multiple sites must be specified using
either a comma-delimited (CSV) or [GeoJSON](http://geojson.org) file. The path to a custom
-[configuration](calculation-configuration) file containing user-specific settings may optionally
+[configuration](Calculation-Configuration.md) file containing user-specific settings may optionally
be supplied as a third argument. It can be used to override any calculation settings; if absent
-[default](calculation-configuration) values are used.
+[default](Calculation-Configuration.md) values are used.
-See the [examples](/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples) directory for more details.
+See the [examples](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)
+directory for more details.
### Computing Disaggregations
@@ -62,7 +63,7 @@ java -cp nshmp-haz.jar gov.usgs.earthquake.nshmp.DisaggCalc model sites returnPe
Disaggregations build on and output `HazardCalc` results along with other disaggregation specific
files. Disaggregations also have some independent
-[configuration](calculation-configuration#config-disagg) options.
+[configuration](Calculation-Configuration.md#config-disagg) options.
## Run with [Docker](https://docs.docker.com/install/)
@@ -112,17 +113,17 @@ Where: (TODO links below need checking)
* hazard = `HazardCalc`
* rate = `RateCalc`
-* `MODEL` is the [USGS model (NSHM)](usgs-models) to run:
- * CONUS-2018: [Conterminous U.S. 2018](https://github.com/usgs/nshm-conus)
+* `MODEL` is the [USGS model (NSHM)](USGS-Models.md) to run:
+ * CONUS-2018: [Conterminous U.S. 2018](https://code.usgs.gov/ghsc/nshmp/nshm-conus)
* HAWAII-2021: [Hawaii 2021](https://code.usgs.gov/ghsc/nshmp/nshm-hawaii)
* `RETURN_PERIOD`, in years, is only required when running a disaggregation
* Other arguments:
- * (required) The absolute path to a GeoJSON or CSV [site(s)](site-specification) file
+ * (required) The absolute path to a GeoJSON or CSV [site(s)](Site-Specification.md) file
* CSV example: `$(pwd)/my-csv-sites.csv:/app/sites.csv`
* GeoJSON example: `$(pwd)/my-geojson-sites.geojson:/app/sites.geojson`
- * (optional) The absolute path to a [configuration](calculation-configuration) file
+ * (optional) The absolute path to a [configuration](Calculation-Configuration.md) file
* Example: `$(pwd)/my-custom-config.json:/app/config.json`
* (required) The absolute path to an output directory
* Example: `$(pwd)/my-hazard-output:/app/output`
diff --git a/docs/pages/Magnitude-Frequency-Distributions.md b/docs/pages/Magnitude-Frequency-Distributions.md
index 660adb59f..2abe4485a 100644
--- a/docs/pages/Magnitude-Frequency-Distributions.md
+++ b/docs/pages/Magnitude-Frequency-Distributions.md
@@ -48,6 +48,8 @@ tree of rates for a source is also present in a model. Example:
## Tapered Gutenberg–Richter
+TODO: Need a new link for tapered GR MFD
+
A [tapered Gutenberg-Richter](http://scec.ess.ucla.edu/~ykagan/moms_index.html) MFD is similar to
Gutenberg-Richter, above, but with an exponential taper applied with a corner magnitude of `mCut`.
The `a`-value member is optional when a logic tree of rates for a source is also present in a
@@ -98,8 +100,6 @@ example:
}
```
-**mfd-config.json:**
-
MFD confguration files:
* mfd-map.json
@@ -255,6 +255,8 @@ Depending on the types of MFDs being modeled, a rate file may contain Gutenberg-
or magnitude-specific rates. The branches of a rate-tree commonly have the generic ID's:
`[R1, R2, R3, ...]` to support matching rate-trees across source-tree branches.
+TODO: convert example to JSON format (or see `mfd-config.json` section above)
+
```xml
<!-- (optional) A magnitude uncertainty model that will be
applied to every source:
--
GitLab
From fc942f1859d248256b1e47244383817077f5eb89 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Mon, 28 Jun 2021 15:17:56 -0600
Subject: [PATCH 04/17] add documentation index link, USGS page footer. include
horizontal line above index link to separate from content
---
docs/pages/About-the-NSHMP.md | 8 ++++++++
docs/pages/Building-&-Running.md | 8 ++++++++
docs/pages/Calculation-Configuration.md | 8 ++++++++
docs/pages/Developer-Basics.md | 8 ++++++++
docs/pages/Functional-PSHA.md | 8 ++++++++
docs/pages/Ground-Motion-Models.md | 8 ++++++++
docs/pages/Hazard-Model.md | 8 ++++++++
docs/pages/Logic-Trees-&-Uncertainty.md | 8 ++++++++
docs/pages/Magnitude-Frequency-Distributions.md | 8 ++++++++
docs/pages/Model-Editions.md | 10 ++++++++++
docs/pages/Model-Files.md | 8 ++++++++
docs/pages/Model-Structure.md | 8 ++++++++
docs/pages/Rupture-Scaling-Relations.md | 8 ++++++++
docs/pages/Site-Specification.md | 8 ++++++++
docs/pages/Source-Types.md | 6 ++++++
docs/pages/USGS-Models.md | 2 ++
16 files changed, 122 insertions(+)
diff --git a/docs/pages/About-the-NSHMP.md b/docs/pages/About-the-NSHMP.md
index 0e1c508a2..03337a1ed 100644
--- a/docs/pages/About-the-NSHMP.md
+++ b/docs/pages/About-the-NSHMP.md
@@ -21,3 +21,11 @@ An NSHM defines the set of likely earthquake sources and their rates in a partic
parameters of the earhtquake source and a site of interest, ground motion models (GMMs) are used
to estimate ground shaking from the set of earthquakes. The NSHMP routinely updates NSHMs for the
U.S. and its territories to consider the best available science.
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index 8983bde40..fb8bcf6c1 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -145,3 +145,11 @@ Where:
* `JAVA_XMS` is the intial memory for the JVM (default: system)
* `JAVA_XMX` is the maximum memory for the JVM (default: 8g)
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index e79851b26..24b924412 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -93,3 +93,11 @@ T ≤ 4 s | 0.00133, 0.00200, 0.00300, 0.00449, 0.00674, 0.0101, 0.0152, 0.02
T ≤ 5 s | 0.000999, 0.00150, 0.00225, 0.00337, 0.00506, 0.00758, 0.0114, 0.0171, 0.0256, 0.0384, 0.0576, 0.0864, 0.130, 0.194, 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, 0.00569, 0.00853, 0.0128, 0.0192, 0.0288, 0.0432, 0.0648, 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, 0.00379, 0.00569, 0.00853, 0.0128, 0.0192, 0.0288, 0.0432, 0.0648, 0.0972, 0.146, 0.219, 0.328, 0.492, 0.738
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index 51cf8c2cd..4971195fd 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -58,3 +58,11 @@ install the [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/
[Eclipse IDE for Enterprise Java and Web Developers](https://www.eclipse.org/downloads/packages/),
if you plan on developing web services. Import the project into Eclipse: `File > Import >
Gradle > Existing Gradle Project`
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Functional-PSHA.md b/docs/pages/Functional-PSHA.md
index 726864a1d..2c1d1464d 100644
--- a/docs/pages/Functional-PSHA.md
+++ b/docs/pages/Functional-PSHA.md
@@ -158,3 +158,11 @@ The functional pipeline can be processed stepwise:
pp. 973-987.
* Cornell, C.A., 1968, Engineering seismic risk analysis, *Bulletin of the Seismological Society
of America*, Vol. 58, No. 5, pp. 1583-1606.
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index 82f109b62..16c21ffb1 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -158,3 +158,11 @@ modify model output.
|:---------:|:-------:|:---------:|:------|
| [Rezaeian et al., 2014](http://dx.doi.org/10.1193/100512EQS298M) | Damping scaling factor | Average horizontal component | No effect if supplied damping ratio is 5% |
| USGS PGV | Conditional PGV for crustal earthquakes | Horizontal component | Conditional model for vertical component not yet implemented |
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Hazard-Model.md b/docs/pages/Hazard-Model.md
index 005e738f1..63fb4c623 100644
--- a/docs/pages/Hazard-Model.md
+++ b/docs/pages/Hazard-Model.md
@@ -31,3 +31,11 @@ support modeling of complex logic trees.
territories. Although hazard close to the borders can be useful for comparison to other models,
the further one drifts from the U.S. border, the more incomplete the underlying earthquake
source model will be.
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Logic-Trees-&-Uncertainty.md b/docs/pages/Logic-Trees-&-Uncertainty.md
index 5b51aaec2..7e7de9fe7 100644
--- a/docs/pages/Logic-Trees-&-Uncertainty.md
+++ b/docs/pages/Logic-Trees-&-Uncertainty.md
@@ -122,3 +122,11 @@ alternative models.
* Full: a.k.a. 'characteristic'
* Partial: a.k.a. 'Gutenberg-Richter' or 'floating'
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Magnitude-Frequency-Distributions.md b/docs/pages/Magnitude-Frequency-Distributions.md
index 2abe4485a..e4a5acdc9 100644
--- a/docs/pages/Magnitude-Frequency-Distributions.md
+++ b/docs/pages/Magnitude-Frequency-Distributions.md
@@ -283,3 +283,11 @@ TODO: convert example to JSON format (or see `mfd-config.json` section above)
</Settings>
```
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Editions.md b/docs/pages/Model-Editions.md
index e4524a35c..5d8aaf187 100644
--- a/docs/pages/Model-Editions.md
+++ b/docs/pages/Model-Editions.md
@@ -94,6 +94,16 @@ documented on the [web services](web-services) page.
Changes between editions in model regions are documented in the release notes of the individual
model repositories.
+TODO: Update model links
+
* [Conterminous US (2014)](/usgs/nshmp-model-cous-2014/wiki)
* [Conterminous US (2008)](/usgs/nshmp-model-cous-2008/wiki)
* [Alaska (2007)](/usgs/nshmp-model-ak-2007/wiki)
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Files.md b/docs/pages/Model-Files.md
index f6433e2a2..c3fc8aee2 100644
--- a/docs/pages/Model-Files.md
+++ b/docs/pages/Model-Files.md
@@ -183,3 +183,11 @@ is composed of an array of rupture-sets.
]
}
```
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Structure.md b/docs/pages/Model-Structure.md
index c4fdfc6ca..bc1c4d37c 100644
--- a/docs/pages/Model-Structure.md
+++ b/docs/pages/Model-Structure.md
@@ -193,3 +193,11 @@ subduction-slab
```
See also: [Subduction Intraslab Source Type](source-types#subduction-intraslab-sources)
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Rupture-Scaling-Relations.md b/docs/pages/Rupture-Scaling-Relations.md
index 0a79a5e4f..08bc17652 100644
--- a/docs/pages/Rupture-Scaling-Relations.md
+++ b/docs/pages/Rupture-Scaling-Relations.md
@@ -67,3 +67,11 @@ the San Francisco Bay region: 2002– 2031, U.S. Geol. Surv. Open-File Report 20
Youngs RR, Chiou B-SJ, Silva WJ, and Humphrey JR (1997) Strong ground motion attenuation
relationships for subduction zone earthquakes. Seismological Research Letters 68(?): 58–73.
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index c2a27fa42..91fd299e4 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -108,3 +108,11 @@ parallel to lines of latitude and longitude. Any points in the 'calculation' pol
outside the 'calculation' polygon are set to zero. For an example, see the
[NSHMP Western US](/usgs/nshmp-haz/blob/master/etc/nshm/map-wus.geojson) map site file.
(TODO This needs updating; link to conus-2018 active crust map-region.geojson).
+
+---
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Source-Types.md b/docs/pages/Source-Types.md
index 86278011b..158ed7eb5 100644
--- a/docs/pages/Source-Types.md
+++ b/docs/pages/Source-Types.md
@@ -344,3 +344,9 @@ using an `interface-config.json` file.
Subduction intraslab sources are currently specified the same way as
[grid sources](#grid-sources) in curstal tectonic settings. Source model properties are defined
using an `slab-config.json` file.
+
+[**Documentation Index**](docs/README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md
index b8d88c95e..294125bef 100644
--- a/docs/pages/USGS-Models.md
+++ b/docs/pages/USGS-Models.md
@@ -25,6 +25,8 @@ Each model region has a dedicated repository with version tags marking different
* Puerto Rico & U.S. Virgin Islands - _update not yet published_
* Samoa & Pacific Islands - _update not yet published_
+---
+
## Related Pages
* [Model Editions](model-editions.md)
--
GitLab
From 4fad9d3df5e24b2945d8970186a24d6cf12295d7 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Mon, 28 Jun 2021 15:41:39 -0600
Subject: [PATCH 05/17] fix relative link to USGS logo
---
docs/pages/About-the-NSHMP.md | 2 +-
docs/pages/Building-&-Running.md | 2 +-
docs/pages/Calculation-Configuration.md | 2 +-
docs/pages/Functional-PSHA.md | 2 +-
docs/pages/Ground-Motion-Models.md | 2 +-
docs/pages/Hazard-Model.md | 2 +-
docs/pages/Logic-Trees-&-Uncertainty.md | 2 +-
docs/pages/Magnitude-Frequency-Distributions.md | 2 +-
docs/pages/Model-Editions.md | 2 +-
docs/pages/Model-Files.md | 2 +-
docs/pages/Model-Structure.md | 2 +-
docs/pages/Rupture-Scaling-Relations.md | 2 +-
docs/pages/Source-Types.md | 4 +++-
docs/pages/USGS-Models.md | 2 +-
14 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/docs/pages/About-the-NSHMP.md b/docs/pages/About-the-NSHMP.md
index 03337a1ed..76f1ce136 100644
--- a/docs/pages/About-the-NSHMP.md
+++ b/docs/pages/About-the-NSHMP.md
@@ -27,5 +27,5 @@ U.S. and its territories to consider the best available science.
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index fb8bcf6c1..beda1c7e4 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -151,5 +151,5 @@ Where:
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index 24b924412..f76ae6386 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -99,5 +99,5 @@ T ≤ 10 s | 0.000333, 0.000499, 0.000749, 0.00112, 0.00169, 0.00253, 0.00379,
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Functional-PSHA.md b/docs/pages/Functional-PSHA.md
index 2c1d1464d..40348be7a 100644
--- a/docs/pages/Functional-PSHA.md
+++ b/docs/pages/Functional-PSHA.md
@@ -164,5 +164,5 @@ The functional pipeline can be processed stepwise:
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index 16c21ffb1..4527f365d 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -164,5 +164,5 @@ modify model output.
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Hazard-Model.md b/docs/pages/Hazard-Model.md
index 63fb4c623..fa537064e 100644
--- a/docs/pages/Hazard-Model.md
+++ b/docs/pages/Hazard-Model.md
@@ -37,5 +37,5 @@ support modeling of complex logic trees.
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Logic-Trees-&-Uncertainty.md b/docs/pages/Logic-Trees-&-Uncertainty.md
index 7e7de9fe7..b5db0a58a 100644
--- a/docs/pages/Logic-Trees-&-Uncertainty.md
+++ b/docs/pages/Logic-Trees-&-Uncertainty.md
@@ -128,5 +128,5 @@ alternative models.
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Magnitude-Frequency-Distributions.md b/docs/pages/Magnitude-Frequency-Distributions.md
index e4a5acdc9..9fd7e7c06 100644
--- a/docs/pages/Magnitude-Frequency-Distributions.md
+++ b/docs/pages/Magnitude-Frequency-Distributions.md
@@ -289,5 +289,5 @@ TODO: convert example to JSON format (or see `mfd-config.json` section above)
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Editions.md b/docs/pages/Model-Editions.md
index 5d8aaf187..bdecc204a 100644
--- a/docs/pages/Model-Editions.md
+++ b/docs/pages/Model-Editions.md
@@ -105,5 +105,5 @@ TODO: Update model links
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Files.md b/docs/pages/Model-Files.md
index c3fc8aee2..c1c485fad 100644
--- a/docs/pages/Model-Files.md
+++ b/docs/pages/Model-Files.md
@@ -189,5 +189,5 @@ is composed of an array of rupture-sets.
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Structure.md b/docs/pages/Model-Structure.md
index bc1c4d37c..df34c9fc4 100644
--- a/docs/pages/Model-Structure.md
+++ b/docs/pages/Model-Structure.md
@@ -199,5 +199,5 @@ See also: [Subduction Intraslab Source Type](source-types#subduction-intraslab-s
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Rupture-Scaling-Relations.md b/docs/pages/Rupture-Scaling-Relations.md
index 08bc17652..3e29c61b7 100644
--- a/docs/pages/Rupture-Scaling-Relations.md
+++ b/docs/pages/Rupture-Scaling-Relations.md
@@ -73,5 +73,5 @@ relationships for subduction zone earthquakes. Seismological Research Letters 68
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Source-Types.md b/docs/pages/Source-Types.md
index 158ed7eb5..baaf1f4f1 100644
--- a/docs/pages/Source-Types.md
+++ b/docs/pages/Source-Types.md
@@ -345,8 +345,10 @@ Subduction intraslab sources are currently specified the same way as
[grid sources](#grid-sources) in curstal tectonic settings. Source model properties are defined
using an `slab-config.json` file.
+---
+
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md
index 294125bef..7d28b81b6 100644
--- a/docs/pages/USGS-Models.md
+++ b/docs/pages/USGS-Models.md
@@ -35,5 +35,5 @@ Each model region has a dedicated repository with version tags marking different
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
--
GitLab
From d139970e3d6d0ba53b73a25bed1a7f24445f7168 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Mon, 28 Jun 2021 15:45:55 -0600
Subject: [PATCH 06/17] missed one
---
docs/pages/Developer-Basics.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index 4971195fd..7617ec072 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -64,5 +64,5 @@ Gradle > Existing Gradle Project`
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
--
GitLab
From de7ad638d516323dc2596f5ef7d1292a2da944d4 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Mon, 28 Jun 2021 16:22:50 -0600
Subject: [PATCH 07/17] fix links
---
docs/README.md | 6 +++++-
docs/pages/Site-Specification.md | 2 +-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 3b01c8111..9d211a6e0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -17,7 +17,7 @@ to use *nshmp-haz* as well as underlying model implementation details.
* [Developer Basics](pages/Developer-Basics.md)
* [Calculation Configuration](pages/Calculation-Configuration.md)
* [Site Specification](pages/Site-Specification.md)
- * [Examples](/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)
+ * [Examples](/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)
* [Hazard Model](pages/Hazard-Model.md)
* [Model Structure](pages/Model-Structure.md)
* [Model Files](pages/Model-Files.md)
@@ -40,3 +40,7 @@ to use *nshmp-haz* as well as underlying model implementation details.
[PDF]](http://web.stanford.edu/~bakerjw/Publications/Baker_(2015)_Intro_to_PSHA.pdf)
by Jack Baker
* [License](../LICENSE.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index 91fd299e4..3b3dfb497 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -114,5 +114,5 @@ outside the 'calculation' polygon are set to zero. For an example, see the
[**Documentation Index**](docs/README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
--
GitLab
From 55ba51db603e873042c2e3b78bfe1c97e8165de4 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Tue, 29 Jun 2021 08:46:04 -0600
Subject: [PATCH 08/17] fix links, cleanup
---
docs/README.md | 45 +++++++++++++++++-----------------
docs/pages/Developer-Basics.md | 10 ++++----
docs/pages/Functional-PSHA.md | 6 ++---
3 files changed, 31 insertions(+), 30 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 9d211a6e0..02bfc5e74 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,46 +1,47 @@
# Documentation: nshmp-haz
-***nshmp-haz*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack
+***nshmp-haz-v2*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack
that supports probabilistic seismic hazard (PSHA) and related analyses. It is maintained by the
National Seismic Hazard Model Project ([NSHMP](https://earthquake.usgs.gov/hazards/)) within the
USGS's earthquake hazards program ([EHP](http://earthquake.usgs.gov)).
-*nshmp-haz* supports high performance seismic hazard calculations required to generate detailed
+*nshmp-haz-v2* supports high performance seismic hazard calculations required to generate detailed
maps over large areas and supports a variety of USGS web services and applications related to
seismic hazards research and the dissemination of hazard data. This documentation explains how
-to use *nshmp-haz* as well as underlying model implementation details.
+to use *nshmp-haz-v2* as well as underlying model implementation details.
## Table of Contents
-* [About the NSHMP](pages/About-the-NSHMP.md)
-* [Building & Running](pages/Building-&-Running.md)
- * [Developer Basics](pages/Developer-Basics.md)
- * [Calculation Configuration](pages/Calculation-Configuration.md)
- * [Site Specification](pages/Site-Specification.md)
- * [Examples](/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)
-* [Hazard Model](pages/Hazard-Model.md)
- * [Model Structure](pages/Model-Structure.md)
- * [Model Files](pages/Model-Files.md)
- * [Source Types](pages/Source-Types.md)
- * [Magnitude Frequency Distributions (MFDs)](pages/Magnitude-Frequency-Distributions.md)
- * [Rupture Scaling Relations](pages/Rupture-Scaling-Relations.md)
- * [Ground Motion Models (GMMs)](pages/Ground-Motion-Models.md)
-* [USGS Models](pages/USGS-Models.md)
- * [Model Editions](pages/Model-Editions.md)
- * [Logic Trees & Uncertainty](pages/Logic-Trees-&-Uncertainty.md)
+* [About the NSHMP](./pages/About-the-NSHMP.md)
+* [Building & Running](./pages/Building-&-Running.md)
+ * [Developer Basics](./pages/Developer-Basics.md)
+ * [Calculation Configuration](./pages/Calculation-Configuration.md)
+ * [Site Specification](./pages/Site-Specification.md)
+ * Examples [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)
+ or [in a local copy](../etc/examples/README.md)
+* [Hazard Model](./pages/Hazard-Model.md)
+ * [Model Structure](./pages/Model-Structure.md)
+ * [Model Files](./pages/Model-Files.md)
+ * [Source Types](./pages/Source-Types.md)
+ * [Magnitude Frequency Distributions (MFDs)](./pages/Magnitude-Frequency-Distributions.md)
+ * [Rupture Scaling Relations](./pages/Rupture-Scaling-Relations.md)
+ * [Ground Motion Models (GMMs)](./pages/Ground-Motion-Models.md)
+* [USGS Models](./pages/USGS-Models.md)
+ * [Model Editions](./pages/Model-Editions.md)
+ * [Logic Trees & Uncertainty](./pages/Logic-Trees-&-Uncertainty.md)
## Other Pages & References
* [nshmp-lib](https://code.usgs.gov/ghsc/nshmp/nshmp-lib): USGS hazard modeling library
-* [Functional PSHA](pages/Functional-PSHA.md)
+* [Functional PSHA](./pages/Functional-PSHA.md)
* [Probabilistic Seismic Hazard Analysis, a Primer
[PDF]](http://www.opensha.org/sites/opensha.org/files/PSHA_Primer_v2_0.pdf)
by Edward Field
* [An Introduction to Probabilistic Seismic Hazard Analysis
[PDF]](http://web.stanford.edu/~bakerjw/Publications/Baker_(2015)_Intro_to_PSHA.pdf)
by Jack Baker
-* [License](../LICENSE.md)
+* [*nshmp-haz-v2* License](../LICENSE.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index 7617ec072..791ab835b 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -7,11 +7,11 @@ The following provides basic guidance on how to set up command-line use of nshmp
* Java 11 JDK: [Oracle](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) or
[Amazon Corretto](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)
* [Git](https://git-scm.com/downloads)
- * Git is a distributed version control system. The USGS uses a [GitLab](https://docs.gitlab.com)
- [instance](https://code.usgs.gov/) to host projects and facilitate sharing and collaborative
- development of code. Git is included in the macOS
- [developer tools](https://developer.apple.com/xcode/).
- * Windows users may want to consider [Git for Windows](https://git-for-windows.github.io) or
+ * Git is a [distributed version control system](https://en.wikipedia.org/wiki/Distributed_version_control).
+ The USGS uses a [GitLab](https://docs.gitlab.com) [instance](https://code.usgs.gov/) to host
+ projects and facilitate sharing and collaborative development of code.
+ * On **macOS**, Git is included in the [developer tools](https://developer.apple.com/xcode/).
+ * On **Windows**, users may want to consider [Git for Windows](https://git-for-windows.github.io) or
[GitHub Desktop](https://desktop.github.com), both of which include a linux-like terminal
(Git BASH) in which subsequent commands listed here will work.
diff --git a/docs/pages/Functional-PSHA.md b/docs/pages/Functional-PSHA.md
index 40348be7a..8ba8ac361 100644
--- a/docs/pages/Functional-PSHA.md
+++ b/docs/pages/Functional-PSHA.md
@@ -111,7 +111,7 @@ foreach IMT {
may write [sqr = @(x) x.^2;].
* In Matlab, one may pass function ‘handles’ (references) to other functions as arguments. This
is also possible in Javascript, where such handles serve as callbacks. Given the rise in
- popularity of the functional style, Java 8 recently added constructs in the form of the function
+ popularity of the functional style, Java 8 added constructs in the form of the function
and streaming APIs, and libraries exists for other languages.
## How do PSHA and related calculations leverage such an approach?
@@ -161,8 +161,8 @@ The functional pipeline can be processed stepwise:
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
--
GitLab
From eaecd0bc1e8b7f5244746b9d6233d66858595ff2 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Tue, 29 Jun 2021 08:46:47 -0600
Subject: [PATCH 09/17] examples link to READMEs. todo: expand example
navigation
---
etc/examples/1-hazard-curve/README.md | 2 +-
etc/examples/2-custom-config/README.md | 2 +-
etc/examples/3-sites-file/README.md | 2 +-
etc/examples/4-hazard-map/README.md | 2 +-
etc/examples/5-complex-model/README.md | 2 +-
etc/examples/6-enhanced-output/README.md | 2 +-
etc/examples/7-deaggregation/README.md | 2 +-
etc/examples/README.md | 2 +-
8 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/etc/examples/1-hazard-curve/README.md b/etc/examples/1-hazard-curve/README.md
index 0d19048cc..0c53d3df5 100644
--- a/etc/examples/1-hazard-curve/README.md
+++ b/etc/examples/1-hazard-curve/README.md
@@ -44,4 +44,4 @@ __Results directory structure:__
In the next example, we'll override the model supplied configuration with a custom file.
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 2 – A custom configuration](../2-custom-config)
+#### Next: [Example 2 – A custom configuration](../2-custom-config/README.md)
diff --git a/etc/examples/2-custom-config/README.md b/etc/examples/2-custom-config/README.md
index e5d05461c..2025aa249 100644
--- a/etc/examples/2-custom-config/README.md
+++ b/etc/examples/2-custom-config/README.md
@@ -37,4 +37,4 @@ __Results directory structure:__
```
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 3 – Using a custom sites file](../3-sites-file)
+#### Next: [Example 3 – Using a custom sites file](../3-sites-file/README.md)
diff --git a/etc/examples/3-sites-file/README.md b/etc/examples/3-sites-file/README.md
index 3f5e64e1d..3c8b89d26 100644
--- a/etc/examples/3-sites-file/README.md
+++ b/etc/examples/3-sites-file/README.md
@@ -38,4 +38,4 @@ __Results directory structure:__
```
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 4 – A simple hazard map](../4-hazard-map)
+#### Next: [Example 4 – A simple hazard map](../4-hazard-map/README.md)
diff --git a/etc/examples/4-hazard-map/README.md b/etc/examples/4-hazard-map/README.md
index 76fa10714..e2a1893c2 100644
--- a/etc/examples/4-hazard-map/README.md
+++ b/etc/examples/4-hazard-map/README.md
@@ -27,4 +27,4 @@ __Results directory structure:__
```
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 5 – A more complex model](../5-complex-model)
+#### Next: [Example 5 – A more complex model](../5-complex-model/README.md)
diff --git a/etc/examples/5-complex-model/README.md b/etc/examples/5-complex-model/README.md
index dfbaf4444..2fcb2903d 100644
--- a/etc/examples/5-complex-model/README.md
+++ b/etc/examples/5-complex-model/README.md
@@ -66,4 +66,4 @@ __Results directory structure:__
```
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 6 – Enhanced output](../6-enhanced-output)
+#### Next: [Example 6 – Enhanced output](../6-enhanced-output/README.md)
diff --git a/etc/examples/6-enhanced-output/README.md b/etc/examples/6-enhanced-output/README.md
index f4d81c44c..546c9dd68 100644
--- a/etc/examples/6-enhanced-output/README.md
+++ b/etc/examples/6-enhanced-output/README.md
@@ -52,4 +52,4 @@ __Results directory structure:__
```
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 7 – Deaggregation](../7-deaggregation)
+#### Next: [Example 7 – Deaggregation](../7-deaggregation/README.md)
diff --git a/etc/examples/7-deaggregation/README.md b/etc/examples/7-deaggregation/README.md
index cf1dec384..aa1f2d378 100644
--- a/etc/examples/7-deaggregation/README.md
+++ b/etc/examples/7-deaggregation/README.md
@@ -88,4 +88,4 @@ subduction GMMs (e.g. `AB_03_CASCADIA_SLAB`) for sites closer to the Cascadia su
empty results will not be saved.
<!-- markdownlint-disable MD001 -->
-#### Next: [Example 8 – Earthquake probabilities and rates](../8-probabilities)
+#### Next: [Example 8 – Earthquake probabilities and rates](../8-probabilities/README.md)
diff --git a/etc/examples/README.md b/etc/examples/README.md
index beb390bdb..db74aa10c 100644
--- a/etc/examples/README.md
+++ b/etc/examples/README.md
@@ -11,4 +11,4 @@ alias hazard='java -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar gov.usgs.eart
Because each example builds on prior concepts, it is best step through all the examples, however quickly.
<!-- markdownlint-disable MD001 -->
-#### Start: [Example 1 – A simple hazard calculation](1-hazard-curve)
+#### Start: [Example 1 – A simple hazard calculation](1-hazard-curve/README.md)
--
GitLab
From a1add27285fd35cc1cd1746052c56b9903f8bc43 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Tue, 29 Jun 2021 09:41:27 -0600
Subject: [PATCH 10/17] add link to documentation index for examples
---
etc/examples/1-hazard-curve/README.md | 4 ++++
etc/examples/2-custom-config/README.md | 4 ++++
etc/examples/3-sites-file/README.md | 4 ++++
etc/examples/4-hazard-map/README.md | 4 ++++
etc/examples/5-complex-model/README.md | 4 ++++
etc/examples/6-enhanced-output/README.md | 4 ++++
etc/examples/7-deaggregation/README.md | 4 ++++
etc/examples/8-probabilities/README.md | 4 ++++
etc/examples/README.md | 4 ++++
9 files changed, 36 insertions(+)
diff --git a/etc/examples/1-hazard-curve/README.md b/etc/examples/1-hazard-curve/README.md
index 0c53d3df5..ed8da9766 100644
--- a/etc/examples/1-hazard-curve/README.md
+++ b/etc/examples/1-hazard-curve/README.md
@@ -45,3 +45,7 @@ In the next example, we'll override the model supplied configuration with a cust
<!-- markdownlint-disable MD001 -->
#### Next: [Example 2 – A custom configuration](../2-custom-config/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/2-custom-config/README.md b/etc/examples/2-custom-config/README.md
index 2025aa249..33c8c381a 100644
--- a/etc/examples/2-custom-config/README.md
+++ b/etc/examples/2-custom-config/README.md
@@ -38,3 +38,7 @@ __Results directory structure:__
<!-- markdownlint-disable MD001 -->
#### Next: [Example 3 – Using a custom sites file](../3-sites-file/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/3-sites-file/README.md b/etc/examples/3-sites-file/README.md
index 3c8b89d26..f70f356a4 100644
--- a/etc/examples/3-sites-file/README.md
+++ b/etc/examples/3-sites-file/README.md
@@ -39,3 +39,7 @@ __Results directory structure:__
<!-- markdownlint-disable MD001 -->
#### Next: [Example 4 – A simple hazard map](../4-hazard-map/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/4-hazard-map/README.md b/etc/examples/4-hazard-map/README.md
index e2a1893c2..0c26c4102 100644
--- a/etc/examples/4-hazard-map/README.md
+++ b/etc/examples/4-hazard-map/README.md
@@ -28,3 +28,7 @@ __Results directory structure:__
<!-- markdownlint-disable MD001 -->
#### Next: [Example 5 – A more complex model](../5-complex-model/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/5-complex-model/README.md b/etc/examples/5-complex-model/README.md
index 2fcb2903d..79f7b17b1 100644
--- a/etc/examples/5-complex-model/README.md
+++ b/etc/examples/5-complex-model/README.md
@@ -67,3 +67,7 @@ __Results directory structure:__
<!-- markdownlint-disable MD001 -->
#### Next: [Example 6 – Enhanced output](../6-enhanced-output/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/6-enhanced-output/README.md b/etc/examples/6-enhanced-output/README.md
index 546c9dd68..61fffb7a1 100644
--- a/etc/examples/6-enhanced-output/README.md
+++ b/etc/examples/6-enhanced-output/README.md
@@ -53,3 +53,7 @@ __Results directory structure:__
<!-- markdownlint-disable MD001 -->
#### Next: [Example 7 – Deaggregation](../7-deaggregation/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/7-deaggregation/README.md b/etc/examples/7-deaggregation/README.md
index aa1f2d378..4750f2aff 100644
--- a/etc/examples/7-deaggregation/README.md
+++ b/etc/examples/7-deaggregation/README.md
@@ -89,3 +89,7 @@ empty results will not be saved.
<!-- markdownlint-disable MD001 -->
#### Next: [Example 8 – Earthquake probabilities and rates](../8-probabilities/README.md)
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/8-probabilities/README.md b/etc/examples/8-probabilities/README.md
index 4574d2c43..38f3b7a6d 100644
--- a/etc/examples/8-probabilities/README.md
+++ b/etc/examples/8-probabilities/README.md
@@ -47,3 +47,7 @@ __Results directory structure:__
├─ RateCalc.log
└─ probs.csv
```
+
+---
+
+* [**Documentation Index**](../../../docs/README.md)
diff --git a/etc/examples/README.md b/etc/examples/README.md
index db74aa10c..b557f3baa 100644
--- a/etc/examples/README.md
+++ b/etc/examples/README.md
@@ -12,3 +12,7 @@ Because each example builds on prior concepts, it is best step through all the e
<!-- markdownlint-disable MD001 -->
#### Start: [Example 1 – A simple hazard calculation](1-hazard-curve/README.md)
+
+---
+
+* [**Documentation Index**](../../docs/README.md)
--
GitLab
From 17caf58c7671933489349de41fea39a0560f7f36 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Tue, 29 Jun 2021 11:06:13 -0600
Subject: [PATCH 11/17] updating links, building & running related docs, fixing
URLs
---
docs/README.md | 4 +-
docs/pages/About-the-NSHMP.md | 4 +-
docs/pages/Building-&-Running.md | 51 +++++++------
docs/pages/Calculation-Configuration.md | 73 +++++++++++--------
docs/pages/Developer-Basics.md | 12 ++-
docs/pages/Ground-Motion-Models.md | 4 +-
docs/pages/Hazard-Model.md | 4 +-
docs/pages/Logic-Trees-&-Uncertainty.md | 6 +-
.../Magnitude-Frequency-Distributions.md | 4 +-
docs/pages/Model-Editions.md | 4 +-
docs/pages/Model-Files.md | 4 +-
docs/pages/Model-Structure.md | 4 +-
docs/pages/Rupture-Scaling-Relations.md | 4 +-
docs/pages/Site-Specification.md | 37 ++++++----
docs/pages/Source-Types.md | 10 +--
docs/pages/USGS-Models.md | 6 +-
etc/nshm/README.md | 3 +
17 files changed, 137 insertions(+), 97 deletions(-)
create mode 100644 etc/nshm/README.md
diff --git a/docs/README.md b/docs/README.md
index 02bfc5e74..3eba4574a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -17,8 +17,8 @@ to use *nshmp-haz-v2* as well as underlying model implementation details.
* [Developer Basics](./pages/Developer-Basics.md)
* [Calculation Configuration](./pages/Calculation-Configuration.md)
* [Site Specification](./pages/Site-Specification.md)
- * Examples [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)
- or [in a local copy](../etc/examples/README.md)
+ * [Examples](../../etc/examples/README.md) (or
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
* [Hazard Model](./pages/Hazard-Model.md)
* [Model Structure](./pages/Model-Structure.md)
* [Model Files](./pages/Model-Files.md)
diff --git a/docs/pages/About-the-NSHMP.md b/docs/pages/About-the-NSHMP.md
index 76f1ce136..2ee3a89ea 100644
--- a/docs/pages/About-the-NSHMP.md
+++ b/docs/pages/About-the-NSHMP.md
@@ -24,8 +24,8 @@ U.S. and its territories to consider the best available science.
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index beda1c7e4..3a1bd0cc0 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -2,7 +2,12 @@
## Related Pages
-TODO
+* Building & Running
+ * [Developer Basics](./Developer-Basics.md)
+ * [Calculation Configuration](./Calculation-Configuration.md)
+ * [Site Specification](./Site-Specification.md)
+ * [Examples](../../etc/examples/README.md) (or
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
## Build & Run Options
@@ -11,12 +16,12 @@ TODO
## Build and Run Locally
-Building and running *nshmp-haz* requires prior installation of Git and Java. Please see the
-[developer basics](developer-basics) page for system configuration guidance.
+Building and running *nshmp-haz-v2* requires prior installation of Git and Java. Please see the
+[developer basics](./Developer-Basics.md) page for system configuration guidance.
### Building
-Navigate to a location on your system where you want *nshmp-haz* code to reside, clone the
+Navigate to a location on your system where you want *nshmp-haz-v2* code to reside, clone the
repository, and compile:
```bash
@@ -40,16 +45,16 @@ measures. For example:
java -cp path/to/nshmp-haz.jar gov.usgs.earthquake.nshmp.HazardCalc model sites [config]
```
-At a minimum, the hazard source [model](Hazard-Model.md) and the [site](Site-Specification.md)(s) at
-which to perform calculations must be specified. The source model should specified a path to a
+At a minimum, the hazard source [model](./Hazard-Model.md) and the [site](./Site-Specification.md)(s)
+at which to perform calculations must be specified. The source model should specified a path to a
directory. A single site may be specified with a string; multiple sites must be specified using
either a comma-delimited (CSV) or [GeoJSON](http://geojson.org) file. The path to a custom
-[configuration](Calculation-Configuration.md) file containing user-specific settings may optionally
+[configuration](./Calculation-Configuration.md) file containing user-specific settings may optionally
be supplied as a third argument. It can be used to override any calculation settings; if absent
-[default](Calculation-Configuration.md) values are used.
+[default](./Calculation-Configuration.md) values are used.
-See the [examples](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)
-directory for more details.
+See the [examples](../../etc/examples/README.md) directory for more details (or
+[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
### Computing Disaggregations
@@ -63,11 +68,11 @@ java -cp nshmp-haz.jar gov.usgs.earthquake.nshmp.DisaggCalc model sites returnPe
Disaggregations build on and output `HazardCalc` results along with other disaggregation specific
files. Disaggregations also have some independent
-[configuration](Calculation-Configuration.md#config-disagg) options.
+[configuration](./Calculation-Configuration.md#config-disagg) options.
## Run with [Docker](https://docs.docker.com/install/)
-To ensure you are have the latest *nshmp-haz* update, always first pull the image from Docker:
+To ensure you are have the latest *nshmp-haz-v2* update, always first pull the image from Docker:
```bash
docker pull usgs/nshmp-haz
@@ -75,13 +80,15 @@ docker pull usgs/nshmp-haz
### Docker Memory on Mac
-By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *nshmp-haz*, the
+By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *nshmp-haz-v2*, the
memory available to Docker must be [increased](https://docs.docker.com/docker-for-mac/#advanced)
to a minimum of 4 GB.
### Running
-The *nshmp-haz* application may be run as a Docker container which mitigates the need to install
+TODO: is there a Docker image for nshmp-haz-v2?
+
+The *nshmp-haz-v2* application may be run as a Docker container which mitigates the need to install
Git, Java, or other dependencies besides Docker. A public image is available on
Docker hub at [https://hub.docker.com/r/usgs/nshmp-haz](https://hub.docker.com/r/usgs/nshmp-haz)
which can be run with:
@@ -113,24 +120,26 @@ Where: (TODO links below need checking)
* hazard = `HazardCalc`
* rate = `RateCalc`
-* `MODEL` is the [USGS model (NSHM)](USGS-Models.md) to run:
+* `MODEL` is the [USGS model (NSHM)](./USGS-Models.md) to run:
* CONUS-2018: [Conterminous U.S. 2018](https://code.usgs.gov/ghsc/nshmp/nshm-conus)
* HAWAII-2021: [Hawaii 2021](https://code.usgs.gov/ghsc/nshmp/nshm-hawaii)
* `RETURN_PERIOD`, in years, is only required when running a disaggregation
+TODO: what should these examples point to? links to example files? or where to look for the samples?
+
* Other arguments:
- * (required) The absolute path to a GeoJSON or CSV [site(s)](Site-Specification.md) file
- * CSV example: `$(pwd)/my-csv-sites.csv:/app/sites.csv`
+ * (required) The absolute path to a GeoJSON or CSV [site(s)](./Site-Specification.md) file
+ * CSV example: `$(pwd)/my-csv-sites.csv:/app/sites.csv` [`sites.csv`](../../etc/examples/3-sites-file/sites.csv)
* GeoJSON example: `$(pwd)/my-geojson-sites.geojson:/app/sites.geojson`
- * (optional) The absolute path to a [configuration](Calculation-Configuration.md) file
+ * (optional) The absolute path to a [configuration](./Calculation-Configuration.md) file
* Example: `$(pwd)/my-custom-config.json:/app/config.json`
* (required) The absolute path to an output directory
* Example: `$(pwd)/my-hazard-output:/app/output`
### Run Customization
-When running *nshmp-haz* with Docker the initial (Xms) and maximum (Xmx) JVM memory sizes can
+When running *nshmp-haz-v2* with Docker the initial (Xms) and maximum (Xmx) JVM memory sizes can
be set with the environment flag (-e, -env):
```bash
@@ -148,8 +157,8 @@ Where:
---
-[**Documentation Index**](docs/README.md)
+* [**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index f76ae6386..78210b1dd 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -1,50 +1,55 @@
# Calculation Configuration
-A `calc-config.json` file _may_ reside at the root of every [hazard model](hazard-model). This
+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](/usgs/nshmp-haz/tree/master/etc/examples) directory, or any
-[USGS model](usgs-models), for concrete examples (TODO decide if last sentence needed and check
-links).
+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) and the
-[examples](/usgs/nshmp-haz/tree/master/etc/examples) for details.
-
-(TODO needs updated javadoc links)
+may be overridden. See [building and running](./Building-&-Running.md) and the
+[examples](../../etc/examples/README.md) for details.
Parameter | Type | Default | Notes |
--------- | ---- | ------- | ----- |
__`hazard`__
- `.exceedanceModel` |`String` | `TRUNCATION_3SIGMA_UPPER` | [`ExceedanceModel`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/ExceedanceModel.html)
- `.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`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/gmm/Imt.html)
+ `.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]
`.customImls` |`Map<String, Double[]>` | `{}` (empty object) | [2](#notes)
`.gmmUncertainty` |`Boolean` | `false` | [3](#notes)
- `.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/ValueFormat.html)
+ `.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`][url-valueformat]
__`deagg`__
`.bins` |`Object` | | [4](#notes)
`.contributorLimit` |`Double` | `0.1` | [5](#notes)
__`rate`__
`.bins` |`Object` | | [6](#notes)
`.distance` |`Double` | `20` km
- `.distributionFormat` |`String` | `INCREMENTAL` | [`DistributionFormat`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/DistributionFormat.html)
+ `.distributionFormat` |`String` | `INCREMENTAL` | [`DistributionFormat`][url-distribution]
`.timespan` |`Double` | `30` years
- `.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/ValueFormat.html)
+ `.valueFormat` |`String` | `ANNUAL_RATE` | [`ValueFormat`][url-valueformat]
__`site`__
- `.vs30` |`Double` | `760.0` | [`Site`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/Site.html)
+ `.vs30` |`Double` | `760.0` | [`Site`][url-site]
`.vsInferred` |`Boolean` | `true`
`.z1p0` |`Double` | `null` | [7](#notes)
`.z2p5` |`Double` | `null` | [7](#notes)
__`output`__ |
`.directory` |`String` | `hazout`
- `.dataTypes` |`String[]` | `[ TOTAL ]` | [`DataType`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/DataType.html)
+ `.dataTypes` |`String[]` | `[ TOTAL ]` | [`DataType`][url-datatype]
__`performance`__
`.optimizeGrids` |`Boolean` | `true` | [8](#notes)
`.smoothGrids` |`Boolean` | `true` | [9](#notes)
`.systemPartition` |`Integer` | `1000` | [10](#notes)
- `.threadCount` |`String` | `ALL` | [`ThreadCount`](http://usgs.github.io/nshmp-haz/javadoc/index.html?gov/usgs/earthquake/nshmp/calc/ThreadCount.html)
+ `.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-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-site]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/Site.html
+[url-datatype]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/DataType.html
+[url-sheets]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/ThreadCount.html
## Notes
@@ -54,7 +59,7 @@ __`performance`__
been defined, this value en/disables this feature.
3. `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
- this [example](/usgs/nshmp-haz/blob/master/etc/examples/2-custom-config/config.json) and the
+ this [example](../../etc/examples/2-custom-config/README.md) and the
table of default IMLs, below).
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":
@@ -82,22 +87,28 @@ not listed use the values of the next highest spectral period.
IMT | IMLs
-----------|-----
-PGV | 0.237, 0.355, 0.532, 0.798, 1.19, 1.80, 2.69, 4.04, 6.06, 9.09, 13.6, 20.5, 30.7, 46.0, 69.0, 103.0, 155.0, 233.0, 349.0, 525.0
-PGA | 0.00233, 0.00350, 0.00524, 0.00786, 0.0118, 0.0177, 0.0265, 0.0398, 0.0597, 0.0896, 0.134, 0.202, 0.302, 0.454, 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, 0.0265, 0.0398, 0.0597, 0.0896, 0.134, 0.202, 0.302, 0.454, 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, 0.0322, 0.0483, 0.0725, 0.109, 0.163, 0.245, 0.367, 0.551, 0.826, 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, 0.0379, 0.0569, 0.0853, 0.128, 0.192, 0.288, 0.432, 0.648, 0.972, 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, 0.0284, 0.0427, 0.0640, 0.0960, 0.144, 0.216, 0.324, 0.486, 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, 0.0228, 0.0341, 0.0512, 0.0768, 0.115, 0.173, 0.259, 0.389, 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, 0.0152, 0.0228, 0.0341, 0.0512, 0.0768, 0.115, 0.173, 0.259, 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, 0.0114, 0.0171, 0.0256, 0.0384, 0.0576, 0.0864, 0.130, 0.194, 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, 0.00569, 0.00853, 0.0128, 0.0192, 0.0288, 0.0432, 0.0648, 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, 0.00379, 0.00569, 0.00853, 0.0128, 0.0192, 0.0288, 0.0432, 0.0648, 0.0972, 0.146, 0.219, 0.328, 0.492, 0.738
+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
---
-[**Documentation Index**](docs/README.md)
+* [**Documentation Index**](../README.md)
+* [Building & Running](./Building-&-Running.md)
+ * [Developer Basics](./Developer-Basics.md)
+ * [Calculation Configuration](./Calculation-Configuration.md)
+ * [Site Specification](./Site-Specification.md)
+ * [Examples](../../etc/examples/README.md) (or
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index 791ab835b..d2e8a181b 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -53,7 +53,7 @@ git clone https://code.usgs.gov/ghsc/nshmp/nshmp-haz.git
## Eclipse Integration (Optional)
Eclipse provides automatic compilation, syntax highlighting, and integration with Git, among
-other useful features. To build or modify *nshmp-haz* using [Eclipse](http://www.eclipse.org/),
+other useful features. To build or modify *nshmp-haz-v2* using [Eclipse](http://www.eclipse.org/),
install the [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/packages/) or
[Eclipse IDE for Enterprise Java and Web Developers](https://www.eclipse.org/downloads/packages/),
if you plan on developing web services. Import the project into Eclipse: `File > Import >
@@ -61,8 +61,14 @@ Gradle > Existing Gradle Project`
---
-[**Documentation Index**](docs/README.md)
+* [**Documentation Index**](../README.md)
+* [Building & Running](./Building-&-Running.md)
+ * [Developer Basics](./Developer-Basics.md)
+ * [Calculation Configuration](./Calculation-Configuration.md)
+ * [Site Specification](./Site-Specification.md)
+ * [Examples](../../etc/examples/README.md) (or
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index 4527f365d..fc7f55a0f 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -161,8 +161,8 @@ modify model output.
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Hazard-Model.md b/docs/pages/Hazard-Model.md
index fa537064e..92171f527 100644
--- a/docs/pages/Hazard-Model.md
+++ b/docs/pages/Hazard-Model.md
@@ -34,8 +34,8 @@ support modeling of complex logic trees.
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Logic-Trees-&-Uncertainty.md b/docs/pages/Logic-Trees-&-Uncertainty.md
index b5db0a58a..57c05cda5 100644
--- a/docs/pages/Logic-Trees-&-Uncertainty.md
+++ b/docs/pages/Logic-Trees-&-Uncertainty.md
@@ -1,7 +1,7 @@
# USGS Models: Logic Trees & Uncertainty
The following page details the logic trees of epistemic uncertainty considered in NSHMs supported
-by *nshmp-haz*. Logic trees are represented in a NSHM using files ending in `-tree.json`.
+by *nshmp-haz-v2*. Logic trees are represented in a NSHM using files ending in `-tree.json`.
[[_TOC_]]
@@ -125,8 +125,8 @@ alternative models.
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Magnitude-Frequency-Distributions.md b/docs/pages/Magnitude-Frequency-Distributions.md
index 9fd7e7c06..0d041cc9c 100644
--- a/docs/pages/Magnitude-Frequency-Distributions.md
+++ b/docs/pages/Magnitude-Frequency-Distributions.md
@@ -286,8 +286,8 @@ TODO: convert example to JSON format (or see `mfd-config.json` section above)
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Editions.md b/docs/pages/Model-Editions.md
index bdecc204a..c47e2f313 100644
--- a/docs/pages/Model-Editions.md
+++ b/docs/pages/Model-Editions.md
@@ -102,8 +102,8 @@ TODO: Update model links
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Files.md b/docs/pages/Model-Files.md
index c1c485fad..ca478d5ee 100644
--- a/docs/pages/Model-Files.md
+++ b/docs/pages/Model-Files.md
@@ -186,8 +186,8 @@ is composed of an array of rupture-sets.
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Model-Structure.md b/docs/pages/Model-Structure.md
index df34c9fc4..e7230c6b1 100644
--- a/docs/pages/Model-Structure.md
+++ b/docs/pages/Model-Structure.md
@@ -196,8 +196,8 @@ See also: [Subduction Intraslab Source Type](source-types#subduction-intraslab-s
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Rupture-Scaling-Relations.md b/docs/pages/Rupture-Scaling-Relations.md
index 3e29c61b7..e78cd91a9 100644
--- a/docs/pages/Rupture-Scaling-Relations.md
+++ b/docs/pages/Rupture-Scaling-Relations.md
@@ -70,8 +70,8 @@ relationships for subduction zone earthquakes. Seismological Research Letters 68
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index 3b3dfb497..40808da9f 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -2,18 +2,22 @@
(TODO update etc and/or javadoc links)
+~~TODO: add README for `etc/nshm` directory so it can be linked here~~
+
+TODO: where is `etc/peer`? is it needed?
+
The sites at which to perform hazard and related calculations may be defined in a variety of
ways. Examples of the file formats described below are available in the resource directory:
-[`etc/nshm`](/usgs/nshmp-haz/tree/master/etc/nshm).
+[`etc/nshm`](../../etc/nshm/README.md).
-__Note on Coordinates:__ *nshmp-haz* supports longitude and latitude values in the closed
+__Note on Coordinates:__ *nshmp-haz-v2* supports longitude and latitude values in the closed
ranges `[-360° ‥ 360°]` and `[-90° ‥ 90°]`. Note, however, that mixing site and/or source
coordinates across the antimeridian (the -180° to 180° transition) will yield unexpected results.
For Pacific models and calculations, always use positive or negative longitudes exclusively.
## Site String
-For the case of running a single site of interest, most *nshmp-haz* programs accept a
+For the case of running a single site of interest, most *nshmp-haz-v2* programs accept a
comma-delimited string of the form: `name,lon,lat[,vs30,vsInf[,z1p0,z2p5]]`, where `vs30`, `vsInf`,
`z1p0`, and `z2p5` are optional. Note that if `vs30` is supplied, so too must `vsInf`. Likewise if
`z1p0` is supplied, so too must `z2p5`. If the string contains any spaces, escape them or wrap the
@@ -21,7 +25,7 @@ entire string in double quotes.
For any site parameter values that are not supplied on the command line or in the file formats
below, the following defaults are used (see the `site` member of the
-[configuration](calculation-configuration) file):
+[configuration](./Calculation-Configuration.md) file):
```text
name: Unnamed
@@ -47,7 +51,7 @@ it's 'default' basin depth scale factor.
## GeoJSON Format (\*.geojson)
Although more verbose than the comma-delimited format, [GeoJSON](http://geojson.org) is a more
-versatile format for encoding geographic data. *nshmp-haz* uses GeoJSON for both lists of sites
+versatile format for encoding geographic data. *nshmp-haz-v2* uses GeoJSON for both lists of sites
and to define map regions. If you encounter problems when formatting JSON files, use
[JSONLint](http://jsonlint.com) or [GeoJSONLint](http://geojsonlint.com) for validation.
@@ -79,19 +83,19 @@ A site list is expected as a `FeatureCollection` of `Point` features. For exampl
As with the CSV format, the minimum required data is a `geometry` `coordinates` array. All
`properties` are optional. When using GeoJSON, the `title` property maps to the name of the site.
-Additional properties, if present, are ignored by *nshmp-haz* but permitted as they may be
+Additional properties, if present, are ignored by *nshmp-haz-v2* but permitted as they may be
relevant for other applications. For example, [styling
properties](https://help.github.com/articles/mapping-geojson-files-on-github/#styling-features)
may be used to improve rendering in mapping applications. For a fully fledged example, see the
-[NSHM test sites](/usgs/nshmp-haz/blob/master/etc/nshm/sites-nshmp.geojson) file.
+[NSHM test sites](../../etc/nshm/sites-nshmp.geojson) file.
### Map Regions
-GeoJSON is also used to define *nshmp-haz* map regions. For example, see the file that defines a
+GeoJSON is also used to define *nshmp-haz-v2* map regions. For example, see the file that defines a
region commonly used when creating hazard and other maps for the
-[Los Angeles basin](/usgs/nshmp-haz/blob/master/etc/nshm/map-la-basin.geojson).
+[Los Angeles basin](../../etc/nshm/map-la-basin.geojson).
-A map region is expected as a `Polygon` `FeatureCollection`. Currently, *nshmp-haz* only supports
+A map region is expected as a `Polygon` `FeatureCollection`. Currently, *nshmp-haz-v2* only supports
a `FeatureCollection` with 1 or 2 polygons. When a single polygon is defined, it must consist of a
single, simple closed loop. Additional arrays that define holes in the polygon (per the GeoJSON
spec) are not processed and results are undefined for self-intersecting coordinate arrays. This
@@ -106,13 +110,20 @@ have a feature `id` of `Extents`, and *must* be rectangular (in a mercator proje
parallel to lines of latitude and longitude. Any points in the 'calculation' polygon outside the
'extents' polygon are ignored; hazard values at any points within the 'extents' polygon but
outside the 'calculation' polygon are set to zero. For an example, see the
-[NSHMP Western US](/usgs/nshmp-haz/blob/master/etc/nshm/map-wus.geojson) map site file.
+[NSHMP Western US](../../etc/nshm/map-wus.geojson) map site file.
+
(TODO This needs updating; link to conus-2018 active crust map-region.geojson).
---
-[**Documentation Index**](docs/README.md)
+* [**Documentation Index**](../README.md)
+* [Building & Running](./Building-&-Running.md)
+ * [Developer Basics](./Developer-Basics.md)
+ * [Calculation Configuration](./Calculation-Configuration.md)
+ * [Site Specification](./Site-Specification.md)
+ * [Examples](../../etc/examples/README.md) (or
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Source-Types.md b/docs/pages/Source-Types.md
index baaf1f4f1..b6a0382a3 100644
--- a/docs/pages/Source-Types.md
+++ b/docs/pages/Source-Types.md
@@ -12,15 +12,15 @@ geometry itself is unknown or very poorly defined.
[[_TOC_]]
-Source models for use with *nshmp-haz* are defined using [JSON](https://www.json.org) and
-[GeoJSON](https://geojson.org). *nshmp-haz* makes determinations about how to represent a source
+Source models for use with *nshmp-haz-v2* are defined using [JSON](https://www.json.org) and
+[GeoJSON](https://geojson.org). *nshmp-haz-v2* makes determinations about how to represent a source
based on a GeoJSON geometry type in conjunction with supporting JSON configuration files. Example
source configuration files, `*-config.json`, are provided with each source type description.
Configuration files must be fully specified with `null` JSON member values used to specify 'do
nothing' where appropriate. Any configuration member value in ALL_CAPS indicates the value is one
of a fixed number of options commonly referred to as an enum.
-__Note on Coordinates:__ *nshmp-haz* supports longitude and latitude values in the closed ranges
+__Note on Coordinates:__ *nshmp-haz-v2* supports longitude and latitude values in the closed ranges
`[-360°‥360°]` and `[-90°‥90°]`. Note, however, that mixing site and/or source coordinates across
the antimeridian (the -180° to 180° transition) will yield unexpected results. For Pacific models
and calculations, always use positive or negative longitudes exclusively.
@@ -347,8 +347,8 @@ using an `slab-config.json` file.
---
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md
index 7d28b81b6..6a686b063 100644
--- a/docs/pages/USGS-Models.md
+++ b/docs/pages/USGS-Models.md
@@ -6,7 +6,7 @@ years. This window is narrowing, however, and updates are also being undertaken
models for states and territories outside the conterminous U.S. These pages describe the models
that are available and some of the history and versions of each. The models are intended for use
with the USGS probabilistic earthquake hazard codebase:
-[*nshmp-haz*](https://github.com/usgs/nshmp-haz).
+[*nshmp-haz-v2*](https://github.com/usgs/nshmp-haz).
As specified in this documentation, NSHM files are organized by tectonic setting and then further
by source type. For larger models, such as that of the conterminous U.S., sources are commonly
@@ -32,8 +32,8 @@ Each model region has a dedicated repository with version tags marking different
* [Model Editions](model-editions.md)
* [Logic Trees & Uncertainty](logic-trees-&-uncertainty.md)
-[**Documentation Index**](docs/README.md)
+[**Documentation Index**](../README.md)
---
- [U.S. Geological Survey](https://www.usgs.gov)
+ [U.S. Geological Survey](https://www.usgs.gov)
National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/etc/nshm/README.md b/etc/nshm/README.md
new file mode 100644
index 000000000..96c4ee61a
--- /dev/null
+++ b/etc/nshm/README.md
@@ -0,0 +1,3 @@
+# NSHM site and map files
+
+This directory contains the sites, map, and boundary files used in NSHM calculations.
--
GitLab
From 3c9877a186ef88446dc09569190c1f42a5d14d9d Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Tue, 29 Jun 2021 18:37:36 -0600
Subject: [PATCH 12/17] updating content, fixing links
---
docs/pages/Building-&-Running.md | 21 +++++-----
docs/pages/Ground-Motion-Models.md | 67 ++++++++++++++++++------------
docs/pages/Site-Specification.md | 6 +--
3 files changed, 52 insertions(+), 42 deletions(-)
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index 3a1bd0cc0..1e09b5ac5 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -84,9 +84,12 @@ By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *ns
memory available to Docker must be [increased](https://docs.docker.com/docker-for-mac/#advanced)
to a minimum of 4 GB.
-### Running
+### Run in Docker
-TODO: is there a Docker image for nshmp-haz-v2?
+TODO: Docker scripts currently only get models from github (XML models), so nshmp-haz-v2 run fails
+to parse the models (CONUS_2018 or HAWAII_2021), need to at least update `nshmp-haz-v2/scripts/docker-functions.inc.sh`.
+
+TODO: Model identifiers need to be synced between here and the docker scripts (e.g. `HI-2020` vs `HAWAII_2021`).
The *nshmp-haz-v2* application may be run as a Docker container which mitigates the need to install
Git, Java, or other dependencies besides Docker. A public image is available on
@@ -106,14 +109,14 @@ docker run \
# Example
docker run \
-e PROGRAM=hazard \
- -e MODEL=CONUS-2018 \
+ -e MODEL=CONUS_2018 \
-v $(pwd)/sites.geojson:/app/sites.geojson \
-v $(pwd)/config.json:/app/config.json \
-v $(pwd)/hazout:/app/output \
usgs/nshmp-haz
```
-Where: (TODO links below need checking)
+Where:
* `PROGRAM` is the nshmp-haz program to run:
* disagg = `DisaggCalc`
@@ -121,16 +124,14 @@ Where: (TODO links below need checking)
* rate = `RateCalc`
* `MODEL` is the [USGS model (NSHM)](./USGS-Models.md) to run:
- * CONUS-2018: [Conterminous U.S. 2018](https://code.usgs.gov/ghsc/nshmp/nshm-conus)
- * HAWAII-2021: [Hawaii 2021](https://code.usgs.gov/ghsc/nshmp/nshm-hawaii)
+ * `CONUS_2018`: [Conterminous U.S. 2018](https://code.usgs.gov/ghsc/nshmp/nshm-conus)
+ * `HAWAII_2021`: [Hawaii 2021](https://code.usgs.gov/ghsc/nshmp/nshm-hawaii)
* `RETURN_PERIOD`, in years, is only required when running a disaggregation
-TODO: what should these examples point to? links to example files? or where to look for the samples?
-
-* Other arguments:
+* Other arguments (local files mapped to files within the Docker container with `:/app/...`):
* (required) The absolute path to a GeoJSON or CSV [site(s)](./Site-Specification.md) file
- * CSV example: `$(pwd)/my-csv-sites.csv:/app/sites.csv` [`sites.csv`](../../etc/examples/3-sites-file/sites.csv)
+ * CSV example: `$(pwd)/my-csv-sites.csv:/app/sites.csv`
* GeoJSON example: `$(pwd)/my-geojson-sites.geojson:/app/sites.geojson`
* (optional) The absolute path to a [configuration](./Calculation-Configuration.md) file
* Example: `$(pwd)/my-custom-config.json:/app/config.json`
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index fc7f55a0f..284ac2f6e 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -7,18 +7,24 @@ GMMs, as published, support both interface and intraslab events.
[[_TOC_]]
-* How to add links to javadocs? ...not possible in wiki (separate repo)? except with external
- http gitlab urls?
-* include NSHM that used each model?
-* save horizontal space in table by moving notes to table footnotes. this has to be done manually
- (see NGA-East model IDs), since markdown footnotes always appear at the bottom of the page
-
-**gmm-config.json** Required adjacent to any `gmm-tree.json`. This file specifies the applicability
-distance of the associated GMM's and any additional epistemic uncertainty model and properties to
-apply to median ground motions derived from the GMM's. This uncertainty is distinct from the
-built-in aleatory variability (standard deviation or sigma) of the GMM's themselves. Use `null`
-values to indicate that no additional uncertainty model should be applied. Supported uncertainty
-models are detailed in the [ground motion models](ground-motion-models) section. For example:
+TODO: add links to GMM javadocs?
+
+TODO: list NSHMs that used each model?
+
+TODO: save horizontal space in table by moving notes to table footnotes (must be done manually because
+markdown footnotes are always at the bottom of the page)
+
+## GMM Configuration
+
+A **gmm-config.json** file governs how GMMs are applied in a NSHM and is required adjacent to any
+`gmm-tree.json` file. It specifies a maximum distance at which associated GMMs are applicable. It
+may also specify a model of additional epistemic uncertainty and the logic tree used to apply it to
+median ground motions derived from the GMMs. If no such model is required, the `epistemic-model` and
+`epistemic-tree` members must be `null`. This uncertainty is disctinct from the built-in aleatory
+variability (standard deviation or sigma) of the GMMs themselves. See [GMM Uncertainty Models](#gmm-uncertainty-models)
+for details on additional epistemic uncertainty in GMMs.
+
+A sample `gmm-config.json` file that specifies no additional epistemic uncertainty model:
```json
{
@@ -28,13 +34,7 @@ models are detailed in the [ground motion models](ground-motion-models) section.
}
```
-## GMM Configuration
-
-A `gmm-config.json` file governs how GMMs are applied in a NSHM. It specifies a maximum distance
-at which a GMM is applicable. It may also specify a model of additional epistemic uncertainty and
-the logic tree used to apply it. If no such model is required, the `epistemic-model` and
-`epistemic-tree` members must be `null`. See [Uncertainties in NSHMs](uncertainties-in-nshms) for
-details on additional epistemic uncertainty in GMMs.
+The following sample `gmm-config.json` file applies the NGA-West 2 epistemic uncertainty model:
```json
{
@@ -50,13 +50,26 @@ details on additional epistemic uncertainty in GMMs.
## GMM Uncertainty Models
-TODO
+TODO: GMM uncertainty models (tables of values not necessary?)
+
+*nshmp-haz-v2* supports two models of additional epistemic uncertainty, derived from the PEER
+NGA-West 1 and NGA-West 2 projects.
+
+NGA-West 1 | Rrup < 10 | 10 <= Rrup < 30 | 30 <= Rrup
+:---:|:---|:---|:---
+**5 <= M < 6** | 0.375 | 0.21 | 0.245
+**6 <= M < 7** | 0.23 | 0.225 | 0.23
+**7 <= M** | 0.40 | 0.36 | 0.31
## GMM Post Processors
-TODO
+TODO: GMM post processors (currently tabulated in "Auxiliary GMMs" section below)
+
+## GMMs By Tectonic Setting
+
+GMMs available in *nshmp-haz-v2* are tabulated by tectonic setting below.
-## Active Crust GMMs
+### Active Crust GMMs
| Reference | ID | Component | Notes |
|:---------:|:--:|:---------:|:------|
@@ -79,7 +92,7 @@ TODO
| [Sadigh et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.180) | SADIGH_97 | Geometric mean of two horizontal components | Also used for interface sources in 2007 Alaska NSHM |
| [Zhao et al., 2016](http://dx.doi.org/10.1785/0120150063) | ZHAO_16_SHALLOW_CRUST<br>ZHAO_16_UPPER_MANTLE | Geometric mean of two randomly oriented horizontal components | |
-## Stable Crust GMMs
+### Stable Crust GMMs
| Reference | ID | Component | Notes |
|:---------:|:--:|:---------:|:------|
@@ -108,7 +121,7 @@ TODO
NGA_EAST_SEED_PEER_EX, NGA_EAST_SEED_PEER_GP, NGA_EAST_SEED_PZCT15_M1SS,
NGA_EAST_SEED_PZCT15_M2ES, NGA_EAST_SEED_SP15, NGA_EAST_SEED_SP16, NGA_EAST_SEED_YA15
-## Subduction GMMs
+### Subduction GMMs
| Reference | ID | Component | Notes |
|:---------:|:--:|:---------:|:------|
@@ -121,7 +134,7 @@ TODO
| [Zhao et al., 2006](http://dx.doi.org/10.1785/0120050122) | ZHAO_06_INTERFACE<br>ZHAO_06_INTERFACE_BASIN<br>ZHAO_06_SLAB<br>ZHAO_06_SLAB_BASIN | Geometric mean of two horizontal components | |
| [Zhao et al., 2016](http://dx.doi.org/10.1785/0120150034)<br>[Zhao et al., 2016](http://dx.doi.org/10.1785/0120150056) | ZHAO_16_INTERFACE<br>ZHAO_16_SLAB<br>*ZHAO_16_UPPER_MANTLE* | Geometric mean of two randomly oriented horizontal components | Subduction Slab and Interface |
-## Regional and Specialized GMMs
+### Regional and Specialized GMMs
| Reference | ID | Component | Notes |
|:---------:|:--:|:---------:|:------|
@@ -149,9 +162,9 @@ TODO
| [Atkinson, 2015](http://dx.doi.org/10.1785/0120140142) | ATKINSON_15 | orientation-independent horizontal | |
-->
-## Auxilliary Models
+### Auxiliary Models
-Auxilliary models are not used directly, they can be used by concrete implementations of GMMs to
+Auxiliary models are not used directly, they can be used by concrete implementations of GMMs to
modify model output.
| Reference | Purpose | Component | Notes |
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index 40808da9f..f7ad71b9c 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -2,10 +2,6 @@
(TODO update etc and/or javadoc links)
-~~TODO: add README for `etc/nshm` directory so it can be linked here~~
-
-TODO: where is `etc/peer`? is it needed?
-
The sites at which to perform hazard and related calculations may be defined in a variety of
ways. Examples of the file formats described below are available in the resource directory:
[`etc/nshm`](../../etc/nshm/README.md).
@@ -112,7 +108,7 @@ parallel to lines of latitude and longitude. Any points in the 'calculation' pol
outside the 'calculation' polygon are set to zero. For an example, see the
[NSHMP Western US](../../etc/nshm/map-wus.geojson) map site file.
-(TODO This needs updating; link to conus-2018 active crust map-region.geojson).
+TODO This needs updating; link to conus-2018 active crust map-region.geojson.
---
--
GitLab
From 2b7f0fab38a7860068c123dcc5754d147f597706 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Wed, 30 Jun 2021 16:08:13 -0600
Subject: [PATCH 13/17] standardize navigation links. update and clean GMM
docs, add java doc links, simplify tables
---
docs/pages/Building-&-Running.md | 8 +-
docs/pages/Calculation-Configuration.md | 12 +-
docs/pages/Developer-Basics.md | 12 +-
docs/pages/Ground-Motion-Models.md | 220 ++++++++++++------------
docs/pages/Site-Specification.md | 13 +-
5 files changed, 134 insertions(+), 131 deletions(-)
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index 1e09b5ac5..6735ae1d7 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -2,10 +2,10 @@
## Related Pages
-* Building & Running
- * [Developer Basics](./Developer-Basics.md)
- * [Calculation Configuration](./Calculation-Configuration.md)
- * [Site Specification](./Site-Specification.md)
+* [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)
* [Examples](../../etc/examples/README.md) (or
[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index 78210b1dd..3966cfa69 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -101,13 +101,15 @@ T ≤ 10 s | 0.000333, 0.000499, 0.000749, 0.00112, 0.00169, 0.00253, <br>0.00
---
-* [**Documentation Index**](../README.md)
-* [Building & Running](./Building-&-Running.md)
- * [Developer Basics](./Developer-Basics.md)
- * [Calculation Configuration](./Calculation-Configuration.md)
- * [Site Specification](./Site-Specification.md)
+## 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)
* [Examples](../../etc/examples/README.md) (or
[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index d2e8a181b..fe7229242 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -61,13 +61,15 @@ Gradle > Existing Gradle Project`
---
-* [**Documentation Index**](../README.md)
-* [Building & Running](./Building-&-Running.md)
- * [Developer Basics](./Developer-Basics.md)
- * [Calculation Configuration](./Calculation-Configuration.md)
- * [Site Specification](./Site-Specification.md)
+## 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)
* [Examples](../../etc/examples/README.md) (or
[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index 284ac2f6e..49ecc4fa9 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -7,13 +7,6 @@ GMMs, as published, support both interface and intraslab events.
[[_TOC_]]
-TODO: add links to GMM javadocs?
-
-TODO: list NSHMs that used each model?
-
-TODO: save horizontal space in table by moving notes to table footnotes (must be done manually because
-markdown footnotes are always at the bottom of the page)
-
## GMM Configuration
A **gmm-config.json** file governs how GMMs are applied in a NSHM and is required adjacent to any
@@ -50,127 +43,132 @@ The following sample `gmm-config.json` file applies the NGA-West 2 epistemic unc
## GMM Uncertainty Models
-TODO: GMM uncertainty models (tables of values not necessary?)
-
-*nshmp-haz-v2* supports two models of additional epistemic uncertainty, derived from the PEER
-NGA-West 1 and NGA-West 2 projects.
-
-NGA-West 1 | Rrup < 10 | 10 <= Rrup < 30 | 30 <= Rrup
-:---:|:---|:---|:---
-**5 <= M < 6** | 0.375 | 0.21 | 0.245
-**6 <= M < 7** | 0.23 | 0.225 | 0.23
-**7 <= M** | 0.40 | 0.36 | 0.31
+*nshmp-haz-v2* supports additional epistemic uncertainty models derived from the PEER NGA-West 1
+and PEER NGA-West 2 projects. These models both have factors for distance (`Rrup`) bins
+Rrup < 10 km, 10 km <= Rrup, < 30 km, and 30 km <= Rrup, and for magnitude bins M < 6.0, 6.0 <=
+M < 7.0, and 7.0 <= M. These models can be applied within the `gmm-config.json` file as shown in
+the [GMM Uncertainty](#gmm-uncertainty) section above.
## GMM Post Processors
-TODO: GMM post processors (currently tabulated in "Auxiliary GMMs" section below)
+GMM post processing models are not used directly, they can be used by concrete implementations of
+GMMs to modify model output.
+
+| Reference | Purpose | Component | Notes |
+|:---------:|:-------:|:---------:|:------|
+| [Rezaeian et al., 2014](http://dx.doi.org/10.1193/100512EQS298M) | Damping scaling factor | Average horizontal component | No effect if supplied damping ratio is 5% |
+| USGS PGV | Conditional PGV for crustal earthquakes | Horizontal component | Conditional model for vertical component not yet implemented |
## GMMs By Tectonic Setting
-GMMs available in *nshmp-haz-v2* are tabulated by tectonic setting below.
+GMMs available in *nshmp-haz-v2* are tabulated by tectonic setting below. See the javadocs for the
+[GMM Package](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/package-summary.html)
+for implementation details of each GMM and comprehensive lists of GMM IDs.
### Active Crust GMMs
-| Reference | ID | Component | Notes |
-|:---------:|:--:|:---------:|:------|
-| **NGA-West 2** | | |
-| [Abrahamson et al., 2014](http://dx.doi.org/10.1193/070913EQS198M) | ASK_14<br>ASK_14_BASIN | RotD50 | |
-| [Boore et al., 2014](http://dx.doi.org/10.1193/070113EQS184M) | BSSA_14<br>BSSA_14_BASIN | RotD50 | |
-| [Campbell & Bozorgnia, 2014](http://dx.doi.org/10.1193/062913EQS175M)| CB_14<br>CB_14_BASIN | RotD50 | |
-| [Chiou & Youngs, 2014](http://dx.doi.org/10.1193/072813EQS219M) | CY_14<br>CY_14_BASIN | RotD50 | |
-| [Idriss, 2014](http://dx.doi.org/10.1193/070613EQS195M) | IDRISS_14 | RotD50 | |
-| **NGA-West 1** | | | |
-| [Boore & Anderson, 2008](http://dx.doi.org/10.1193/1.2830434) | BA_08 | GMRotI50 | |
-| [Campbell & Bozorgnia, 2008](http://dx.doi.org/10.1193/1.2857546) | CB_08 | GMRotI50 | |
-| [Chiou & Youngs, 2008](http://dx.doi.org/10.1193/1.2894832) | CY_08 | GMRotI50 | |
-| **Other** | | | |
-| [Abrahamson & Silva, 1997](http://dx.doi.org/10.1785/gssrl.68.1.94) | AS_97 | Average horizontal | |
-| [Boore et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.128)<br>[Boore, 2005](http://dx.doi.org/10.1785/gssrl.76.3.368) | BJF_97 | Random horizontal | Soft rock sites only (Vs30 760 m/s) |
-| [Campbell, 1997](http://dx.doi.org/10.1785/gssrl.68.1.154)<br>[errata, 2000](http://dx.doi.org/10.1785/gssrl.71.3.352)<br>[errata, 2001](http://dx.doi.org/10.1785/gssrl.72.4.474) | CAMPBELL_97 | Geometric mean of two horizontal components | Soft rock sites only (Vs30 760 m/s) |
-| [Campbell & Bozorgnia, 2003](http://dx.doi.org/10.1785/0120020029)<br>[errata, 2003](http://dx.doi.org/10.1785/0120030099)<br>[errata, 2003](http://dx.doi.org/10.1785/0120030143) | CB_03 | Average horizontal | Soft rock sites only (Vs30 760 m/s) |
-| [McVerry et al., 2000](http://doi.org/10.5459/BNZSEE.39.1.1-58) | MCVERRY_00_CRUSTAL<br>MCVERRY_00_VOLCANIC | Max-horizontal implemented, model also supports geometric mean | New Zealand, does not correspond directly with US site class model |
-| [Sadigh et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.180) | SADIGH_97 | Geometric mean of two horizontal components | Also used for interface sources in 2007 Alaska NSHM |
-| [Zhao et al., 2016](http://dx.doi.org/10.1785/0120150063) | ZHAO_16_SHALLOW_CRUST<br>ZHAO_16_UPPER_MANTLE | Geometric mean of two randomly oriented horizontal components | |
+Reference | ID | Component | Notes
+:---------:|:--:|:---------:|:------
+**NGA-West 2**
+[Abrahamson et al., 2014](http://dx.doi.org/10.1193/070913EQS198M) | ASK_14<br>ASK_14_BASIN | RotD50 |
+[Boore et al., 2014](http://dx.doi.org/10.1193/070113EQS184M) | BSSA_14<br>BSSA_14_BASIN | RotD50 |
+[Campbell & Bozorgnia, 2014](http://dx.doi.org/10.1193/062913EQS175M)| CB_14<br>CB_14_BASIN | RotD50 |
+[Chiou & Youngs, 2014](http://dx.doi.org/10.1193/072813EQS219M) | CY_14<br>CY_14_BASIN | RotD50 |
+[Idriss, 2014](http://dx.doi.org/10.1193/070613EQS195M) | IDRISS_14 | RotD50 |
+**NGA-West 1**
+[Boore & Anderson, 2008](http://dx.doi.org/10.1193/1.2830434) | BA_08 | GMRotI50 |
+[Campbell & Bozorgnia, 2008](http://dx.doi.org/10.1193/1.2857546) | CB_08 | GMRotI50 |
+[Chiou & Youngs, 2008](http://dx.doi.org/10.1193/1.2894832) | CY_08 | GMRotI50 |
+**Other**
+[Abrahamson & Silva, 1997](http://dx.doi.org/10.1785/gssrl.68.1.94) | AS_97 | Average horizontal |
+[Boore et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.128)<br>[Boore, 2005](http://dx.doi.org/10.1785/gssrl.76.3.368) | BJF_97 | Random horizontal | [1](#active-crust-gmm-notes)
+[Campbell, 1997](http://dx.doi.org/10.1785/gssrl.68.1.154)<br>[errata, 2000](http://dx.doi.org/10.1785/gssrl.71.3.352)<br>[errata, 2001](http://dx.doi.org/10.1785/gssrl.72.4.474) | CAMPBELL_97 | Geometric mean of two horizontal components | [1](#active-crust-gmm-notes)
+[Campbell & Bozorgnia, 2003](http://dx.doi.org/10.1785/0120020029)<br>[errata, 2003a](http://dx.doi.org/10.1785/0120030099)<br>[errata, 2003b](http://dx.doi.org/10.1785/0120030143) | CB_03 | Average horizontal | [1](#active-crust-gmm-notes)
+[McVerry et al., 2000](http://doi.org/10.5459/BNZSEE.39.1.1-58) | MCVERRY_00_CRUSTAL<br>MCVERRY_00_VOLCANIC | Max-horizontal implemented, model supports geometric mean | [2](#active-crust-gmm-notes)
+[Sadigh et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.180) | SADIGH_97 | Geometric mean of two horizontal components | [3](#active-crust-gmm-notes)
+[Zhao et al., 2016](http://dx.doi.org/10.1785/0120150063) | ZHAO_16_SHALLOW_CRUST<br>ZHAO_16_UPPER_MANTLE | Geometric mean of two randomly oriented horizontal components |
+
+#### Active Crust GMM Notes
+
+1. Soft rock sites only (Vs30 760 m/s)
+2. New Zealand model, does not correspond directly with US site class model
+3. Also used for interface sources in 2007 Alaska NSHM
### Stable Crust GMMs
-| Reference | ID | Component | Notes |
-|:---------:|:--:|:---------:|:------|
-| [Atkinson, 2008](http://dx.doi.org/10.1785/0120070199)<br>[Atkinson & Boore, 2011](http://dx.doi.org/10.1785/0120100270) | ATKINSON_08_PRIME | horizontal | Mean values clamped |
-| [Atkinson & Boore, 2006](http://dx.doi.org/10.1785/0120050245) | AB_06_140BAR<br>AB_06_200BAR<br>AB_06_140BAR_AB<br>AB_06_200BAR_AB<br>AB_06_140BAR_J<br>AB_06_200BAR_J | horizontal | Mean values clamped |
-| [Atkinson & Boore, 2006](http://dx.doi.org/10.1785/0120050245)<br>[Atkinson & Boore, 2011](http://dx.doi.org/10.1785/0120100270) | AB_06_PRIME | horizontal | Mean values clamped |
-| [Campbell, 2003](http://dx.doi.org/10.1785/0120020002) | CAMPBELL_03<br>CAMPBELL_03_AB<br>CAMPBELL_03_J | Geometric mean of two horizontal components | Mean values clamped |
-| [Frankel et al., 1996](https://pubs.usgs.gov/of/1996/532/) | FRANKEL_96<br>FRANKEL_96_AB<br>FRANKEL_96_J | not specified | Mean values clamped |
-| [Graizer & Kalkan, 2015](http://dx.doi.org/10.3133/ofr20151009)<br>[Graizer & Kalkan, 2016](http://dx.doi.org/10.1785/0120150194) | GK_15 | Geometric mean of two randomly oriented horizontal components | |
-| NGA-East<br>[Goulet et al., 2017](https://peer.berkeley.edu/sites/default/files/christine-a-goulet-yousef-bozorgnia-2017_03_0.pdf) | NGA_EAST_USGS [:one:](#one-nga-east-median-model-ids)<br>NGA_EAST_USGS_SEEDS[:two:](#two-nga-east-seed-model-ids) | RotD50 (average horizontal) | Mean values are not clamped |
-| [Pezeshk et al., 2011](http://dx.doi.org/10.1785/0120100144) | PEZESHK_11 | GMRotI50 | Mean values clamped |
-| [Shahjouei and Pezeshk, 2016](http://dx.doi.org/10.1785/0120140367) | NGA_EAST_SEED_SP16 | RotD50 | NGA-East Seed |
-| [Silva et al., 2002](http://www.pacificengineering.org/CEUS/Development%20of%20Regional%20Hard_ABC.pdf) | SILVA_02<br>SILVA_02_AB<br>SILVA_02_J | average horizontal component | Mean values clamped |
-| [Somerville et al., 2001](https://earthquake.usgs.gov/static/lfs/nshm/conterminous/2008/99HQGR0098.pdf) | SOMERVILLE_01 | not specified | Mean values clamped |
-| [Tavakoli & Pezeshk, 2005](http://dx.doi.org/10.1785/0120050030) | TP_05<br>TP_05_AB<br>TP_05_J | not specified | Mean values clamped |
-| [Toro et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.41)<br>[Toro, 2002](http://www.ce.memphis.edu/7137/PDFs/attenuations/Toro_2001_(modification_1997).pdf) | TORO_97_MB<br>TORO_97_MW | not specified | Mean values clamped |
-
-1. NGA-East Median Model IDs: NGA_EAST_USGS_1, NGA_EAST_USGS_2, NGA_EAST_USGS_3, NGA_EAST_USGS_4,
- NGA_EAST_USGS_5, NGA_EAST_USGS_6, NGA_EAST_USGS_7, NGA_EAST_USGS_8, NGA_EAST_USGS_9,
- NGA_EAST_USGS_10, NGA_EAST_USGS_11, NGA_EAST_USGS_12, NGA_EAST_USGS_13, NGA_EAST_USGS_14,
- NGA_EAST_USGS_15, NGA_EAST_USGS_16, NGA_EAST_USGS_17
-2. NGA-East Seed Model IDs: NGA_EAST_SEED_1CCSP, NGA_EAST_SEED_1CVSP, NGA_EAST_SEED_2CCSP,
- NGA_EAST_SEED_2CVSP, NGA_EAST_SEED_B_A04, NGA_EAST_SEED_B_AB14, NGA_EAST_SEED_B_AB95,
- NGA_EAST_SEED_B_BCA10D, NGA_EAST_SEED_B_BS11, NGA_EAST_SEED_B_SGD02, NGA_EAST_SEED_FRANKEL,
- NGA_EAST_SEED_GRAIZER, NGA_EAST_SEED_GRAIZER16, NGA_EAST_SEED_GRAIZER17, NGA_EAST_SEED_HA15,
- NGA_EAST_SEED_PEER_EX, NGA_EAST_SEED_PEER_GP, NGA_EAST_SEED_PZCT15_M1SS,
- NGA_EAST_SEED_PZCT15_M2ES, NGA_EAST_SEED_SP15, NGA_EAST_SEED_SP16, NGA_EAST_SEED_YA15
-
-### Subduction GMMs
-
-| Reference | ID | Component | Notes |
-|:---------:|:--:|:---------:|:------|
-| [Atkinson & Boore, 2003](http://dx.doi.org/10.1785/0120020156) | AB_03_GLOBAL_INTERFACE<br>AB_03_GLOBAL_SLAB<br>AB_03_GLOBAL_SLAB_LOW_SAT<br>AB_03_CASCADIA_INTERFACE<br>AB_03_CASCADIA_SLAB<br>AB_03_CASCADIA_SLAB_LOW_SAT | horizontal | |
-| [Atkinson & Macias, 2009](http://dx.doi.org/10.1785/0120080147) | AM_09_INTERFACE<br>AM_09_INTERFACE_BASIN | Geometric mean of two horizontal components | Interface only |
-| BC Hydro<br>[Abrahamson et al., 2016](http://dx.doi.org/10.1193/051712EQS188MR) | BCHYDRO_12_INTERFACE<br>BCHYDRO_12_INTERFACE_BACKARC<br>BCHYDRO_12_INTERFACE_BASIN<br>BCHYDRO_12_INTERFACE_BASIN_BACKARC<br>BCHYDRO_12_SLAB<br>BCHYDRO_12_SLAB_BACKARC<br>BCHYDRO_12_SLAB_BASIN<br>BCHYDRO_12_SLAB_BASIN_BACKARC | Geometric mean of two horizontal components | |
-| [McVerry et al., 2000](http://doi.org/10.5459/BNZSEE.39.1.1-58) | MCVERRY_00_INTERFACE<br>MCVERRY_00_SLAB<br>MCVERRY_00_VOLCANIC | Max-horizontal implemented, model also supports geometric mean | New Zealand, does not correspond directly with US site class model |
-| NGA-Subduction<br>[Abrahamson et al., 2018](https://peer.berkeley.edu/sites/default/files/2018_02_abrahamson_9.10.18.pdf) | NGA_SUB_USGS_INTERFACE<br>NGA_SUB_USGS_INTERFACE_NO_EPI<br>NGA_SUB_USGS_SLAB<br>NGA_SUB_USGS_SLAB_NO_EPI | Geometric mean of two horizontal components | **Likely to be superseded by final EQS paper**<br>Calibrated for Cascadia use only |
-| [Youngs et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.58) | YOUNGS_97_INTERFACE<br>YOUNGS_97_SLAB | Geometric mean of two horizontal components | |
-| [Zhao et al., 2006](http://dx.doi.org/10.1785/0120050122) | ZHAO_06_INTERFACE<br>ZHAO_06_INTERFACE_BASIN<br>ZHAO_06_SLAB<br>ZHAO_06_SLAB_BASIN | Geometric mean of two horizontal components | |
-| [Zhao et al., 2016](http://dx.doi.org/10.1785/0120150034)<br>[Zhao et al., 2016](http://dx.doi.org/10.1785/0120150056) | ZHAO_16_INTERFACE<br>ZHAO_16_SLAB<br>*ZHAO_16_UPPER_MANTLE* | Geometric mean of two randomly oriented horizontal components | Subduction Slab and Interface |
+Reference | ID | Component | Notes
+:---------:|:--:|:---------:|:------
+**NGA-East**
+NGA-East<br>[Goulet et al., 2017](https://peer.berkeley.edu/sites/default/files/christine-a-goulet-yousef-bozorgnia-2017_03_0.pdf) | NGA_EAST_USGS<sup>[1](#stable-crust-gmm-notes)</sup><br>NGA_EAST_USGS_SEEDS<sup>[2](#stable-crust-gmm-notes)</sup> | RotD50 (average horizontal) | [3](#stable-crust-gmm-notes)
+[Shahjouei and Pezeshk, 2016](http://dx.doi.org/10.1785/0120140367) | NGA_EAST_SEED_SP16 | RotD50 | [4](#stable-crust-gmm-notes)
+**Other**
+[Atkinson, 2008](http://dx.doi.org/10.1785/0120070199)<br>[Atkinson & Boore, 2011](http://dx.doi.org/10.1785/0120100270) | ATKINSON_08_PRIME | horizontal | [5](#stable-crust-gmm-notes)
+[Atkinson & Boore, 2006](http://dx.doi.org/10.1785/0120050245) | *AB_06_\*<br>140BAR\|200BAR<br>none\|_AB\|_J* | horizontal | [5](#stable-crust-gmm-notes)
+[Atkinson & Boore, 2006](http://dx.doi.org/10.1785/0120050245)<br>[Atkinson & Boore, 2011](http://dx.doi.org/10.1785/0120100270) | AB_06_PRIME | horizontal | [5](#stable-crust-gmm-notes)
+[Campbell, 2003](http://dx.doi.org/10.1785/0120020002) | CAMPBELL_03<br>CAMPBELL_03_AB<br>CAMPBELL_03_J | Geometric mean of two horizontal components | [5](#stable-crust-gmm-notes)
+[Frankel et al., 1996](https://pubs.usgs.gov/of/1996/532/) | FRANKEL_96<br>FRANKEL_96_AB<br>FRANKEL_96_J | not specified | [5](#stable-crust-gmm-notes)
+[Graizer & Kalkan, 2015](http://dx.doi.org/10.3133/ofr20151009)<br>[Graizer & Kalkan, 2016](http://dx.doi.org/10.1785/0120150194) | GK_15 | Geometric mean of two randomly oriented horizontal components |
+[Pezeshk et al., 2011](http://dx.doi.org/10.1785/0120100144) | PEZESHK_11 | GMRotI50 | [5](#stable-crust-gmm-notes)
+[Silva et al., 2002](http://www.pacificengineering.org/CEUS/Development%20of%20Regional%20Hard_ABC.pdf) | SILVA_02<br>SILVA_02_AB<br>SILVA_02_J | average horizontal component | [5](#stable-crust-gmm-notes)
+[Somerville et al., 2001](https://earthquake.usgs.gov/static/lfs/nshm/conterminous/2008/99HQGR0098.pdf) | SOMERVILLE_01 | not specified | [5](#stable-crust-gmm-notes)
+[Tavakoli & Pezeshk, 2005](http://dx.doi.org/10.1785/0120050030) | TP_05<br>TP_05_AB<br>TP_05_J | not specified | [5](#stable-crust-gmm-notes)
+[Toro et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.41)<br>[Toro, 2002](http://www.ce.memphis.edu/7137/PDFs/attenuations/Toro_2001_(modification_1997).pdf) | TORO_97_MB<br>TORO_97_MW | not specified | [5](#stable-crust-gmm-notes)
+
+#### Stable Crust GMM Notes
+
+1. Individual NGA-East Median Model IDs are listed in the [Gmm javadocs](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/Gmm.html)
+2. Individual NGA-East Seed Model IDs are listed in the [Gmm javadocs](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/Gmm.html)
+3. Mean values are not clamped
+4. Shahjouei and Pezeshk (2016) is a NGA-East seed model
+5. Mean values clamped
+
+### Subduction GMMs
+
+*Note: See the [GMM javadocs](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/Gmm.html)
+for a comprehensive list of GMM IDs.*
+
+Reference | ID | Component | Notes
+:---------:|:--:|:---------:|:------
+**NGA-Subduction**
+[Abrahamson & Gülerce, 2020](https://peer.berkeley.edu/sites/default/files/2020_25.pdf) | *AG_20_\*<br>GLOBAL\|CASCADIA\|ALASKA<br>INTERFACE\|SLAB<br>no basin\|_BASIN* | Geometric mean of two horizontal components
+[Kuehn et al., 2020](https://peer.berkeley.edu/sites/default/files/2020_04_kuehn_final.pdf) | *KBCG_20_\*<br>GLOBAL\|CASCADIA\|ALASKA<br>INTERFACE\|SLAB<br>no basin\|_BASIN* |
+[Parker et al., 2020](https://peer.berkeley.edu/sites/default/files/2020_03_parker_final.pdf) | *PSHAB_20_\*<br>GLOBAL\|CASCADIA\|ALASKA<br>INTERFACE\|SLAB<br>no basin\|_BASIN* |
+**Other**
+[Atkinson & Boore, 2003](http://dx.doi.org/10.1785/0120020156) | *AB_03\*<br>GLOBAL\|CASCADIA<br>INTERFACE\|SLAB<br>none\|_LOW_SAT*| horizontal |
+[Atkinson & Macias, 2009](http://dx.doi.org/10.1785/0120080147) | AM_09_INTERFACE<br>AM_09_INTERFACE_BASIN | Geometric mean of two horizontal components | [1](#subduction-gmm-notes)
+BC Hydro<br>[Abrahamson et al., 2016](http://dx.doi.org/10.1193/051712EQS188MR) | *BCHYDRO_12_\*<br>INTERFACE\|SLAB<br>none\|_BASIN<br>none\|_BACKARC* | Geometric mean of two horizontal components |
+BC Hydro NGA<br>[Abrahamson et al., 2018](https://peer.berkeley.edu/sites/default/files/2018_02_abrahamson_9.10.18.pdf)<sup>[2](#subduction-gmm-notes)</sup> | *BCHYDRO_18_NGA_\*<br>INTERFACE\|SLAB<br>none\|_NO_EPI* | Geometric mean of two horizontal components | [3](#subduction-gmm-notes)
+[McVerry et al., 2000](http://doi.org/10.5459/BNZSEE.39.1.1-58) | MCVERRY_00_INTERFACE<br>MCVERRY_00_SLAB<br>MCVERRY_00_VOLCANIC | Max-horizontal implemented, model also supports geometric mean | [4](#subduction-gmm-notes)
+[Youngs et al., 1997](http://dx.doi.org/10.1785/gssrl.68.1.58) | YOUNGS_97_INTERFACE<br>YOUNGS_97_SLAB | Geometric mean of two horizontal components |
+[Zhao et al., 2006](http://dx.doi.org/10.1785/0120050122) | *ZHAO_06_\*<br>INTERFACE\|SLAB<br>none\|_BASIN* | Geometric mean of two horizontal components |
+[Zhao et al., 2016](http://dx.doi.org/10.1785/0120150034)<br>[Zhao et al., 2016](http://dx.doi.org/10.1785/0120150056) | ZHAO_16_INTERFACE<br>ZHAO_16_SLAB<br>*ZHAO_16_UPPER_MANTLE* | Geometric mean of two randomly oriented horizontal components | [5](#subduction-gmm-notes)
+
+#### Subduction GMM Notes
+
+1. Interface only
+2. Likely to be superseded by the final EQ Spectra paper
+3. Calibrated for Cascadia use only
+4. New Zealand model, does not correspond directly with US site class model
+5. Subduction Slab and Interface
### Regional and Specialized GMMs
| Reference | ID | Component | Notes |
|:---------:|:--:|:---------:|:------|
-| **Hawaii** | | | |
-| [Atkinson, 2010](http://dx.doi.org/10.1785/0120090098) | ATKINSON_10 | geometric mean of two horizontal components | |
-| [Munson & Thurber, 1997](https://pubs.geoscienceworld.org/ssa/srl/article-abstract/68/1/41/142160/Model-of-Strong-Ground-Motions-from-Earthquakes-in) | MT_97 | Larger of two horizontal | PGA and 0.2 seconds, additional term applied for M > 7 |
-| [Wong et al., 2015](http://doi.org/10.1193/012012EQS015M) | WONG_15 | average horizontal | |
-| **New Zealand** | | | |
-| [McVerry et al., 2000](http://doi.org/10.5459/BNZSEE.39.1.1-58) | MCVERRY_00_CRUSTAL<br>MCVERRY_00_VOLCANIC<br>MCVERRY_00_INTERFACE<br>MCVERRY_00_SLAB | Max-horizontal implemented, model also supports geometric mean | New Zealand, does not correspond directly with US site class model. |
-| **Induced Seismicity** | | | |
-| [Atkinson, 2015](http://dx.doi.org/10.1785/0120140142) | ATKINSON_15 | orientation-independent horizontal | |
-<!--
-## Hawaii GMMs
-
-| Reference | ID | Component | Notes |
-|:---------:|:--:|:---------:|:------|
-| [Atkinson, 2010](http://dx.doi.org/10.1785/0120090098) | ATKINSON_10 | geometric mean of two horizontal components | Hawaii |
-| [Munson & Thurber, 1997](https://pubs.geoscienceworld.org/ssa/srl/article-abstract/68/1/41/142160/Model-of-Strong-Ground-Motions-from-Earthquakes-in) | MT_97 | Larger of two horizontal | PGA and 0.2 seconds, additional term applied for M > 7 |
-| [Wong et al., 2015](http://doi.org/10.1193/012012EQS015M) | WONG_15 | average horizontal | |
-
-## Induced Seismicity GMMs
-
-| Reference | ID | Component | Notes |
-|:---------:|:--:|:---------:|:------|
-| [Atkinson, 2015](http://dx.doi.org/10.1785/0120140142) | ATKINSON_15 | orientation-independent horizontal | |
--->
-
-### Auxiliary Models
-
-Auxiliary models are not used directly, they can be used by concrete implementations of GMMs to
-modify model output.
-
-| Reference | Purpose | Component | Notes |
-|:---------:|:-------:|:---------:|:------|
-| [Rezaeian et al., 2014](http://dx.doi.org/10.1193/100512EQS298M) | Damping scaling factor | Average horizontal component | No effect if supplied damping ratio is 5% |
-| USGS PGV | Conditional PGV for crustal earthquakes | Horizontal component | Conditional model for vertical component not yet implemented |
+| **Hawaii**
+| [Atkinson, 2010](http://dx.doi.org/10.1785/0120090098) | ATKINSON_10 | geometric mean of two horizontal components |
+| [Munson & Thurber, 1997](https://pubs.geoscienceworld.org/ssa/srl/article-abstract/68/1/41/142160/Model-of-Strong-Ground-Motions-from-Earthquakes-in) | MT_97 | Larger of two horizontal | [1](#regional-and-specialized-gmm-notes)
+| [Wong et al., 2015](http://doi.org/10.1193/012012EQS015M) | WONG_15 | average horizontal |
+| **New Zealand**
+| [McVerry et al., 2000](http://doi.org/10.5459/BNZSEE.39.1.1-58) | MCVERRY_00_CRUSTAL<br>MCVERRY_00_VOLCANIC<br>MCVERRY_00_INTERFACE<br>MCVERRY_00_SLAB | Max-horizontal implemented, model also supports geometric mean | [1](#regional-and-specialized-gmm-notes)
+| **Induced Seismicity**
+| [Atkinson, 2015](http://dx.doi.org/10.1785/0120140142) | ATKINSON_15 | orientation-independent horizontal |
+
+#### Regional and Specialized GMM Notes
+
+1. Munson & Thurber (1997) supports PGA and 0.2 seconds, with an additional term applied for M > 7.
+2. McVerry et al. (2000) is a New Zealand model and does not correspond directly with the U.S. site
+ class model.
---
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index f7ad71b9c..b6699d151 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -1,6 +1,5 @@
# Site Specification
-(TODO update etc and/or javadoc links)
The sites at which to perform hazard and related calculations may be defined in a variety of
ways. Examples of the file formats described below are available in the resource directory:
@@ -112,13 +111,15 @@ TODO This needs updating; link to conus-2018 active crust map-region.geojson.
---
-* [**Documentation Index**](../README.md)
-* [Building & Running](./Building-&-Running.md)
- * [Developer Basics](./Developer-Basics.md)
- * [Calculation Configuration](./Calculation-Configuration.md)
- * [Site Specification](./Site-Specification.md)
+## 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)
* [Examples](../../etc/examples/README.md) (or
[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
--
GitLab
From c87063e484324ccfa930f9917386b1e9b71c352e Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Wed, 30 Jun 2021 16:52:42 -0600
Subject: [PATCH 14/17] add navigation, fix links, add web services pages
(referenced in Model-Editions.md)
---
docs/README.md | 1 +
docs/pages/Calculation-Configuration.md | 4 +-
docs/pages/Logic-Trees-&-Uncertainty.md | 53 ++++++++--------
docs/pages/Model-Editions.md | 80 ++++++++++++++-----------
docs/pages/NSHMP-Web-Services.md | 12 ++++
docs/pages/Site-Specification.md | 3 +-
docs/pages/USGS-Models.md | 14 ++---
7 files changed, 98 insertions(+), 69 deletions(-)
create mode 100644 docs/pages/NSHMP-Web-Services.md
diff --git a/docs/README.md b/docs/README.md
index 3eba4574a..95e2a6cfb 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -29,6 +29,7 @@ to use *nshmp-haz-v2* as well as underlying model implementation details.
* [USGS Models](./pages/USGS-Models.md)
* [Model Editions](./pages/Model-Editions.md)
* [Logic Trees & Uncertainty](./pages/Logic-Trees-&-Uncertainty.md)
+* [NSHMP Web Services](./pages/NSHMP-Web-Services.md#nshmp-web-services)
## Other Pages & References
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index 3966cfa69..c3d9150dc 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -51,7 +51,7 @@ __`performance`__
[url-datatype]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/DataType.html
[url-sheets]: https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/calc/ThreadCount.html
-## Notes
+### Notes
1. `hazard.truncationLevel`: This value is only used if the `hazard.exceedanceModel` requires a
limit (e.g. `TRUNCATION_UPPER_ONLY`)
@@ -59,7 +59,7 @@ __`performance`__
been defined, this value en/disables this feature.
3. `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
- this [example](../../etc/examples/2-custom-config/README.md) and the
+ [example 2](../../etc/examples/2-custom-config/README.md) and the
table of default IMLs, below).
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":
diff --git a/docs/pages/Logic-Trees-&-Uncertainty.md b/docs/pages/Logic-Trees-&-Uncertainty.md
index 57c05cda5..093ac1981 100644
--- a/docs/pages/Logic-Trees-&-Uncertainty.md
+++ b/docs/pages/Logic-Trees-&-Uncertainty.md
@@ -15,8 +15,8 @@ alternative models.
| Description | 2008 | 2014 | 2018 |
|:----------- |:----- |:---- |:---- |
-| CEUS | __0.1__ : AB_06 (140 bar)<br />__0.1__ : AB_06 (200 bar)<br />__0.1__ : CAMPBELL_03<br />__0.1__ : FRANKEL_96<br />__0.1__ : SILVA_02<br />__0.2__ : SOMERVILLE_01<br />__0.2__ : TORO_97<br />__0.1__ : TP_05 | __0.22__ : AB_06'<br />__0.08__ : ATKINSON_08'<br />__0.11__ : CAMPBELL_03<br />__0.06__ : FRANKEL_96<br />__0.15__ : PEZESHK_11<br />__0.06__ : SILVA_02<br />__0.10__ : SOMERVILLE_01<br />__0.11__ : TORO_97<br />__0.11__ : TP_05 | __0.667__ : NGA_EAST_USGS (17)<br />__0.333__ : NGA_EAST_SEEDS (14)<br />(common aleatory variability) |
-| Sigma Epistemic | _(none)_ | _(no change)_ | __0.2__ : USGS Panel<br />__0.8__ : EPRI |
+| CEUS | __0.1__ : AB_06 (140 bar)<br>__0.1__ : AB_06 (200 bar)<br>__0.1__ : CAMPBELL_03<br>__0.1__ : FRANKEL_96<br>__0.1__ : SILVA_02<br>__0.2__ : SOMERVILLE_01<br>__0.2__ : TORO_97<br>__0.1__ : TP_05 | __0.22__ : AB_06'<br>__0.08__ : ATKINSON_08'<br>__0.11__ : CAMPBELL_03<br>__0.06__ : FRANKEL_96<br>__0.15__ : PEZESHK_11<br>__0.06__ : SILVA_02<br>__0.10__ : SOMERVILLE_01<br>__0.11__ : TORO_97<br>__0.11__ : TP_05 | __0.667__ : NGA_EAST_USGS (17)<br>__0.333__ : NGA_EAST_SEEDS (14)<br>(common aleatory variability) |
+| Sigma Epistemic | _(none)_ | _(no change)_ | __0.2__ : USGS Panel<br>__0.8__ : EPRI |
| Site Aleatory | _(none)_ | _(no change)_ | __0.185, 0.63, 0.185__ : Site ± σ |
---
@@ -25,8 +25,8 @@ alternative models.
| Description | 2008 | 2014 | 2018 |
|:----------- |:----- |:---- |:---- |
-| WUS | __0.3333__ : BA_08<br />__0.3333__ : CB_08<br />__0.3334__ : CY_08 | __0.22__ : ASK_14<br />__0.22__ : BSSA_14<br />__0.22__ : CB_14<br />__0.22__ : CY_14<br />__0.22__ : IDRISS_14 | __0.25__ : ASK_14<br />__0.25__ : BSSA_14<br />__0.25__ : CB_14<br />__0.25__ : CY_14 |
-| Mean Epistemic | NGA-West1 (M,R)<br />__0.185__ : epi+<br />__0.630__ : off<br />__0.185__ : epi- | NGA-West2 (M,R)<br />__0.185__ : epi+<br />__0.630__ : off<br />__0.185__ : epi- | _(no change)_ |
+| WUS | __0.3333__ : BA_08<br>__0.3333__ : CB_08<br>__0.3334__ : CY_08 | __0.22__ : ASK_14<br>__0.22__ : BSSA_14<br>__0.22__ : CB_14<br>__0.22__ : CY_14<br>__0.22__ : IDRISS_14 | __0.25__ : ASK_14<br>__0.25__ : BSSA_14<br>__0.25__ : CB_14<br>__0.25__ : CY_14 |
+| Mean Epistemic | NGA-West1 (M,R)<br>__0.185__ : epi+<br>__0.630__ : off<br>__0.185__ : epi- | NGA-West2 (M,R)<br>__0.185__ : epi+<br>__0.630__ : off<br>__0.185__ : epi- | _(no change)_ |
---
@@ -34,8 +34,8 @@ alternative models.
| Description | 2008 | 2014 | 2018 |
|:----------- |:----- |:---- |:---- |
-| Cascadia<br />(interface) | __0.25__ : AB_03 (global)<br />__0.25__ : YOUNGS_97<br />__0.50__ : ZHAO_06 | __0.1__ : AB_03 (global)<br />__0.3__ : AM_09<br />__0.3__ : BCHYDRO_12<br />__0.3__ : ZHAO_06 | __0.3333__ : AM_09<br />__0.3334__ : BCHYDRO_12<br />__0.3333__ : ZHAO_06 |
-| Cascadia<br />(slab) | __0.25__ : AB_03 (global)<br />__0.25__ : AB_03 (cascadia)<br />__0.50__ : YOUNGS_97 | __0.1665__ : AB_03 (global, mod)<br />__0.1665__ : AB_03 (cascadia, mod)<br />__0.3330__ : BCHYDRO_12<br />__0.3340__ : ZHAO_06 | __0.5__ : BCHYDRO_12<br />__0.5__ : ZHAO_06 |
+| Cascadia<br>(interface) | __0.25__ : AB_03 (global)<br>__0.25__ : YOUNGS_97<br>__0.50__ : ZHAO_06 | __0.1__ : AB_03 (global)<br>__0.3__ : AM_09<br>__0.3__ : BCHYDRO_12<br>__0.3__ : ZHAO_06 | __0.3333__ : AM_09<br>__0.3334__ : BCHYDRO_12<br>__0.3333__ : ZHAO_06 |
+| Cascadia<br>(slab) | __0.25__ : AB_03 (global)<br>__0.25__ : AB_03 (cascadia)<br>__0.50__ : YOUNGS_97 | __0.1665__ : AB_03 (global, mod)<br>__0.1665__ : AB_03 (cascadia, mod)<br>__0.3330__ : BCHYDRO_12<br>__0.3340__ : ZHAO_06 | __0.5__ : BCHYDRO_12<br>__0.5__ : ZHAO_06 |
---
@@ -43,8 +43,8 @@ alternative models.
| Model | Description | 2008 | 2014 | 2018 |
|:----- |:----------- |:---- |:---- |:---- |
-| Deformation | | __1.0__ : GEO | __0.1__ : BIRD<br />__0.8__ : GEO<br />__0.1__ : ZENG | _(no change)_ |
-| Rupture | | __0.5__ : Full<br /> __0.5__ : Partial | _(no change)_ | _(no change)_ |
+| Deformation | | __1.0__ : GEO | __0.1__ : BIRD<br>__0.8__ : GEO<br>__0.1__ : ZENG | _(no change)_ |
+| Rupture | | __0.5__ : Full<br> __0.5__ : Partial | _(no change)_ | _(no change)_ |
| Magnitude Scaling | | __1.0__ : Somerville-01 (area) | _(no change)_ | _(no change)_ |
| Maximum M¹ | Partial: epistemic | __0.2, 0.6, 0.2__ : M ± 0.2 | _(no change)_ | _(no change)_ |
| | Full : epistemic | __0.2, 0.6, 0.2__ : M ± 0.2 | _(no change)_ | _(no change)_ |
@@ -58,7 +58,7 @@ alternative models.
| Model | Description | 2008 | 2014 | 2018 |
|:----- |:----------- |:---- |:---- |:---- |
-| Deformation | | __1.0__ : GEO | __0.1__ : BIRD<br />__0.8__ : GEO<br />__0.1__ : ZENG | _(no change)_ |
+| Deformation | | __1.0__ : GEO | __0.1__ : BIRD<br>__0.8__ : GEO<br>__0.1__ : ZENG | _(no change)_ |
| Rupture | Partial | __0.333__ : IMW, __0.5__ : PNW | _(no change)_ | _(no change)_ |
| | Full | __0.667__ : IMW, __0.5__ : PNW | _(no change)_ | _(no change)_ |
| Magnitude Scaling | | __1.0__ : WC_94 (length) | _(no change)_ | _(no change)_ |
@@ -74,9 +74,9 @@ alternative models.
| Model | Description | 2008 | 2014 | 2018 |
|:----- |:----------- |:---- |:---- |:---- |
-| Maximum M | WUS (exceptions) | __1.0__ : 7.0 | __0.9__ : 7.5 (truncated)<br />__0.1__ : 8.0 (tapered) | _(no change)_ |
-| | CEUS (craton) | __0.1__ : 6.6<br />__0.2__ : 6.8<br />__0.5__ : 7.0<br />__0.2__ : 7.2 | __0.2__ : 6.5<br />__0.5__ : 7.0<br />__0.2__ : 7.5<br />__0.1__ : 8.0 | _(no change)_ |
-| Smoothing | | __1.0__ : Fixed |__0.4__ : Adaptive<br />__0.6__ : Fixed | _(no change)_ |
+| Maximum M | WUS (exceptions) | __1.0__ : 7.0 | __0.9__ : 7.5 (truncated)<br>__0.1__ : 8.0 (tapered) | _(no change)_ |
+| | CEUS (craton) | __0.1__ : 6.6<br>__0.2__ : 6.8<br>__0.5__ : 7.0<br>__0.2__ : 7.2 | __0.2__ : 6.5<br>__0.5__ : 7.0<br>__0.2__ : 7.5<br>__0.1__ : 8.0 | _(no change)_ |
+| Smoothing | | __1.0__ : Fixed |__0.4__ : Adaptive<br>__0.6__ : Fixed | _(no change)_ |
| Magnitude Scaling | CEUS & WUS | __1.0__ : WC_94 (length) | _(no change)_ | _(no change)_ |
| Focal Mechanisms | Spatially Varying | __1.0__ : assigned | _(no change)_ | _(no change)_ |
| Depth (zTor) | WUS, M < 6.5 | __1.0__ : 5.0 km | _(no change)_ | _(no change)_ |
@@ -89,11 +89,11 @@ alternative models.
| Model | 2014 | 2018 |
|:----- |:---- |:---- |
-| Fault | __0.5__ : FM3.1<br /> __0.5__ : FM3.2 | _(no change)_ |
-| Deformation | __0.1__ : ABM<br />__0.3__ : BIRD<br />__0.3__ : GEO<br />__0.3__ : ZENG | _(no change)_ |
-| Scaling Relationship<br />(mag-area & slip-length)| __0.2__ : ELLS_B<br />__0.2__ : ELLS_B (sqrt-L)<br />__0.2__ : HB_08<br />__0.2__ : SHAW_09<br />__0.2__ : SHAW_09 (csd) | _(no change)_ |
-| Slip Distribution | __0.5__ : Tapered<br />__0.5__ : Boxcar | _(no change)_ |
-| M ≥ 5 rate (yrâ»Â¹) | __0.1__ : 6.5<br />__0.6__ : 7.9<br />__0.3__ : 9.6 | _(no change)_ |
+| Fault | __0.5__ : FM3.1<br> __0.5__ : FM3.2 | _(no change)_ |
+| Deformation | __0.1__ : ABM<br>__0.3__ : BIRD<br>__0.3__ : GEO<br>__0.3__ : ZENG | _(no change)_ |
+| Scaling Relationship<br>(mag-area & slip-length)| __0.2__ : ELLS_B<br>__0.2__ : ELLS_B (sqrt-L)<br>__0.2__ : HB_08<br>__0.2__ : SHAW_09<br>__0.2__ : SHAW_09 (csd) | _(no change)_ |
+| Slip Distribution | __0.5__ : Tapered<br>__0.5__ : Boxcar | _(no change)_ |
+| M ≥ 5 rate (yrâ»Â¹) | __0.1__ : 6.5<br>__0.6__ : 7.9<br>__0.3__ : 9.6 | _(no change)_ |
| Inversion Constraint | __1.0__ : UCERF2 (CH) | _(no change)_ |
| Fault Mo Rate | __1.0__ : off | _(no change)_ |
@@ -103,8 +103,8 @@ alternative models.
| Model | 2014 | 2018 |
|:----- |:---- |:---- |
-| Grid: Maximum M | __0.1__ : 7.3<br />__0.8__ : 7.6<br />__0.1__ : 7.9 | _(no change)_ |
-| Grid: Smoothing | __0.5__ : Adaptive<br />__0.5__ : Fixed | _(no change)_ |
+| Grid: Maximum M | __0.1__ : 7.3<br>__0.8__ : 7.6<br>__0.1__ : 7.9 | _(no change)_ |
+| Grid: Smoothing | __0.5__ : Adaptive<br>__0.5__ : Fixed | _(no change)_ |
| Grid: Focal Mechanisms | __1.0__ : assigned | _(no change)_ |
| Magnitude Scaling | __1.0__ : WC_94 (length) | _(no change)_ |
@@ -114,18 +114,23 @@ alternative models.
| Model | 2008 | 2014 | 2018 |
|:----- |:---- |:---- |:---- |
-| Rupture | __0.67__ : Full<br />__0.33__ : Partial | __1.0__ : Full<br />__0.5__ : Partial (segmented)<br />__0.5__ : Partial (unsegmented) | _(no change)_ |
-| Magnitude Scaling | __1.0__ : Youngs et al. (length) | __0.334__ : Strasser et al. (2010)<br />__0.333__ : Murotani et al. (2008)<br />__0.333__ : Papazachos et al. (2004) | _(no change)_ |
+| Rupture | __0.67__ : Full<br>__0.33__ : Partial | __1.0__ : Full<br>__0.5__ : Partial (segmented)<br>__0.5__ : Partial (unsegmented) | _(no change)_ |
+| Magnitude Scaling | __1.0__ : Youngs et al. (length) | __0.334__ : Strasser et al. (2010)<br>__0.333__ : Murotani et al. (2008)<br>__0.333__ : Papazachos et al. (2004) | _(no change)_ |
| Magnitude Uncertainty | __0.2, 0.6, 0.2__ : M±0.2 | _(none)_ | _(no change)_ |
-| Depth | __0.5__ : Base<br />__0.2__ : Bottom<br />__0.2__ : Middle<br />__0.1__ : Top | __0.3__ : Bottom<br />__0.5__ : Middle<br />__0.2__ : Top | _(no change)_ |
-| Slab: Maximum M | __1.0__ : 7.2 | __0.9__ : 7.5<br />__0.1__ : 8.0 | _(no change)_ |
+| Depth | __0.5__ : Base<br>__0.2__ : Bottom<br>__0.2__ : Middle<br>__0.1__ : Top | __0.3__ : Bottom<br>__0.5__ : Middle<br>__0.2__ : Top | _(no change)_ |
+| Slab: Maximum M | __1.0__ : 7.2 | __0.9__ : 7.5<br>__0.1__ : 8.0 | _(no change)_ |
* Full: a.k.a. 'characteristic'
* Partial: a.k.a. 'Gutenberg-Richter' or 'floating'
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [USGS Models](./USGS-Models.md#usgs-models)
+ * [Model Editions](./Model-Editions.md#model-editions)
+ * [Logic Trees & Uncertainty](./Logic-Trees-&-Uncertainty.md#logic-trees-&-uncertainty)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Model-Editions.md b/docs/pages/Model-Editions.md
index c47e2f313..44dba3c5b 100644
--- a/docs/pages/Model-Editions.md
+++ b/docs/pages/Model-Editions.md
@@ -7,10 +7,10 @@ data, or modeling procedures that warrant a model update. Every model the USGS p
associated with a USGS Open-File report or refereed journal article and supporting datasets.
However, layered on top of any given model release are bug-fixes and model improvements.
-With the update to a new codebase, [nshmp-haz](https://github.com/usgs/nshmp-haz), the NSHMP has
-adopted [semantic versioning](http://semver.org) to keep track of different hazard models. For
-any given model region, the first number (or major version) corresponds to a particular release
-or update year. For example, we consider the initial
+With the update to a new codebase, [nshmp-haz-v2](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2),
+the NSHMP has adopted [semantic versioning](http://semver.org) to keep track of different hazard
+models. For any given model region, the first number (or major version) corresponds to a particular
+release or update year. For example, we consider the initial
[1996 conterminous U.S. NSHM](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#1996)
to be v1.0.0. The second number (or minor version) reflects updates to a particular release that
likely causes small changes to hazard values. The third number reflects non-hazard altering
@@ -19,33 +19,38 @@ hazard.
The USGS NSHMP is committed to supporting current and prior model releases in any given region
via web services. The table below provides a summary of all NSHM releases and their corresponding
-version numbers.
+version numbers. Links to documentation and data for each of the models below are listed on the USGS
+[Seismic Hazard Maps and Site-Specific Data](https://www.usgs.gov/natural-hazards/earthquake-hazards/seismic-hazard-maps-and-site-specific-data)
+page.
+
+TODO: confirm model versions, tags, links (github vs gitlab...), and availability
Region | Year | Version | Static | Dynamic | Notes |
-------|:----:|:-------:|:------:|:-------:|-------|
-Conterminous U.S. | [2014](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2014) | [v4.2.0](https://github.com/usgs/nshmp-model-cous-2014/releases/tag/v4.2.0)<sup>†</sup> | |:small_blue_diamond:| |
-Conterminous U.S. | [2014](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2014) | [v4.1.4](https://github.com/usgs/nshmp-model-cous-2014/releases/tag/v4.1.4)<sup>†</sup> | |:small_blue_diamond:| |
-Conterminous U.S. | [2014](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2014) | [v4.0.0](https://github.com/usgs/nshmp-haz-fortran/releases/tag/nshm2014r1) |:small_blue_diamond:| | ASCE7-16 |
-Conterminous U.S. | [2008](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2008) | v3.3.3 | |:small_blue_diamond:| |
-Conterminous U.S. | [2008](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2008) | [v3.2.0](https://github.com/usgs/nshmp-haz-fortran/releases/tag/nshm2008r3) |:small_blue_diamond:| | |
-Conterminous U.S. | [2008](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2008) | v3.1.0 |:small_blue_diamond:| | ASCE7-10 |
-Conterminous U.S. | [2008](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2008) | v3.0.0 | | | |
-Conterminous U.S. | [2002](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2002) | v2.0.0 | | | |
-Conterminous U.S. | [1996](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#1996) | v1.0.0 | | | |
-Alaska | [2007](https://earthquake.usgs.gov/hazards/hazmaps/ak/index.php#2007) | v2.1.0 | |:small_blue_diamond:| |
-Alaska | [2007](https://earthquake.usgs.gov/hazards/hazmaps/ak/index.php#2007) | v2.0.0 |:small_blue_diamond:| | ASCE7-10 |
-Alaska | [1999](https://earthquake.usgs.gov/hazards/hazmaps/ak/index.php#1999) | v1.0.0 | | | |
-American Samoa | [2012](https://earthquake.usgs.gov/hazards/hazmaps/islands.php#samoapacific) | v1.0.0 | | | |
-Guam | [2012](https://pubs.usgs.gov/of/2012/1015/) | v1.0.0 | | | |
-Hawaii | [2018](https://earthquake.usgs.gov/hazards/hazmaps/islands.php#hi) | v2.0.0 | | TBD | |
-Hawaii | [1998](https://earthquake.usgs.gov/hazards/hazmaps/islands.php#hi) | v1.1.0 | | TBD | |
-Hawaii | [1998](https://earthquake.usgs.gov/hazards/hazmaps/islands.php#hi) | v1.0.0 |:small_blue_diamond:| | ASCE7-10 |
-Puerto Rico & <br/> U.S. Virgin Islands | [2003](https://earthquake.usgs.gov/hazards/hazmaps/islands.php#prvi) | v1.0.0 | | | |
+Conterminous U.S. | 2018 | [v5.0.0](https://code.usgs.gov/ghsc/nshmp/nshm-conus-2018)<sup>†</sup> | |:small_blue_diamond:| |
+Conterminous U.S. | 2014 | [v4.2.0](https://github.com/usgs/nshmp-model-cous-2014/releases/tag/v4.2.0)<sup>†</sup> | |:small_blue_diamond:| |
+Conterminous U.S. | 2014 | [v4.1.4](https://github.com/usgs/nshmp-model-cous-2014/releases/tag/v4.1.4)<sup>†</sup> | |:small_blue_diamond:| |
+Conterminous U.S. | 2014 | [v4.0.0](https://github.com/usgs/nshmp-haz-fortran/releases/tag/nshm2014r1) |:small_blue_diamond:| | ASCE7-16 |
+Conterminous U.S. | 2008 | v3.3.3 | |:small_blue_diamond:| |
+Conterminous U.S. | 2008 | [v3.2.0](https://github.com/usgs/nshmp-haz-fortran/releases/tag/nshm2008r3) |:small_blue_diamond:| | |
+Conterminous U.S. | 2008 | v3.1.0 |:small_blue_diamond:| | ASCE7-10 |
+Conterminous U.S. | 2008 | v3.0.0 | | | |
+Conterminous U.S. | 2002 | v2.0.0 | | | |
+Conterminous U.S. | 1996 | v1.0.0 | | | |
+Alaska | 2007 | v2.1.0 | |:small_blue_diamond:| |
+Alaska | 2007 | v2.0.0 |:small_blue_diamond:| | ASCE7-10 |
+Alaska | 1999 | v1.0.0 | | | |
+American Samoa | 2012 | v1.0.0 | | | |
+Guam | 2012 | v1.0.0 | | | |
+Hawaii | 2018 | v2.0.0 | | TBD | |
+Hawaii | 1998 | v1.1.0 | | TBD | |
+Hawaii | 1998 | v1.0.0 |:small_blue_diamond:| | ASCE7-10 |
+Puerto Rico & <br/> U.S. Virgin Islands | 2003 | v1.0.0 | | | |
<sup>†</sup> __Note on the 2014 Conterminous U.S. NSHM:__ Initial publication of the
-[2014 model](https://earthquake.usgs.gov/hazards/hazmaps/conterminous/index.php#2014) included
-data to support updates to the U.S. Building Code, specifically hazard curves for peak ground
-acceleration (PGA), and 0.2 and 1.0 second spectral accelerations, all at a BC boundary site
+[2014 model](https://www.usgs.gov/natural-hazards/earthquake-hazards/science/2014-united-states-lower-48-seismic-hazard-long-term)
+included data to support updates to the U.S. Building Code, specifically hazard curves for peak
+ground acceleration (PGA), and 0.2 and 1.0 second spectral accelerations, all at a BC boundary site
class with Vs30 = 760 m/s. Some time later, the model was deployed to the Unified Hazard Tool
(UHT) and included support in the Wester U.S. for calculations at sites other than Vs30 = 760 m/s,
consistent with dynamic calculations using the 2008 model. Subsequently, we updated the 2014
@@ -85,24 +90,31 @@ bound to use those values adopted by the U.S. building code, one of the editions
is probably most appropriate. However, if one is bound to use the most up to date source model,
one of the dynamic editions is likely better.
-Dynamic editions are supported through web-services provided by the `nshmp-haz-ws` library
-(this repository). Static editions are supported via a separate set of services. Both are
-documented on the [web services](web-services) page.
+TODO: do we want to reference `nshmp-haz-ws` and is this the correct reference here?
+
+Dynamic editions are supported through web-services provided by the `nshmp-haz-ws` library.
+Static editions are supported via a separate set of services. Both are documented on the
+[web services](./NSHMP-Web-Services.md#nshmp-web-services) page.
## Region specific changes
Changes between editions in model regions are documented in the release notes of the individual
model repositories.
-TODO: Update model links
+TODO: model links currently point to github repos
-* [Conterminous US (2014)](/usgs/nshmp-model-cous-2014/wiki)
-* [Conterminous US (2008)](/usgs/nshmp-model-cous-2008/wiki)
-* [Alaska (2007)](/usgs/nshmp-model-ak-2007/wiki)
+* [Conterminous US (2014)](https://github.com/usgs/nshm-cous-2014)
+* [Conterminous US (2008)](https://github.com/usgs/nshm-cous-2008)
+* [Alaska (2007)](https://github.com/usgs/nshm-ak-2007)
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [USGS Models](./USGS-Models.md#usgs-models)
+ * [Model Editions](./Model-Editions.md#model-editions)
+ * [Logic Trees & Uncertainty](./Logic-Trees-&-Uncertainty.md#logic-trees-&-uncertainty)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/NSHMP-Web-Services.md b/docs/pages/NSHMP-Web-Services.md
new file mode 100644
index 000000000..ccd7d2faf
--- /dev/null
+++ b/docs/pages/NSHMP-Web-Services.md
@@ -0,0 +1,12 @@
+# NSHMP Web Services
+
+TODO: this page is referenced in [`Model-Editions.md`](./Model-Editions.md#static-vs-dynamic). Need
+a description of the available web services and static data.
+
+---
+
+[**Documentation Index**](../README.md)
+
+---
+ [U.S. Geological Survey](https://www.usgs.gov)
+National Seismic Hazard Mapping Project ([NSHMP](https://earthquake.usgs.gov/hazards/))
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index b6699d151..fca0e1068 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -1,6 +1,5 @@
# Site Specification
-
The sites at which to perform hazard and related calculations may be defined in a variety of
ways. Examples of the file formats described below are available in the resource directory:
[`etc/nshm`](../../etc/nshm/README.md).
@@ -20,7 +19,7 @@ entire string in double quotes.
For any site parameter values that are not supplied on the command line or in the file formats
below, the following defaults are used (see the `site` member of the
-[configuration](./Calculation-Configuration.md) file):
+[configuration parameter](./Calculation-Configuration.md#calculation-configuration-parameters) table):
```text
name: Unnamed
diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md
index 6a686b063..3ad949174 100644
--- a/docs/pages/USGS-Models.md
+++ b/docs/pages/USGS-Models.md
@@ -6,7 +6,7 @@ years. This window is narrowing, however, and updates are also being undertaken
models for states and territories outside the conterminous U.S. These pages describe the models
that are available and some of the history and versions of each. The models are intended for use
with the USGS probabilistic earthquake hazard codebase:
-[*nshmp-haz-v2*](https://github.com/usgs/nshmp-haz).
+[*nshmp-haz-v2*](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2).
As specified in this documentation, NSHM files are organized by tectonic setting and then further
by source type. For larger models, such as that of the conterminous U.S., sources are commonly
@@ -18,8 +18,8 @@ page for links to all published models.
Each model region has a dedicated repository with version tags marking different model editions:
-* [Conterminous U.S.](/ghsc/nshmp/nshm-conus)
-* [Hawaii](/ghsc/nshmp/nshm-hawaii)
+* [Conterminous U.S.](https://code.usgs.gov/ghsc/nshmp/nshm-conus)
+* [Hawaii](https://code.usgs.gov/ghsc/nshmp/nshm-hawaii)
* Alaska - _update not yet published_
* Guam & Marianas - _update not yet published_
* Puerto Rico & U.S. Virgin Islands - _update not yet published_
@@ -29,10 +29,10 @@ Each model region has a dedicated repository with version tags marking different
## Related Pages
-* [Model Editions](model-editions.md)
-* [Logic Trees & Uncertainty](logic-trees-&-uncertainty.md)
-
-[**Documentation Index**](../README.md)
+* [USGS Models](./USGS-Models.md#usgs-models)
+ * [Model Editions](./Model-Editions.md#model-editions)
+ * [Logic Trees & Uncertainty](./Logic-Trees-&-Uncertainty.md#logic-trees-&-uncertainty)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
--
GitLab
From 4fc7312c96de9c5a5dc2de72f9963cbadbf134c9 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Wed, 30 Jun 2021 17:02:20 -0600
Subject: [PATCH 15/17] add navigation, clean up links
---
docs/pages/Ground-Motion-Models.md | 11 ++++++++-
docs/pages/Hazard-Model.md | 20 ++++++++--------
.../Magnitude-Frequency-Distributions.md | 13 +++++++++--
docs/pages/Model-Files.md | 19 +++++++++++----
docs/pages/Model-Structure.md | 23 +++++++++++++------
docs/pages/Rupture-Scaling-Relations.md | 11 ++++++++-
docs/pages/Source-Types.md | 11 ++++++++-
7 files changed, 81 insertions(+), 27 deletions(-)
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index 49ecc4fa9..2c1cb73c7 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -172,7 +172,16 @@ BC Hydro NGA<br>[Abrahamson et al., 2018](https://peer.berkeley.edu/sites/defaul
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Hazard-Model.md b/docs/pages/Hazard-Model.md
index 92171f527..e5e7109f9 100644
--- a/docs/pages/Hazard-Model.md
+++ b/docs/pages/Hazard-Model.md
@@ -11,15 +11,6 @@ Epistemic uncertainty in source and ground motion models is represented with log
file formats and structure adopted here leverage the heirarchical organization of file systems to
support modeling of complex logic trees.
-## Related Pages
-
-* [Model Structure](model-structure)
-* [Model Files](model-files)
-* [Source Types](source-types)
-* [Magnitude-Frequency Distributions (MFDs)](magnitude-frequency-distributions-mfds)
-* [Rupture-Scaling Relations](magnitude-scaling-relations)
-* [Ground Motion Models (GMMs)](ground-motion-models-gmms)
-
## Model Applicability
* NOTE FOR HAZARD CURVE DATA: While the gridded hazard curve data includes ground motions at long
@@ -34,7 +25,16 @@ support modeling of complex logic trees.
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Magnitude-Frequency-Distributions.md b/docs/pages/Magnitude-Frequency-Distributions.md
index 0d041cc9c..8342a809e 100644
--- a/docs/pages/Magnitude-Frequency-Distributions.md
+++ b/docs/pages/Magnitude-Frequency-Distributions.md
@@ -246,7 +246,7 @@ ID's: `[M1, M2, M3, ...]` to support mfd-tree matching across source-tree branch
How MFDs are actually built depends on the settings in a `mfd-config.json` file and rates. For more
details on MFDs and their configuration see the
-[magnitude frequency distributions](magnitude-frequency-distributions) section.
+[magnitude frequency distributions](./Magnitude-Frequency-Distributions.md) section.
An `mfd-config.json` is currently only required for finite fault sources. It can be located
anywhere in the file heirarchy and may be overridden in nested directories.
@@ -286,7 +286,16 @@ TODO: convert example to JSON format (or see `mfd-config.json` section above)
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Model-Files.md b/docs/pages/Model-Files.md
index ca478d5ee..d78797edd 100644
--- a/docs/pages/Model-Files.md
+++ b/docs/pages/Model-Files.md
@@ -30,7 +30,7 @@ motions from the model.
**calc-config.json:** Optional calculation configuration file specifies the default
calculation settings used for a NSHM. This file overrides any built in default values. See
-the [calculation configuration](calculation-configuration) page for more details.
+the [calculation configuration](./Calculation-Configuration.md) page for more details.
## Logic Trees
@@ -112,8 +112,8 @@ For example:
]
```
-See the [ground motion models](ground-motion-models) page for details on GMMs supported in
-_nshmp-haz_ and the related `gmm-config.json` files that governs GMM behavior.
+See the [ground motion models](./Ground-Motion-Models.md) page for details on GMMs supported in
+_nshmp-haz-v2_ and the related `gmm-config.json` files that governs GMM behavior.
### MFD Logic Trees
@@ -136,7 +136,7 @@ using the same MFDs on multiple branches of a source tree.
How MFDs are intialized (or realized) depends on the presence and contents of `mfd-config.json` and
`rate-tree.json` files. See the
-[magnitude frequency distributions](magnitude-frequency-distributions) page for details on these
+[magnitude frequency distributions](./Magnitude-Frequency-Distributions.md) page for details on these
files and the types of MFDs supported in _nshmp-haz_.
## Rupture Sets
@@ -186,7 +186,16 @@ is composed of an array of rupture-sets.
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Model-Structure.md b/docs/pages/Model-Structure.md
index e7230c6b1..95d0a2ec0 100644
--- a/docs/pages/Model-Structure.md
+++ b/docs/pages/Model-Structure.md
@@ -16,7 +16,7 @@ settings supporting the nested source types: `fault-sources`, `grid-sources`, an
The `volcanic` tectonic setting also supports `decollement-sources`.
The root of a model must include `model-info.json` and _may_ include a `calc-config.json` that
-specifies any custom default [calculation configuration](calculation-configuration) settings
+specifies any custom default [calculation configuration](./Calculation-Configuration.md) settings
for the model. Top level tectonic setting directories must include `gmm-tree.json` and
`gmm-config.json` files. Source directories are loaded recursively, permitting configuration files
deeper in the heirarchy to override those defined higher in the heirarchy, as needed and as
@@ -95,7 +95,7 @@ fault-sources/
└─ branch-4/
```
-See also: [Finite Fault Source Type](source-types#finite-fault-sources)
+See also: [Finite Fault Source Type](./Source-Types#fault-sources)
## Crustal Grid Sources
@@ -127,7 +127,7 @@ grid-sources/
└─ ...
```
-See also: [Grid Source Type](source-types#grid-sources)
+See also: [Grid Source Type](./Source-Types.md#grid-sources)
## Crustal Zone (Area) Sources
@@ -156,7 +156,7 @@ zone-sources/
└─ [rate-tree.json] (optional) tree of rates (future)
```
-See also: [Zone Source Type](source-types#zone-sources)
+See also: [Zone Source Type](./Source-Types.md#zone-sources)
## Subduction Interface Sources
@@ -174,7 +174,7 @@ subduction-interface
└─ ...
```
-See also: [Subduction Interface Source Type](source-types#subduction-interface-sources)
+See also: [Subduction Interface Source Type](./Source-Types.md#subduction-interface-sources)
## Subduction Intraslab Sources
@@ -192,11 +192,20 @@ subduction-slab
└─ ...
```
-See also: [Subduction Intraslab Source Type](source-types#subduction-intraslab-sources)
+See also: [Subduction Intraslab Source Type](./Source-Types.md#subduction-intraslab-sources)
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Rupture-Scaling-Relations.md b/docs/pages/Rupture-Scaling-Relations.md
index e78cd91a9..6f86336e9 100644
--- a/docs/pages/Rupture-Scaling-Relations.md
+++ b/docs/pages/Rupture-Scaling-Relations.md
@@ -70,7 +70,16 @@ relationships for subduction zone earthquakes. Seismological Research Letters 68
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/Source-Types.md b/docs/pages/Source-Types.md
index b6a0382a3..d56b87194 100644
--- a/docs/pages/Source-Types.md
+++ b/docs/pages/Source-Types.md
@@ -347,7 +347,16 @@ using an `slab-config.json` file.
---
-[**Documentation Index**](../README.md)
+## Related Pages
+
+* [Hazard Model](./Hazard-Model.md#hazard-model)
+ * [Model Structure](./Model-Structure.md#model-structure)
+ * [Model Files](./Model-Files.md#model-files)
+ * [Source Types](./Source-Types.md#source-types)
+ * [Magnitude Frequency Distributions (MFDs)](./Magnitude-Frequency-Distributions.md#magnitude-frequency-distributions)
+ * [Rupture Scaling Relations](./Rupture-Scaling-Relations.md#rupture-scaling-relations)
+ * [Ground Motion Models (GMMs)](./Ground-Motion-Models.md#ground-motion-models)
+* [**Documentation Index**](../README.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
--
GitLab
From f0e63dbee9974192ce4f3caebbde8dcc57df1494 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Sun, 25 Jul 2021 16:42:40 -0600
Subject: [PATCH 16/17] update readme and wep app/serivces pages
---
docs/README.md | 8 ++++++--
docs/pages/NSHMP-Web-Services.md | 9 +++++++--
2 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 95e2a6cfb..b1343c3bf 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -31,9 +31,14 @@ to use *nshmp-haz-v2* as well as underlying model implementation details.
* [Logic Trees & Uncertainty](./pages/Logic-Trees-&-Uncertainty.md)
* [NSHMP Web Services](./pages/NSHMP-Web-Services.md#nshmp-web-services)
-## Other Pages & References
+## Related Information
* [nshmp-lib](https://code.usgs.gov/ghsc/nshmp/nshmp-lib): USGS hazard modeling library
+ * [nshmp-lib JavaDocs](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/)
+* [*nshmp-haz-v2* License](../LICENSE.md)
+
+## References
+
* [Functional PSHA](./pages/Functional-PSHA.md)
* [Probabilistic Seismic Hazard Analysis, a Primer
[PDF]](http://www.opensha.org/sites/opensha.org/files/PSHA_Primer_v2_0.pdf)
@@ -41,7 +46,6 @@ to use *nshmp-haz-v2* as well as underlying model implementation details.
* [An Introduction to Probabilistic Seismic Hazard Analysis
[PDF]](http://web.stanford.edu/~bakerjw/Publications/Baker_(2015)_Intro_to_PSHA.pdf)
by Jack Baker
-* [*nshmp-haz-v2* License](../LICENSE.md)
---
 [U.S. Geological Survey](https://www.usgs.gov)
diff --git a/docs/pages/NSHMP-Web-Services.md b/docs/pages/NSHMP-Web-Services.md
index ccd7d2faf..fc5b6afa4 100644
--- a/docs/pages/NSHMP-Web-Services.md
+++ b/docs/pages/NSHMP-Web-Services.md
@@ -1,7 +1,12 @@
# NSHMP Web Services
-TODO: this page is referenced in [`Model-Editions.md`](./Model-Editions.md#static-vs-dynamic). Need
-a description of the available web services and static data.
+A number of USGS web applications and web services are available to access static data, perform
+dynamic calculations, interact with ground motion models, and access other NSHMP data.
+
+* Hazard tools web application: [NSHM Hazard Tool](https://earthquake.usgs.gov/nshmp/)
+* Static hazard curve data:
+ * [CONUS 2018 NSHM](https://earthquake.usgs.gov/ws/nshmp/conus-2018/static/)
+* Non-NSHM web services: [https://earthquake.usgs.gov/ws/nshmp/data/](https://earthquake.usgs.gov/ws/nshmp/data/)
---
--
GitLab
From 0780c5aa6efbecb2342351f423571ff3ad128df1 Mon Sep 17 00:00:00 2001
From: Jason Altekruse <jaltekruse@usgs.gov>
Date: Mon, 26 Jul 2021 11:06:31 -0600
Subject: [PATCH 17/17] update haz-v2 to haz
---
docs/README.md | 10 +++++-----
docs/pages/Building-&-Running.md | 20 ++++++++++----------
docs/pages/Calculation-Configuration.md | 2 +-
docs/pages/Developer-Basics.md | 4 ++--
docs/pages/Ground-Motion-Models.md | 4 ++--
docs/pages/Logic-Trees-&-Uncertainty.md | 2 +-
docs/pages/Model-Editions.md | 2 +-
docs/pages/Model-Files.md | 2 +-
docs/pages/Site-Specification.md | 14 +++++++-------
docs/pages/Source-Types.md | 6 +++---
docs/pages/USGS-Models.md | 2 +-
11 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index b1343c3bf..a528bb23d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,14 +1,14 @@
# Documentation: nshmp-haz
-***nshmp-haz-v2*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack
+***nshmp-haz*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack
that supports probabilistic seismic hazard (PSHA) and related analyses. It is maintained by the
National Seismic Hazard Model Project ([NSHMP](https://earthquake.usgs.gov/hazards/)) within the
USGS's earthquake hazards program ([EHP](http://earthquake.usgs.gov)).
-*nshmp-haz-v2* supports high performance seismic hazard calculations required to generate detailed
+*nshmp-haz* supports high performance seismic hazard calculations required to generate detailed
maps over large areas and supports a variety of USGS web services and applications related to
seismic hazards research and the dissemination of hazard data. This documentation explains how
-to use *nshmp-haz-v2* as well as underlying model implementation details.
+to use *nshmp-haz* as well as underlying model implementation details.
## Table of Contents
@@ -18,7 +18,7 @@ to use *nshmp-haz-v2* as well as underlying model implementation details.
* [Calculation Configuration](./pages/Calculation-Configuration.md)
* [Site Specification](./pages/Site-Specification.md)
* [Examples](../../etc/examples/README.md) (or
- [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples))
* [Hazard Model](./pages/Hazard-Model.md)
* [Model Structure](./pages/Model-Structure.md)
* [Model Files](./pages/Model-Files.md)
@@ -35,7 +35,7 @@ to use *nshmp-haz-v2* as well as underlying model implementation details.
* [nshmp-lib](https://code.usgs.gov/ghsc/nshmp/nshmp-lib): USGS hazard modeling library
* [nshmp-lib JavaDocs](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/)
-* [*nshmp-haz-v2* License](../LICENSE.md)
+* [*nshmp-haz* License](../LICENSE.md)
## References
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index 6735ae1d7..4a4d7d1ef 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -7,7 +7,7 @@
* [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration)
* [Site Specification](./Site-Specification.md#site-specification)
* [Examples](../../etc/examples/README.md) (or
- [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples))
## Build & Run Options
@@ -16,12 +16,12 @@
## Build and Run Locally
-Building and running *nshmp-haz-v2* requires prior installation of Git and Java. Please see the
+Building and running *nshmp-haz* requires prior installation of Git and Java. Please see the
[developer basics](./Developer-Basics.md) page for system configuration guidance.
### Building
-Navigate to a location on your system where you want *nshmp-haz-v2* code to reside, clone the
+Navigate to a location on your system where you want *nshmp-haz* code to reside, clone the
repository, and compile:
```bash
@@ -54,7 +54,7 @@ be supplied as a third argument. It can be used to override any calculation sett
[default](./Calculation-Configuration.md) values are used.
See the [examples](../../etc/examples/README.md) directory for more details (or
-[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples))
### Computing Disaggregations
@@ -72,7 +72,7 @@ files. Disaggregations also have some independent
## Run with [Docker](https://docs.docker.com/install/)
-To ensure you are have the latest *nshmp-haz-v2* update, always first pull the image from Docker:
+To ensure you are have the latest *nshmp-haz* update, always first pull the image from Docker:
```bash
docker pull usgs/nshmp-haz
@@ -80,18 +80,18 @@ docker pull usgs/nshmp-haz
### Docker Memory on Mac
-By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *nshmp-haz-v2*, the
+By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *nshmp-haz*, the
memory available to Docker must be [increased](https://docs.docker.com/docker-for-mac/#advanced)
to a minimum of 4 GB.
### Run in Docker
-TODO: Docker scripts currently only get models from github (XML models), so nshmp-haz-v2 run fails
-to parse the models (CONUS_2018 or HAWAII_2021), need to at least update `nshmp-haz-v2/scripts/docker-functions.inc.sh`.
+TODO: Docker scripts currently only get models from github (XML models), so nshmp-haz run fails
+to parse the models (CONUS_2018 or HAWAII_2021), need to at least update `nshmp-haz/scripts/docker-functions.inc.sh`.
TODO: Model identifiers need to be synced between here and the docker scripts (e.g. `HI-2020` vs `HAWAII_2021`).
-The *nshmp-haz-v2* application may be run as a Docker container which mitigates the need to install
+The *nshmp-haz* application may be run as a Docker container which mitigates the need to install
Git, Java, or other dependencies besides Docker. A public image is available on
Docker hub at [https://hub.docker.com/r/usgs/nshmp-haz](https://hub.docker.com/r/usgs/nshmp-haz)
which can be run with:
@@ -140,7 +140,7 @@ Where:
### Run Customization
-When running *nshmp-haz-v2* with Docker the initial (Xms) and maximum (Xmx) JVM memory sizes can
+When running *nshmp-haz* with Docker the initial (Xms) and maximum (Xmx) JVM memory sizes can
be set with the environment flag (-e, -env):
```bash
diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md
index c3d9150dc..9175a1c6a 100644
--- a/docs/pages/Calculation-Configuration.md
+++ b/docs/pages/Calculation-Configuration.md
@@ -108,7 +108,7 @@ T ≤ 10 s | 0.000333, 0.000499, 0.000749, 0.00112, 0.00169, 0.00253, <br>0.00
* [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration)
* [Site Specification](./Site-Specification.md#site-specification)
* [Examples](../../etc/examples/README.md) (or
- [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples))
* [**Documentation Index**](../README.md)
---
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index fe7229242..d83e75564 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -53,7 +53,7 @@ git clone https://code.usgs.gov/ghsc/nshmp/nshmp-haz.git
## Eclipse Integration (Optional)
Eclipse provides automatic compilation, syntax highlighting, and integration with Git, among
-other useful features. To build or modify *nshmp-haz-v2* using [Eclipse](http://www.eclipse.org/),
+other useful features. To build or modify *nshmp-haz* using [Eclipse](http://www.eclipse.org/),
install the [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/packages/) or
[Eclipse IDE for Enterprise Java and Web Developers](https://www.eclipse.org/downloads/packages/),
if you plan on developing web services. Import the project into Eclipse: `File > Import >
@@ -68,7 +68,7 @@ Gradle > Existing Gradle Project`
* [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration)
* [Site Specification](./Site-Specification.md#site-specification)
* [Examples](../../etc/examples/README.md) (or
- [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples))
* [**Documentation Index**](../README.md)
---
diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md
index 2c1cb73c7..f3b323def 100644
--- a/docs/pages/Ground-Motion-Models.md
+++ b/docs/pages/Ground-Motion-Models.md
@@ -43,7 +43,7 @@ The following sample `gmm-config.json` file applies the NGA-West 2 epistemic unc
## GMM Uncertainty Models
-*nshmp-haz-v2* supports additional epistemic uncertainty models derived from the PEER NGA-West 1
+*nshmp-haz* supports additional epistemic uncertainty models derived from the PEER NGA-West 1
and PEER NGA-West 2 projects. These models both have factors for distance (`Rrup`) bins
Rrup < 10 km, 10 km <= Rrup, < 30 km, and 30 km <= Rrup, and for magnitude bins M < 6.0, 6.0 <=
M < 7.0, and 7.0 <= M. These models can be applied within the `gmm-config.json` file as shown in
@@ -61,7 +61,7 @@ GMMs to modify model output.
## GMMs By Tectonic Setting
-GMMs available in *nshmp-haz-v2* are tabulated by tectonic setting below. See the javadocs for the
+GMMs available in *nshmp-haz* are tabulated by tectonic setting below. See the javadocs for the
[GMM Package](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/package-summary.html)
for implementation details of each GMM and comprehensive lists of GMM IDs.
diff --git a/docs/pages/Logic-Trees-&-Uncertainty.md b/docs/pages/Logic-Trees-&-Uncertainty.md
index 093ac1981..a0bdaa6a7 100644
--- a/docs/pages/Logic-Trees-&-Uncertainty.md
+++ b/docs/pages/Logic-Trees-&-Uncertainty.md
@@ -1,7 +1,7 @@
# USGS Models: Logic Trees & Uncertainty
The following page details the logic trees of epistemic uncertainty considered in NSHMs supported
-by *nshmp-haz-v2*. Logic trees are represented in a NSHM using files ending in `-tree.json`.
+by *nshmp-haz*. Logic trees are represented in a NSHM using files ending in `-tree.json`.
[[_TOC_]]
diff --git a/docs/pages/Model-Editions.md b/docs/pages/Model-Editions.md
index 44dba3c5b..0558f9ee9 100644
--- a/docs/pages/Model-Editions.md
+++ b/docs/pages/Model-Editions.md
@@ -7,7 +7,7 @@ data, or modeling procedures that warrant a model update. Every model the USGS p
associated with a USGS Open-File report or refereed journal article and supporting datasets.
However, layered on top of any given model release are bug-fixes and model improvements.
-With the update to a new codebase, [nshmp-haz-v2](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2),
+With the update to a new codebase, [nshmp-haz](https://code.usgs.gov/ghsc/nshmp/nshmp-haz),
the NSHMP has adopted [semantic versioning](http://semver.org) to keep track of different hazard
models. For any given model region, the first number (or major version) corresponds to a particular
release or update year. For example, we consider the initial
diff --git a/docs/pages/Model-Files.md b/docs/pages/Model-Files.md
index d78797edd..3ce594a23 100644
--- a/docs/pages/Model-Files.md
+++ b/docs/pages/Model-Files.md
@@ -113,7 +113,7 @@ For example:
```
See the [ground motion models](./Ground-Motion-Models.md) page for details on GMMs supported in
-_nshmp-haz-v2_ and the related `gmm-config.json` files that governs GMM behavior.
+_nshmp-haz_ and the related `gmm-config.json` files that governs GMM behavior.
### MFD Logic Trees
diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md
index fca0e1068..e057616e8 100644
--- a/docs/pages/Site-Specification.md
+++ b/docs/pages/Site-Specification.md
@@ -4,14 +4,14 @@ The sites at which to perform hazard and related calculations may be defined in
ways. Examples of the file formats described below are available in the resource directory:
[`etc/nshm`](../../etc/nshm/README.md).
-__Note on Coordinates:__ *nshmp-haz-v2* supports longitude and latitude values in the closed
+__Note on Coordinates:__ *nshmp-haz* supports longitude and latitude values in the closed
ranges `[-360° ‥ 360°]` and `[-90° ‥ 90°]`. Note, however, that mixing site and/or source
coordinates across the antimeridian (the -180° to 180° transition) will yield unexpected results.
For Pacific models and calculations, always use positive or negative longitudes exclusively.
## Site String
-For the case of running a single site of interest, most *nshmp-haz-v2* programs accept a
+For the case of running a single site of interest, most *nshmp-haz* programs accept a
comma-delimited string of the form: `name,lon,lat[,vs30,vsInf[,z1p0,z2p5]]`, where `vs30`, `vsInf`,
`z1p0`, and `z2p5` are optional. Note that if `vs30` is supplied, so too must `vsInf`. Likewise if
`z1p0` is supplied, so too must `z2p5`. If the string contains any spaces, escape them or wrap the
@@ -45,7 +45,7 @@ it's 'default' basin depth scale factor.
## GeoJSON Format (\*.geojson)
Although more verbose than the comma-delimited format, [GeoJSON](http://geojson.org) is a more
-versatile format for encoding geographic data. *nshmp-haz-v2* uses GeoJSON for both lists of sites
+versatile format for encoding geographic data. *nshmp-haz* uses GeoJSON for both lists of sites
and to define map regions. If you encounter problems when formatting JSON files, use
[JSONLint](http://jsonlint.com) or [GeoJSONLint](http://geojsonlint.com) for validation.
@@ -77,7 +77,7 @@ A site list is expected as a `FeatureCollection` of `Point` features. For exampl
As with the CSV format, the minimum required data is a `geometry` `coordinates` array. All
`properties` are optional. When using GeoJSON, the `title` property maps to the name of the site.
-Additional properties, if present, are ignored by *nshmp-haz-v2* but permitted as they may be
+Additional properties, if present, are ignored by *nshmp-haz* but permitted as they may be
relevant for other applications. For example, [styling
properties](https://help.github.com/articles/mapping-geojson-files-on-github/#styling-features)
may be used to improve rendering in mapping applications. For a fully fledged example, see the
@@ -85,11 +85,11 @@ may be used to improve rendering in mapping applications. For a fully fledged ex
### Map Regions
-GeoJSON is also used to define *nshmp-haz-v2* map regions. For example, see the file that defines a
+GeoJSON is also used to define *nshmp-haz* map regions. For example, see the file that defines a
region commonly used when creating hazard and other maps for the
[Los Angeles basin](../../etc/nshm/map-la-basin.geojson).
-A map region is expected as a `Polygon` `FeatureCollection`. Currently, *nshmp-haz-v2* only supports
+A map region is expected as a `Polygon` `FeatureCollection`. Currently, *nshmp-haz* only supports
a `FeatureCollection` with 1 or 2 polygons. When a single polygon is defined, it must consist of a
single, simple closed loop. Additional arrays that define holes in the polygon (per the GeoJSON
spec) are not processed and results are undefined for self-intersecting coordinate arrays. This
@@ -117,7 +117,7 @@ TODO This needs updating; link to conus-2018 active crust map-region.geojson.
* [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration)
* [Site Specification](./Site-Specification.md#site-specification)
* [Examples](../../etc/examples/README.md) (or
- [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples))
+ [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples))
* [**Documentation Index**](../README.md)
---
diff --git a/docs/pages/Source-Types.md b/docs/pages/Source-Types.md
index d56b87194..595e0a912 100644
--- a/docs/pages/Source-Types.md
+++ b/docs/pages/Source-Types.md
@@ -12,15 +12,15 @@ geometry itself is unknown or very poorly defined.
[[_TOC_]]
-Source models for use with *nshmp-haz-v2* are defined using [JSON](https://www.json.org) and
-[GeoJSON](https://geojson.org). *nshmp-haz-v2* makes determinations about how to represent a source
+Source models for use with *nshmp-haz* are defined using [JSON](https://www.json.org) and
+[GeoJSON](https://geojson.org). *nshmp-haz* makes determinations about how to represent a source
based on a GeoJSON geometry type in conjunction with supporting JSON configuration files. Example
source configuration files, `*-config.json`, are provided with each source type description.
Configuration files must be fully specified with `null` JSON member values used to specify 'do
nothing' where appropriate. Any configuration member value in ALL_CAPS indicates the value is one
of a fixed number of options commonly referred to as an enum.
-__Note on Coordinates:__ *nshmp-haz-v2* supports longitude and latitude values in the closed ranges
+__Note on Coordinates:__ *nshmp-haz* supports longitude and latitude values in the closed ranges
`[-360°‥360°]` and `[-90°‥90°]`. Note, however, that mixing site and/or source coordinates across
the antimeridian (the -180° to 180° transition) will yield unexpected results. For Pacific models
and calculations, always use positive or negative longitudes exclusively.
diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md
index 3ad949174..8a0226afd 100644
--- a/docs/pages/USGS-Models.md
+++ b/docs/pages/USGS-Models.md
@@ -6,7 +6,7 @@ years. This window is narrowing, however, and updates are also being undertaken
models for states and territories outside the conterminous U.S. These pages describe the models
that are available and some of the history and versions of each. The models are intended for use
with the USGS probabilistic earthquake hazard codebase:
-[*nshmp-haz-v2*](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2).
+[*nshmp-haz*](https://code.usgs.gov/ghsc/nshmp/nshmp-haz).
As specified in this documentation, NSHM files are organized by tectonic setting and then further
by source type. For larger models, such as that of the conterminous U.S., sources are commonly
--
GitLab