Skip to content
Snippets Groups Projects

Production Release | nshmp-haz

Merged Clayton, Brandon Scott requested to merge main into production
8 files
+ 77
51
Compare changes
  • Side-by-side
  • Inline
Files
8
@@ -6,8 +6,7 @@
* [Developer Basics](./Developer-Basics.md#developer-basics)
* [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration)
* [Site Specification](./Site-Specification.md#site-specification)
* [Examples](../../etc/examples) (or
[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main/etc/examples))
* [Examples](../../etc/examples)
* [Web Services](./Web-Services.md)
## Build & Run Options
@@ -74,11 +73,11 @@ files. Disaggregations also have some independent
## Run with [Docker](https://docs.docker.com/install/)
nshmp-haz is available as a public image from the
[container registry](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/container_registry)
nshmp-haz is available as a public image from [Docker hub](https://hub.docker.com/r/usgs/nshmp-haz)
with tags:
* `latest`: Refers to the latest updates from the main or production branch
* `development-latest`: Refers to forks of the repository.
* `staging-latest`: Latest updates associated with the
[main](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main) branch
* `production-latest`: Latest stable release associated with the
@@ -109,13 +108,12 @@ to a minimum of 4 GB.
The *nshmp-haz* application may be run as a Docker container which mitigates the need to install
Git, Java, or other dependencies besides Docker. A public image is available
from this repository's
[container registry](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/container_registry).
from [Docker hub](https://hub.docker.com/r/usgs/nshmp-haz)
which can be run with:
```bash
# Pull docker image
docker pull code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz:latest
docker pull usgs/nshmp-haz:latest
# Run docker image
docker run \
@@ -125,7 +123,7 @@ docker run \
--volume /absolute/path/to/sites/file:/app/sites.<geojson | csv> \
--volume /absolute/path/to/config/file:/app/config.json \
--volume /absolute/path/to/output:/app/output \
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz-ws
usgs/nshmp-haz
```
Where:
@@ -158,7 +156,7 @@ assumption a GeoJSON [site](./Site-Specification.md) file exists named `sites.ge
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-hawaii.git
# Pull image
docker pull code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz:latest
docker pull usgs/nshmp-haz:latest
# Run nshmp-haz HazardCalc
docker run \
@@ -166,7 +164,7 @@ docker run \
--volume "$(pwd)/nshm-hawaii:/app/model" \
--volume "$(pwd)/sites.geojson" \
--volume "$(pwd)/hawaii-hazard-output:/app/output" \
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz
usgs/nshmp-haz
```
#### [`DisaggCalc`](../../src/main/java/gov/usgs/earthquake/nshmp/DisaggCalc.java) Example
@@ -180,7 +178,7 @@ assumption a GeoJSON [site](./Site-Specification.md) file exists named `sites.ge
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-hawaii.git
# Pull image
docker pull code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz:latest
docker pull usgs/nshmp-haz:latest
# Run nshmp-haz DisaggCalc
docker run \
@@ -189,7 +187,7 @@ docker run \
--volume "$(pwd)/nshm-hawaii:/app/model" \
--volume "$(pwd)/sites.geojson" \
--volume "$(pwd)/hawaii-disagg-output:/app/output" \
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz:latest
usgs/nshmp-haz:latest
```
#### [`RateCalc`](../../src/main/java/gov/usgs/earthquake/nshmp/RateCalc.java) Example
@@ -203,7 +201,7 @@ assumption a GeoJSON [site](./Site-Specification.md) file exists named `sites.ge
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-hawaii.git
# Pull image
docker pull code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz:latest
docker pull usgs/nshmp-haz:latest
# Run nshmp-haz RateCalc
docker run \
@@ -211,7 +209,7 @@ docker run \
--volume "$(pwd)/nshm-hawaii:/app/model" \
--volume "$(pwd)/sites.geojson" \
--volume "$(pwd)/hawaii-rate-output:/app/output" \
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz
usgs/nshmp-haz
```
### Run Customization
@@ -223,13 +221,13 @@ be set with the environment flag (-e, -env):
docker run \
--env JAVA_MEMORY=<MEMORY> \
...
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz
usgs/nshmp-haz
# Example
docker run \
--env JAVA_MEMORY="12g" \
...
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz
usgs/nshmp-haz
```
Where:
Loading