Skip to content
Snippets Groups Projects
Commit d16f7480 authored by Powers, Peter M.'s avatar Powers, Peter M.
Browse files

example readme fixes

parent e4ed979f
No related branches found
No related tags found
2 merge requests!593Production Release | nshm-haz,!591Code review 479
This commit is part of merge request !591. Comments created here will be created in the context of that merge request.
......@@ -24,7 +24,7 @@ __Results directory structure:__
```text
3-sites-file/
└─ hazout/
├─ config.json
├─ calc-config.json
├─ HazardCalc.log
├─ PGA/
│ ├─ curves.csv
......
......@@ -16,14 +16,20 @@ __Results directory structure:__
```text
4-hazard-map/
└─ hazout/
├─ config.json
├─ calc-config.json
├─ HazardCalc.log
├─ PGA/
│ └─ curves.csv
│ ├─ curves.csv
│ ├─ curves-truncated.csv
│ └─ map.csv
├─ SA0P2/
│ └─ curves.csv
│ ├─ curves.csv
│ ├─ curves-truncated.csv
│ └─ map.csv
└─ SA1P0/
└─ curves.csv
├─ curves.csv
├─ curves-truncated.csv
└─ map.csv
```
<!-- markdownlint-disable MD001 -->
......
......@@ -47,20 +47,28 @@ __Results directory structure:__
```text
5-complex-model/
├─ hazout-sites/
│ ├─ config.json
│ ├─ calc-config.json
│ ├─ HazardCalc.log
│ ├─ SA1P0/
│ │ └─ curves.csv
│ │ ├─ curves.csv
│ │ ├─ curves-truncated.csv
│ │ └─ map.csv
│ └─ SA2P0/
│ └─ curves.csv
│ ├─ curves.csv
│ ├─ curves-truncated.csv
│ └─ map.csv
└─ hazout-map/
├─ config.json
├─ calc-config.json
├─ HazardCalc.log
├─ SA1P0/
│ └─ curves.csv
│ ├─ curves.csv
│ ├─ curves-truncated.csv
│ └─ map.csv
└─ SA2P0/
└─ curves.csv
├─ curves.csv
├─ curves-truncated.csv
└─ map.csv
```
<!-- markdownlint-disable MD001 -->
......
......@@ -31,7 +31,7 @@ __Results directory structure:__
```text
6-enhanced-output/
└─ hazout/
├─ config.json
├─ calc-config.json
├─ HazardCalc.log
├─ PGA/
│ ├─ curves-truncated.csv
......
......@@ -3,77 +3,54 @@
__Working directory:__ `/path/to/nshmp-haz/etc/examples/7-disaggregation`
To perform a disaggregation of hazard, one must use the program `DisaggCalc`. Internally,
`DisaggCalc` calls `HazardCalc` and then reprocesses the data to generate a comma-delimited
file of distance, magnitude, and epsilon bins, and a text file of summary statistics and primary
contributing sources. For this, it can be helpful to create a second system alias:
`DisaggCalc` calls `HazardCalc` and then reprocesses the data to generate output files of
disaggregation summary statistics and primary contributing sources. For this, it can be helpful
to create a second system alias:
```Shell
alias disagg='java -Xms4g -Xmx8g -cp /path/to/nshmp-haz/build/libs/nshmp-haz.jar gov.usgs.earthquake.nshmp.DisaggCalc'
```
`DisaggCalc` is similar to `HazardCalc` in every way except that the return-period of interest
must be specified. For example, execute:
The command line arguments for `DisaggCalc` are the same as those for `HazardCalc`. The target
return period for a disaggregation is specified in the config
[`disagg.returnPeriod`](../../../docs/pages/Calculation-Configuration.md#calculation-configuration-parameters)
field. For compute the disaggregation in this example, execute:
```Shell
disagg ../../../../nshm-conus sites.geojson 2475 config.json
disagg ../../../../nshm-conus sites.csv config.json
```
The results of the disaggregation are saved along with hazard curves in `disagg` directories.
As with `HazardCalc`, if the `GMM` data type has been specified (as it has in the
The results of the disaggregation are saved alongside hazard curves in a `disagg` directory.
Disaggregation results are stored in JSON format with one file for each site. The results for
each IMT are stored within that file as well. As with `HazardCalc`, if the `GMM` data type has
been specified (as it has in the
[config](../../../docs/pages/Calculation-Configuration.md#calculation-configuration)
file for this example) additional disaggregation results for each GMM are generated as well.
Disaggregations by individual `SOURCE` type are also possible.
Note that `DisaggCalc` will only process a CSV file of sites (not GeoJSON).
__Results directory structure:__
```text
7-disaggregation/
└─ hazout/
├─ config.json
├─ calc-config.json
├─ DisaggCalc.log
├─ disagg/Los Angeles CA.json
│ ├─ Los Angeles CA.json
│ ├─ Salt Lake City UT.json
│ ├─ San Francisco CA.json
│ └─ Seattle WA.json
├─ PGA/
│ ├─ curves-truncated.csv
│ ├─ curves.csv
│ ├─ disagg/
│ │ ├─ Los Angeles CA/
│ │ │ ├─ data.csv
│ │ │ └─ summary.txt
│ │ ├─ Salt Lake City UT/
│ │ │ ├─ data.csv
│ │ │ └─ summary.txt
│ │ ├─ San Francisco CA/
│ │ │ ├─ data.csv
│ │ │ └─ summary.txt
│ │ └─ Seattle WA/
│ │ ├─ data.csv
│ │ └─ summary.txt
│ └─ gmm/
│ ├─ AM_09_INTERFACE_BASIN/
│ │ ├─ curves.csv
│ │ └─ disagg/
│ │ ├─ San Francisco CA/
│ │ │ ├─ data.csv
│ │ │ └─ summary.txt
│ │ └─ Seattle WA/
│ │ ├─ data.csv
│ │ └─ summary.txt
│ │ └─ curves.csv
│ ├─ ...
│ ├─ CB_14_BASIN/
│ │ ├─ curves.csv
│ │ └─ disagg/
│ │ ├─ Los Angeles CA/
│ │ │ ├─ data.csv
│ │ │ └─ dsummary.txt
│ │ ├─ Salt Lake City UT/
│ │ │ ├─ data.csv
│ │ │ └─ summary.txt
│ │ ├─ San Francisco CA/
│ │ │ ├─ data.csv
│ │ │ └─ summary.txt
│ │ └─ Seattle WA/
│ │ ├─ data.csv
│ │ └─ summary.txt
│ └─ ...
│ └─ ZHAO_06_SLAB_BASIN/
│ └─ curves.csv
├─ SA0P1/
│ └─ ...
└─ ...
......
name, lon, lat
Los Angeles CA, -118.25, 34.05
San Francisco CA, -122.40, 37.75
Seattle WA, -122.30, 47.60
Salt Lake City UT, -111.90, 40.75
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-118.25, 34.05]
},
"properties": {
"marker-size": "small",
"marker-color": "#ff0080",
"title": "Los Angeles CA"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.40, 37.75]
},
"properties": {
"marker-size": "small",
"marker-color": "#ff0080",
"title": "San Francisco CA"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.30, 47.60]
},
"properties": {
"marker-size": "small",
"marker-color": "#ff0080",
"title": "Seattle WA"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-111.90, 40.75]
},
"properties": {
"marker-size": "small",
"marker-color": "#ff0080",
"title": "Salt Lake City UT"
}
}
]
}
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