From 8eede1597065be78051fafaf9915c97e5f39d1ba Mon Sep 17 00:00:00 2001 From: Peter Powers <pmpowers@usgs.gov> Date: Thu, 28 Jan 2016 14:45:40 -0700 Subject: [PATCH] readme and example edits --- etc/README.md | 4 ++-- etc/examples/1-hazard-curve/README.md | 2 +- etc/examples/2-custom-config/README.md | 6 +++--- etc/examples/3-sites-file/README.md | 2 +- etc/examples/4-hazard-map/README.md | 2 +- etc/examples/5-complex-model/README.md | 8 ++++---- etc/examples/6-enhanced-output/README.md | 2 +- etc/peer/README.md | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/etc/README.md b/etc/README.md index 9a161d8e9..6f852a99e 100644 --- a/etc/README.md +++ b/etc/README.md @@ -1,5 +1,5 @@ -See the [examples](examples) directory as a starting point for command-line use of nshmp-haz. +See the [examples](examples) directory as a starting point for command-line use of `nshmp-haz`. -[Matlab](matlab) shows how to take advantage of the ground motion model implementations in nshmp-haz. +[Matlab](matlab) shows how to take advantage of the ground motion model implementations in `nshmp-haz`. [Peer](peer) is a collection of simple source models that are used for testing. diff --git a/etc/examples/1-hazard-curve/README.md b/etc/examples/1-hazard-curve/README.md index 74aefb8eb..b9997bf75 100644 --- a/etc/examples/1-hazard-curve/README.md +++ b/etc/examples/1-hazard-curve/README.md @@ -1,7 +1,7 @@ Example 1: A simple hazard calculation -------------------------------------- -Working directory: `/path/to/nshmp-haz/etc/examples/1-hazard-curve` +__Working directory:__ `/path/to/nshmp-haz/etc/examples/1-hazard-curve` On the command line, navigate to this directory and execute the following: diff --git a/etc/examples/2-custom-config/README.md b/etc/examples/2-custom-config/README.md index 31a3f4b75..e4d3ad739 100644 --- a/etc/examples/2-custom-config/README.md +++ b/etc/examples/2-custom-config/README.md @@ -1,7 +1,7 @@ Example 2: A custom configuration ------------------------------- -Working directory: `/path/to/nshmp-haz/etc/examples` +__Working directory:__ `/path/to/nshmp-haz/etc/examples` Navigate up one level to the `examples/` directory and execute the following: @@ -12,12 +12,12 @@ 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 directory containing the config file. +* Hazard curves have been calculated for 3 `imts` ([intensity measure types](http://usgs.github.io/nshmp-haz/javadoc/index.html?org/opensha2/gmm/Imt.html), 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. See the [configuration specification](https://github.com/usgs/nshmp-haz/wiki/Configuration) for details on default values and supported options and formats. -**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. +**A note on output:** Because we supplied a specific configuration file, all program output is written to the directory where the config resides, thus keeping a record of calculation settings along with any results. #### Next: [Example 3 – Using a custom sites file](../3-sites-file) diff --git a/etc/examples/3-sites-file/README.md b/etc/examples/3-sites-file/README.md index 3001cb9ce..8e0f05af7 100644 --- a/etc/examples/3-sites-file/README.md +++ b/etc/examples/3-sites-file/README.md @@ -1,7 +1,7 @@ Example 3: Using a custom sites file ------------------------------------ -Working directory: `/path/to/nshmp-haz/etc/examples` +__Working directory:__ `/path/to/nshmp-haz/etc/examples` One may also supply a comma-delimited site data file, which may be easier to work with in some applications. diff --git a/etc/examples/4-hazard-map/README.md b/etc/examples/4-hazard-map/README.md index 45c766cfc..81278f0f8 100644 --- a/etc/examples/4-hazard-map/README.md +++ b/etc/examples/4-hazard-map/README.md @@ -1,7 +1,7 @@ Example 4: A simple hazard map ------------------------------ -Working directory: `/path/to/nshmp-haz/etc/examples` +__Working directory:__ `/path/to/nshmp-haz/etc/examples` A hazard map is just a lot of hazard curves. To compute curves at reqularly spaced intervals in latitude and longitude, the [sites configuration](https://github.com/usgs/nshmp-haz/wiki/Configuration#four-sites) can instead be specified as a polygon. diff --git a/etc/examples/5-complex-model/README.md b/etc/examples/5-complex-model/README.md index 68590eb6b..bf5e087ed 100644 --- a/etc/examples/5-complex-model/README.md +++ b/etc/examples/5-complex-model/README.md @@ -1,7 +1,7 @@ Example 5: A more complex model ------------------------------- -Working directory: `/path/to/nshmp-haz/etc/examples` +__Working directory:__ `/path/to/nshmp-haz/etc/examples` Most PSHAs involve the use of more complex source models, the components of which might use different ground motion models. For this and ensuing examples, we'll use the 2008 USGS National Seismic Hazard Model (NSHM) for the western U.S. @@ -11,13 +11,13 @@ First, clone the 2008 USGS NSHM. Assuming `examples/` is the current working dir git clone https://github.com/usgs/nshmp-model-cous-2008.git ../../../nshmp-model-cous-2008 ``` -The 2008 NSHM repository contains two source models: one for the western U.S. and a one for the central and eastern U.S. More complex models make for longer, per-site calculations. To compute hazard for a few sites in the Western U.S., execute: +The 2008 NSHM repository contains two source models: one for the western U.S. and a one for the central and eastern U.S. To compute hazard for a few sites in the Western U.S., execute: ```Shell hazard ../../../nshmp-model-cous-2008/Western\ US 5-complex-model/config-sites.json ``` -More complex models make for longer, per-site calculations. `HazardCalc` will automatically use all cores available and therefore performs better on multi-core systems. To compute a small, low-resolution map for the central San Francisco Bay Area, execute: +Note that more complex models take longer to initialize, although this only occurs once per calculation, and make for longer, per-site calculations. However, `HazardCalc` will automatically use all cores available and therefore performs better on multi-core systems. To compute a small, low-resolution map for the central San Francisco bay area, execute: ```Shell hazard ../../../nshmp-model-cous-2008/Western\ US 5-complex-model/config-map.json @@ -25,4 +25,4 @@ hazard ../../../nshmp-model-cous-2008/Western\ US 5-complex-model/config-map.jso This computes 121 curves over a 2° by 2° area and will give you a sense of how long a larger map might take. -#### Next: [Example 6 – Enhanced output](../4-enhanced-output) +#### 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 71ba7e543..a639f8132 100644 --- a/etc/examples/6-enhanced-output/README.md +++ b/etc/examples/6-enhanced-output/README.md @@ -1,7 +1,7 @@ Example 6: Enhanced output -------------------------- -Working directory: `/path/to/nshmp-haz/etc/examples` +__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 diff --git a/etc/peer/README.md b/etc/peer/README.md index 5f359e688..ec9359cf4 100644 --- a/etc/peer/README.md +++ b/etc/peer/README.md @@ -1,5 +1,5 @@ #### PEER Test Cases -The PEER PSHA validation project developed a number of source models for the purpose of examining the sensitivity of seismic hazard to different PSHA implementations (codes). These test cases are used as end-to-end unit tests in nshmp-haz. +The PEER PSHA validation project developed a number of source models for the purpose of examining the sensitivity of seismic hazard to different PSHA implementations (codes). These test cases are used as end-to-end unit tests in `nshmp-haz`. For more information, including source model specifications, result tables, and summary reports, please see the [PEER](http://peer.berkeley.edu) PSHA validation project (TODO: link; no site as yet). -- GitLab