Skip to content
Snippets Groups Projects
Commit c6cf8872 authored by Altekruse, Jason Morgan's avatar Altekruse, Jason Morgan
Browse files

cleanup readmes

parent 18ae9a9b
No related branches found
No related tags found
2 merge requests!577Production Release | nshmp-haz,!558update examples, fix site file extension check
...@@ -4,7 +4,7 @@ __Working directory:__ `/path/to/nshmp-haz/etc/examples/4-hazard-map` ...@@ -4,7 +4,7 @@ __Working directory:__ `/path/to/nshmp-haz/etc/examples/4-hazard-map`
A hazard map is just a collection of values plucked from a lot of hazard curves. A hazard map is just a collection of values plucked from a lot of hazard curves.
To compute curves at reqularly spaced intervals in latitude and longitude over a region, To compute curves at reqularly spaced intervals in latitude and longitude over a region,
a [GeoJSON site file](https://github.com/usgs/nshmp-haz/wiki/sites#geojson-format-geojson) a [GeoJSON site file](../../../docs/pages/Site-Specification.md#geojson-format-geojson)
may instead specify a polygon and a site spacing. may instead specify a polygon and a site spacing.
```Shell ```Shell
......
...@@ -4,9 +4,9 @@ __Working directory:__ `/path/to/nshmp-haz/etc/examples/5-complex-model` ...@@ -4,9 +4,9 @@ __Working directory:__ `/path/to/nshmp-haz/etc/examples/5-complex-model`
Most PSHAs involve the use of more complex source models, the components of which 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 might use different ground motion models. For this and ensuing examples, we'll use the
2018 USGS National Seismic Hazard Model (NSHM) for the western U.S. `nshmp-haz` uses an USGS National Seismic Hazard Model (NSHM) for the Conterminous U.S (CONUS). `nshmp-haz`
in-memory source model. The USGS NSHMs are quite large, so it's helpful to increase the amount uses an in-memory source model. The USGS NSHMs are quite large, so it's helpful to increase
memory available to Java when calling `HazardCalc`. For example, set your alias to: the amount memory available to Java when calling `HazardCalc`. For example, set your alias to:
```Shell ```Shell
alias hazard='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar gov.usgs.earthquake.nshmp.HazardCalc' alias hazard='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar gov.usgs.earthquake.nshmp.HazardCalc'
...@@ -15,19 +15,14 @@ alias hazard='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar ...@@ -15,19 +15,14 @@ alias hazard='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar
This will increase the minimum amount of memory Java requires to 4GB and will allow it to claim This will increase the minimum amount of memory Java requires to 4GB and will allow it to claim
up to 8GB, assuming that much is available. up to 8GB, assuming that much is available.
First, clone the USGS CONUS NSHM repository and checkout the 2018 CONUS NSHM tag. Assuming you First, clone the CONUS NSHM repository. Assuming you are in the current working directory
are in the current working directory (above), the following will create a copy of the model (above), the following will create a copy of the model adjacent to nshmp-haz:
adjacent to nshmp-haz:
```Shell ```Shell
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-conus.git ../../../../nshm-conus git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-conus.git ../../../../nshm-conus
# git checkout tags/5.1.0 -b 2018_CONUS_NSHM
``` ```
TODO: checkout tag for nshm-conus-2018 release (current 5.1.0 tag does not load) To compute hazard for a few sites at 1.0s and 2.0s spectral periods, execute:
To compute hazard for a few sites in the Western U.S. at 1.0s and 2.0s
spectral periods, execute:
```Shell ```Shell
hazard ../../../../nshm-conus sites.geojson config-sites.json hazard ../../../../nshm-conus sites.geojson config-sites.json
......
...@@ -4,7 +4,7 @@ __Working directory:__ `/path/to/nshmp-haz/etc/examples/6-enhanced-output` ...@@ -4,7 +4,7 @@ __Working directory:__ `/path/to/nshmp-haz/etc/examples/6-enhanced-output`
While mean hazard is of broad interest, it can be useful to preserve individual components of a 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 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 2018 NSHM (cloned in the previous each source type and ground motion model (GMM) used in the CONUS NSHM (cloned in the previous
example): example):
```Shell ```Shell
......
...@@ -16,7 +16,7 @@ For this example, the following system alias is helpful: ...@@ -16,7 +16,7 @@ For this example, the following system alias is helpful:
alias rate='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar gov.usgs.earthquake.nshmp.RateCalc' alias rate='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar gov.usgs.earthquake.nshmp.RateCalc'
``` ```
Assuming a copy of the 2018 USGS NSHM is available (see [Example 5](../5-complex-model)), execute: Assuming a copy of the CONUS NSHM is available (see [Example 5](../5-complex-model)), execute:
```Shell ```Shell
rate ../../../../nshm-conus sites.csv config-sites.json rate ../../../../nshm-conus sites.csv config-sites.json
...@@ -41,11 +41,19 @@ __Results directory structure:__ ...@@ -41,11 +41,19 @@ __Results directory structure:__
├─ hazout-rate-sites/ ├─ hazout-rate-sites/
│ ├─ config.json │ ├─ config.json
│ ├─ RateCalc.log │ ├─ RateCalc.log
│ └─ rates.csv │ ├─ rates.csv
│ └─ source/
│ ├─ FAULT/
│ │ └─ probs.csv
│ └─ ...
└─ hazout-prob-map/ └─ hazout-prob-map/
├─ config.json ├─ config.json
├─ RateCalc.log ├─ RateCalc.log
└─ probs.csv └─ probs.csv
└─ source/
├─ FAULT/
│ └─ rates.csv
└─ ...
``` ```
--- ---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment