From 0ae6602c3c653689b477790bf7cc6258f584b1c6 Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Tue, 26 Jan 2016 11:23:58 -0700
Subject: [PATCH] readme updates
---
etc/examples/1-simple-hazard/README.md | 2 +-
etc/examples/2-custom-config/README.md | 4 ++--
etc/examples/README.md | 4 +---
3 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/etc/examples/1-simple-hazard/README.md b/etc/examples/1-simple-hazard/README.md
index cb222afe3..31c47bee1 100644
--- a/etc/examples/1-simple-hazard/README.md
+++ b/etc/examples/1-simple-hazard/README.md
@@ -9,7 +9,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 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 the HazardCalc program, 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/2-custom-config/README.md b/etc/examples/2-custom-config/README.md
index ab6ef91ce..f62999615 100644
--- a/etc/examples/2-custom-config/README.md
+++ b/etc/examples/2-custom-config/README.md
@@ -10,8 +10,8 @@ hazard ../peer/models/Set1-Case1 2-custom-config/config.json
In this example we've overridden the configuration supplied by the model. Specifically:
* The upper end of each hazard curve has been truncated at 3 standard deviations.
-* Hazard curves have been calculated for 3 `imts` (intensity measure types, or spectral periods) and written to the [2-custom-config]() directory.
-* The `imls` (the intensity measure levels or x-values) of the resultant curves have been explicitely defined for each `imt`.
+* Hazard curves have been calculated for 3 `imts` (intensity measure types, or spectral periods) and written to the directory containing the config file.
+* The `imls` (intensity measure levels or x-values) of the resultant curves have been explicitely defined for each `imt`.
* And two different sites have been specified.
**A note on output:** Because we supplied a specific configuration file, all program output will be written to the directory where the config resides, thus keeping a record of calculation settings along with any results.
diff --git a/etc/examples/README.md b/etc/examples/README.md
index 913681728..098bc3fb0 100644
--- a/etc/examples/README.md
+++ b/etc/examples/README.md
@@ -7,9 +7,7 @@ Examples
alias hazard='java -cp /path/to/repo/nshmp-haz/dist/nshmp-haz.jar org.opensha2.programs.HazardCalc'
```
-2. **Note:** All HazardCalc output is written to the current directory from which the program was called.
-
-
+Because each example builds on prior concepts, it is best step through all the examples, however quickly.
#### Calculating hazard maps
Hazard maps are generated from numerous uniformely spaced hazard curves. To compute such a curve set, the same program is used, but sites are instead specified as a region.
--
GitLab