Merge pull request #210 from pmpowers-usgs/eq-rate-158

EQ rate and probability calculator
usgs · Apr 14, 2017 · 31bdd97 · 31bdd97
2 parents 44d2b87 + f377368
commit 31bdd97
Show file tree

Hide file tree

Showing 87 changed files with 1,891 additions and 611 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,8 @@
 /docs
 /tmp
 curves*/
+eq-prob*/
+eq-rate*/
 Scratch*.java
 nshmp-haz-log*
 /src/META-INF

diff --git a/etc/examples/2-custom-config/config.json b/etc/examples/2-custom-config/config.json
@@ -1,9 +1,9 @@
 {
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_UPPER_ONLY",
     "truncationLevel": 3.0,
     "imts": ["PGA", "SA0P2", "SA1P0"],
-    "valueType": "POISSON_PROBABILITY",
+    "valueFormat": "POISSON_PROBABILITY",
     "customImls": {
       "PGA":   [0.0050, 0.0070, 0.0098, 0.0137, 0.0192, 0.0269, 0.0376, 0.0527, 0.0738, 0.103, 0.145, 0.203, 0.284, 0.397, 0.556, 0.778, 1.09, 1.52, 2.2, 3.3],
       "SA0P2": [0.0050, 0.0075, 0.0113, 0.0169, 0.0253, 0.0380, 0.0570, 0.0854, 0.128, 0.192, 0.288, 0.432, 0.649, 0.973, 1.46, 2.19, 3.28, 4.92, 7.38],

diff --git a/etc/examples/3-sites-file/config.json b/etc/examples/3-sites-file/config.json
@@ -1,5 +1,5 @@
 {
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_UPPER_ONLY",
     "truncationLevel": 3.0,
     "imts": ["PGA", "SA0P2", "SA1P0"],

diff --git a/etc/examples/4-hazard-map/config.json b/etc/examples/4-hazard-map/config.json
@@ -1,5 +1,5 @@
 {
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_UPPER_ONLY",
     "truncationLevel": 3.0,
     "imts": ["PGA", "SA0P2", "SA1P0"]

diff --git a/etc/examples/5-complex-model/config-map.json b/etc/examples/5-complex-model/config-map.json
@@ -1,5 +1,5 @@
 {
-  "curve": {
+  "hazard": {
     "imts": ["SA1P0", "SA2P0"]
   },
   "output": {

diff --git a/etc/examples/5-complex-model/config-sites.json b/etc/examples/5-complex-model/config-sites.json
@@ -1,5 +1,5 @@
 {
-  "curve": {
+  "hazard": {
     "imts": ["SA1P0", "SA2P0"]
   },
   "output": {

diff --git a/etc/examples/6-enhanced-output/config.json b/etc/examples/6-enhanced-output/config.json
@@ -1,6 +1,6 @@
 {
   "output": {
-    "curveTypes": ["TOTAL", "GMM", "SOURCE"],
+    "dataTypes": ["TOTAL", "GMM", "SOURCE"],
     "flushLimit": 1
   }
 }
diff --git a/etc/examples/7-deaggregation/README.md b/etc/examples/7-deaggregation/README.md
@@ -18,3 +18,6 @@ deagg ../../../../nshmp-model-cous-2008/Western\ US sites.geojson 2475 config.js
 The results of the deaggregation are saved to a `deagg` directory along with hazard curves. As with `HazardCalc`, if `GMM` has been specified (as it has in the [config](https://github.com/usgs/nshmp-haz/blob/master/etc/examples/7-deaggregation/config.json) file for this example) additional deaggregation results for each GMM are generated as well.
 
 See the USGS website for more information on [deaggregation](http://geohazards.usgs.gov/deaggint/2008/documentation.php) and the meaning of [epsilon](http://geohazards.usgs.gov/deaggint/2002/documentation/epsilon.php).
+
+#### Next: [Example 8 – Earthquake probabilities and rates](../8-probabilities)
+
diff --git a/etc/examples/7-deaggregation/config.json b/etc/examples/7-deaggregation/config.json
@@ -1,6 +1,6 @@
 {
   "output": {
-    "curveTypes": ["TOTAL", "GMM"],
+    "dataTypes": ["TOTAL", "GMM"],
     "flushLimit": 1
   }
 }
diff --git a/etc/examples/8-probabilities/README.md b/etc/examples/8-probabilities/README.md
@@ -0,0 +1,28 @@
+Example 8: Earthquake probabilities and rates
+---------------------------------------------
+
+__Working directory:__ `/path/to/nshmp-haz/etc/examples/8-probabilities`
+
+`nshmp-haz` can also calculate earthquake probabilities and rates at a location. As with the `HazardCalc` and `DeaggCalc` programs, `RateCalc` takes a model, a site data file or string, and an optional config file, which will control whether the distributions generated are incremental or cumulative, and whether the distribution values are expressed as annual rates or Poisson probabilities. The default (no config supplied) settings are for incremental annual-rates. The `config.rate` elements also specify the cutoff `distance`, within which all sources should be included, and a `timespan` used for conversion to Poisson probabilities.
+
+For this example, the following system alias is helpful:
+
+```Shell
+alias rate='java -Xms1024m -Xmx4096m -cp /path/to/nshmp-haz/dist/nshmp-haz.jar org.opensha2.RateCalc'
+```
+
+Assuming a copy of the 2008 USGS NSHM is available (see [Example 5](../5-complex-model)), execute:
+
+```Shell
+rate ../../../../nshmp-model-cous-2008/Western\ US sites.csv config-sites.json
+```
+
+to generate incremental, annual-rate output for a list of sites, or
+
+```Shell
+rate ../../../../nshmp-model-cous-2008/Western\ US map.geojson config-map.json
+```
+
+to generate a map of cumulative Poisson probabilities (i.e. P ≥ M).
+
+Unless an output directory is specified in a supplied config, output will be placed in either an `eq-rate` or `eq-prob` directory. Like `HazardCalc`, `RateCalc` observes the `config.output.curveTypes` `SOURCE` option and will include a `source` directory with rates or probabilities for all contributing source types.
diff --git a/etc/examples/8-probabilities/config-map.json b/etc/examples/8-probabilities/config-map.json
@@ -0,0 +1,11 @@
+{
+  "output": {
+    "dataTypes": ["SOURCE"]
+  },
+  "rate": {
+    "distance": 10.0,
+    "valueFormat": "POISSON_PROBABILITY",
+    "distributionFormat": "CUMULATIVE",
+    "timespan": 50.0
+  }
+}
diff --git a/etc/examples/8-probabilities/config-sites.json b/etc/examples/8-probabilities/config-sites.json
@@ -0,0 +1,5 @@
+{
+  "output": {
+    "dataTypes": ["SOURCE"]
+  }
+}
diff --git a/etc/examples/8-probabilities/map.geojson b/etc/examples/8-probabilities/map.geojson
@@ -0,0 +1,22 @@
+{
+  "type": "FeatureCollection",
+  "features": [
+    {
+      "type": "Feature",
+      "geometry": {
+        "type": "Polygon",
+        "coordinates": [[
+            [-123.0, 37.0],
+            [-121.0, 37.0],
+            [-121.0, 39.0],
+            [-123.0, 39.0],
+            [-123.0, 37.0]
+          ]]
+      },
+      "properties": {
+        "spacing": 0.2,
+        "title": "San Francisco Bay Area"
+      }
+    }
+  ]
+}
diff --git a/etc/examples/8-probabilities/sites.csv b/etc/examples/8-probabilities/sites.csv
@@ -0,0 +1,14 @@
+name,                  lon,    lat
+Fresno CA,         -119.75,  36.75
+Los Angeles CA,    -118.25,  34.05
+Oakland CA,        -122.25,  37.80
+San Francisco CA,  -122.40,  37.75
+San Jose CA,       -121.90,  37.35
+Santa Rosa CA,     -122.70,  38.45
+Vallejo CA,        -122.25,  38.10
+Las Vegas NV,      -115.15,  36.20
+Reno NV,           -119.80,  39.55
+Eugene OR,         -123.10,  44.05
+Salt Lake City UT, -111.90,  40.75
+Tacoma WA,         -122.45,  47.25
+Jackson WY,        -110.75,  43.50
diff --git a/etc/peer/models/Set1-Case1/config.json b/etc/peer/models/Set1-Case1/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case10-fast/config.json b/etc/peer/models/Set1-Case10-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "POINT",
     "areaGridScaling": "UNIFORM_0P05"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case10/config.json b/etc/peer/models/Set1-Case10/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "POINT",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case11-fast/config.json b/etc/peer/models/Set1-Case11-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "POINT",
     "areaGridScaling": "UNIFORM_0P1"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case11/config.json b/etc/peer/models/Set1-Case11/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "POINT",
     "areaGridScaling": "UNIFORM_0P02"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case2-fast/config.json b/etc/peer/models/Set1-Case2-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case2/config.json b/etc/peer/models/Set1-Case2/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case3-fast/config.json b/etc/peer/models/Set1-Case3-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case3/config.json b/etc/peer/models/Set1-Case3/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case4-fast/config.json b/etc/peer/models/Set1-Case4-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case4/config.json b/etc/peer/models/Set1-Case4/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case5-fast/config.json b/etc/peer/models/Set1-Case5-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case5/config.json b/etc/peer/models/Set1-Case5/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case6-fast/config.json b/etc/peer/models/Set1-Case6-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case6/config.json b/etc/peer/models/Set1-Case6/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case7-fast/config.json b/etc/peer/models/Set1-Case7-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case7/config.json b/etc/peer/models/Set1-Case7/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "NONE",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case8a/config.json b/etc/peer/models/Set1-Case8a/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set1-Case8b/config.json b/etc/peer/models/Set1-Case8b/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_UPPER_ONLY",
     "truncationLevel": 2.0,
     "imts": ["PGA"],

diff --git a/etc/peer/models/Set1-Case8c/config.json b/etc/peer/models/Set1-Case8c/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_UPPER_ONLY",
     "truncationLevel": 3.0,
     "imts": ["PGA"],

diff --git a/etc/peer/models/Set2-Case1/config.json b/etc/peer/models/Set2-Case1/config.json
@@ -4,7 +4,7 @@
     "ruptureFloating": "ON",
     "pointSourceType": "POINT"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set2-Case2a-fast/config.json b/etc/peer/models/Set2-Case2a-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set2-Case2a/config.json b/etc/peer/models/Set2-Case2a/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set2-Case2b-fast/config.json b/etc/peer/models/Set2-Case2b-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set2-Case2b/config.json b/etc/peer/models/Set2-Case2b/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set2-Case2c-fast/config.json b/etc/peer/models/Set2-Case2c-fast/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]

diff --git a/etc/peer/models/Set2-Case2c/config.json b/etc/peer/models/Set2-Case2c/config.json
@@ -7,7 +7,7 @@
     "pointSourceType": "FINITE",
     "areaGridScaling": "UNIFORM_0P01"
   },
-  "curve": {
+  "hazard": {
     "exceedanceModel": "TRUNCATION_OFF",
     "imts": ["PGA"],
     "defaultImls": [0.001, 0.01, 0.05, 0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45, 0.5, 0.55, 0.6, 0.7, 0.8, 0.9, 1.0]