From d38790efaf65b35931bde426236f5848b7ef58d2 Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Fri, 5 Feb 2016 11:13:03 -0700
Subject: [PATCH] readme and config updates
---
README.md | 2 +-
etc/examples/1-hazard-curve/README.md | 2 +-
etc/examples/5-complex-model/README.md | 2 +-
etc/examples/6-enhanced-output/README.md | 6 ++++--
etc/examples/6-enhanced-output/config.json | 21 +++++++++++++++++++++
5 files changed, 28 insertions(+), 5 deletions(-)
create mode 100644 etc/examples/6-enhanced-output/config.json
diff --git a/README.md b/README.md
index 9e8f8132a..e1d67a222 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,4 @@ nshmp-haz
U.S. Geological Survey (USGS) National Seismic Hazard Model Project (NSHMP) codes.
-Information relevant to obtaining, building, and running the code may be found in the [wiki](https://github.com/usgs/nshmp-haz/wiki/).
+Information relevant to obtaining, building, and running the code may be found in the [Wiki](https://github.com/usgs/nshmp-haz/wiki/).
diff --git a/etc/examples/1-hazard-curve/README.md b/etc/examples/1-hazard-curve/README.md
index b9997bf75..84b901d3e 100644
--- a/etc/examples/1-hazard-curve/README.md
+++ b/etc/examples/1-hazard-curve/README.md
@@ -11,7 +11,7 @@ hazard ../../peer/models/Set1-Case1
The PEER models, such as that designated above, consist of simple cases for different source types commonly encountered in a PSHA and are included in the nshmp-haz repository to support testing. See the [PEER directory](../../peer/) for more information.
-The result of this calculation should be available as a single comma-delimited file containing several hazard curves for PGA in a newly created 'curves' directory. In this example, the calculation configuration was derived from the model directory. Note that not all calculation [configuration](https://github.com/usgs/nshmp-haz/wiki/Configuration) parameters need be supplied; see the [configuration file](../../peer/models/Set1-Case1/config.json) for this example model.
+The result of this calculation should be available as a single comma-delimited file containing several total mean hazard curves for PGA in a newly created 'curves' directory. In this example, the calculation configuration was derived from the model directory. Note that not all calculation [configuration](https://github.com/usgs/nshmp-haz/wiki/Configuration) parameters need be supplied; see the [configuration file](../../peer/models/Set1-Case1/config.json) for this example model.
Also note that when only a model is supplied to `HazardCalc`, all output is written to the current working directory. In the next example, we'll override the model supplied configuration with a custom file.
diff --git a/etc/examples/5-complex-model/README.md b/etc/examples/5-complex-model/README.md
index bf5e087ed..3f8e321e4 100644
--- a/etc/examples/5-complex-model/README.md
+++ b/etc/examples/5-complex-model/README.md
@@ -23,6 +23,6 @@ Note that more complex models take longer to initialize, although this only occu
hazard ../../../nshmp-model-cous-2008/Western\ US 5-complex-model/config-map.json
```
-This computes 121 curves over a 2° by 2° area and will give you a sense of how long a larger map might take.
+This computes 121 curves over a 2° by 2° area and will give you a sense of how long a larger map might take. These results overwrite those of the prior site-specific calculation.
#### Next: [Example 6 – Enhanced output](../6-enhanced-output)
diff --git a/etc/examples/6-enhanced-output/README.md b/etc/examples/6-enhanced-output/README.md
index a639f8132..eafa33ccf 100644
--- a/etc/examples/6-enhanced-output/README.md
+++ b/etc/examples/6-enhanced-output/README.md
@@ -3,10 +3,12 @@ Example 6: Enhanced output
__Working directory:__ `/path/to/nshmp-haz/etc/examples`
-By default, `HazardCalc` outputs only total mean hazard curves, however, curves by ground motion model and source type can also be written. Execute
+While mean hazard is of broad interest, it can be useful to preserve individual components of a total curve, particularly with more complex models. Execute the following to write curves for each source type and ground motion model (GMM) used in the 2008 NSHM:
```Shell
hazard ../../../nshmp-model-cous-2008/Western\ US 6-enhanced-output/config.json
```
-#### Next: [Example ????](../)
+Note that the output curves directory now contains additional derectories of curves by source type and GMM.
+
+See the `nshmp-haz` wiki and JavDocs for more information on source types ([Wiki](https://github.com/usgs/nshmp-haz/wiki/Source-Types), [JavaDoc](http://usgs.github.io/nshmp-haz/javadoc/index.html?org/opensha2/eq/model/SourceType.html)) and GMMs ([Wiki](https://github.com/usgs/nshmp-haz/wiki/Ground-Motion-Models), [JavaDoc](http://usgs.github.io/nshmp-haz/javadoc/index.html?org/opensha2/gmm/Gmm.html)).
diff --git a/etc/examples/6-enhanced-output/config.json b/etc/examples/6-enhanced-output/config.json
new file mode 100644
index 000000000..c1fc16cab
--- /dev/null
+++ b/etc/examples/6-enhanced-output/config.json
@@ -0,0 +1,21 @@
+{
+ "hazardFormat": "DETAILED",
+ "sites": [
+ {
+ "name": "Los Angeles",
+ "location": [-118.25, 34.05]
+ },
+ {
+ "name": "San Francisco",
+ "location": [-122.40, 37.75]
+ },
+ {
+ "name": "Seattle",
+ "location": [-122.30, 47.60]
+ },
+ {
+ "name": "Salt Lake City",
+ "location": [-111.90, 40.75]
+ }
+ ]
+}
\ No newline at end of file
--
GitLab