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