From 8174a284f25bab8f89b1c88cdb3c0388eb039cd6 Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Thu, 5 Jan 2023 19:54:54 -0700
Subject: [PATCH] typos; web service build edits
---
docs/pages/About-the-NSHMP.md | 2 +-
docs/pages/Building-&-Running.md | 35 ++++++++++++++++++++++++++++----
docs/pages/Developer-Basics.md | 9 --------
package-lock.json | 1 -
4 files changed, 32 insertions(+), 15 deletions(-)
diff --git a/docs/pages/About-the-NSHMP.md b/docs/pages/About-the-NSHMP.md
index 54d1297ad..042f137bb 100644
--- a/docs/pages/About-the-NSHMP.md
+++ b/docs/pages/About-the-NSHMP.md
@@ -18,7 +18,7 @@ considered in other industries such as real estate lending. A 9-member steering
academic and industry experts provides technical oversight and recommendations to the NSHMP.
An NSHM defines the set of likely earthquake sources and their rates in a particular region. Given
-parameters of the earhtquake source and a site of interest, ground motion models (GMMs) are used
+parameters of the earthquake 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.
diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md
index 8464fb14d..c349b5860 100644
--- a/docs/pages/Building-&-Running.md
+++ b/docs/pages/Building-&-Running.md
@@ -21,8 +21,8 @@ Building and running *nshmp-haz* requires prior installation of Git and Java. Pl
### Building
-Navigate to a location on your system where you want *nshmp-haz* code to reside, clone the
-repository, and compile:
+_nshmp-haz_ uses the [Gradle](https://gradle.org/) build tool. Navigate to a location on your
+system where you want *nshmp-haz* code to reside, clone the repository, and compile:
```bash
cd /path/to/project/directory
@@ -36,7 +36,34 @@ This creates a single file, `build/libs/nshmp-haz.jar` that may be used for haza
users using the native command prompt). This executes any tasks (e.g. `assemble`) after
downloading all required dependencies, including Gradle itself.
-### Computing Hazard
+### Running
+
+_nshmp-haz_ applications may be run from the command line or as a local web service. Command line
+applications are recommended for long running hazard and disaggregation calculations, but most
+users will find a web service endpoint to be more flexible. Web services return
+[JSON](https://www.json.org/json-en.html) responses that can be parsed by most programming
+languages and data analaysis and visualization programs (e.g. Matlab).
+
+### Web Servies
+
+To run _nshmp-haz_ as a web service:
+
+```bash
+./gradlew run
+```
+
+Services (and documentation) are then avialable on <http://localhost:8080/>
+
+ALternatively, run:
+code, run:
+
+```bash
+./gradlew run -t
+```
+
+to have the services automatically recompile when the source code changes.
+
+### Command Line Hazard Calculation
The `HazardCalc` program computes hazard curves at one or more sites for a variety of intensity
measures. For example:
@@ -56,7 +83,7 @@ be supplied as a third argument. It can be used to override any calculation sett
See the [examples](../../etc/examples) directory for more details (or
[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main/etc/examples))
-### Computing Disaggregations
+### Command Line Disaggregation Calculation
Like `HazardCalc`, the `DisaggCalc` program performs disaggregations at one or more sites for a
variety of intensity measures. The return period for the disaggregation is defined in the config,
diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md
index 17da9de70..799479e25 100644
--- a/docs/pages/Developer-Basics.md
+++ b/docs/pages/Developer-Basics.md
@@ -50,15 +50,6 @@ cd /directory/for/code
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/),
-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 >
-Gradle > Existing Gradle Project`
-
---
## Related Pages
diff --git a/package-lock.json b/package-lock.json
index dc72624ba..fd03b78e3 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -5,7 +5,6 @@
"requires": true,
"packages": {
"": {
- "name": "nshmp-haz",
"version": "2.0.0",
"devDependencies": {
"markdownlint-cli": "^0.31.1",
--
GitLab