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] 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