Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
nshmp-haz
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ghsc
National Seismic Hazard Model Project
nshmp-haz
Commits
22b32391
Commit
22b32391
authored
2 years ago
by
Clayton, Brandon Scott
Browse files
Options
Downloads
Patches
Plain Diff
fix docs
parent
93fcc63a
No related branches found
Branches containing commit
No related tags found
Tags containing commit
2 merge requests
!619
Production Release | nshmp-haz
,
!617
push docker images
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/pages/Building-&-Running.md
+13
-14
13 additions, 14 deletions
docs/pages/Building-&-Running.md
docs/pages/Web-Services.md
+7
-7
7 additions, 7 deletions
docs/pages/Web-Services.md
with
20 additions
and
21 deletions
docs/pages/Building-&-Running.md
+
13
−
14
View file @
22b32391
...
@@ -73,11 +73,11 @@ files. Disaggregations also have some independent
...
@@ -73,11 +73,11 @@ files. Disaggregations also have some independent
## Run with [Docker](https://docs.docker.com/install/)
## Run with [Docker](https://docs.docker.com/install/)
nshmp-haz is available as a public image from the
nshmp-haz is available as a public image from
[
Docker hub
](
https://hub.docker.com/r/usgs/nshmp-haz
)
[
container registry
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/container_registry
)
with tags:
with tags:
*
`latest`
: Refers to the latest updates from the main or production branch
*
`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
*
`staging-latest`
: Latest updates associated with the
[
main
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main
)
branch
[
main
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main
)
branch
*
`production-latest`
: Latest stable release associated with the
*
`production-latest`
: Latest stable release associated with the
...
@@ -108,13 +108,12 @@ to a minimum of 4 GB.
...
@@ -108,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
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
Git, Java, or other dependencies besides Docker. A public image is available
from this repository's
from
[
Docker hub
](
https://hub.docker.com/r/usgs/nshmp-haz
)
[
container registry
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/container_registry
)
.
which can be run with:
which can be run with:
```
bash
```
bash
# Pull docker image
# 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
# Run docker image
docker run
\
docker run
\
...
@@ -124,7 +123,7 @@ docker run \
...
@@ -124,7 +123,7 @@ docker run \
--volume
/absolute/path/to/sites/file:/app/sites.<geojson | csv>
\
--volume
/absolute/path/to/sites/file:/app/sites.<geojson | csv>
\
--volume
/absolute/path/to/config/file:/app/config.json
\
--volume
/absolute/path/to/config/file:/app/config.json
\
--volume
/absolute/path/to/output:/app/output
\
--volume
/absolute/path/to/output:/app/output
\
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz-ws
usgs/nshmp-haz
```
```
Where:
Where:
...
@@ -157,7 +156,7 @@ assumption a GeoJSON [site](./Site-Specification.md) file exists named `sites.ge
...
@@ -157,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
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-hawaii.git
# Pull image
# 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
# Run nshmp-haz HazardCalc
docker run
\
docker run
\
...
@@ -165,7 +164,7 @@ docker run \
...
@@ -165,7 +164,7 @@ docker run \
--volume
"
$(
pwd
)
/nshm-hawaii:/app/model"
\
--volume
"
$(
pwd
)
/nshm-hawaii:/app/model"
\
--volume
"
$(
pwd
)
/sites.geojson"
\
--volume
"
$(
pwd
)
/sites.geojson"
\
--volume
"
$(
pwd
)
/hawaii-hazard-output:/app/output"
\
--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
#### [`DisaggCalc`](../../src/main/java/gov/usgs/earthquake/nshmp/DisaggCalc.java) Example
...
@@ -179,7 +178,7 @@ assumption a GeoJSON [site](./Site-Specification.md) file exists named `sites.ge
...
@@ -179,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
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-hawaii.git
# Pull image
# 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
# Run nshmp-haz DisaggCalc
docker run
\
docker run
\
...
@@ -188,7 +187,7 @@ docker run \
...
@@ -188,7 +187,7 @@ docker run \
--volume
"
$(
pwd
)
/nshm-hawaii:/app/model"
\
--volume
"
$(
pwd
)
/nshm-hawaii:/app/model"
\
--volume
"
$(
pwd
)
/sites.geojson"
\
--volume
"
$(
pwd
)
/sites.geojson"
\
--volume
"
$(
pwd
)
/hawaii-disagg-output:/app/output"
\
--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
#### [`RateCalc`](../../src/main/java/gov/usgs/earthquake/nshmp/RateCalc.java) Example
...
@@ -202,7 +201,7 @@ assumption a GeoJSON [site](./Site-Specification.md) file exists named `sites.ge
...
@@ -202,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
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-hawaii.git
# Pull image
# 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
# Run nshmp-haz RateCalc
docker run
\
docker run
\
...
@@ -210,7 +209,7 @@ docker run \
...
@@ -210,7 +209,7 @@ docker run \
--volume
"
$(
pwd
)
/nshm-hawaii:/app/model"
\
--volume
"
$(
pwd
)
/nshm-hawaii:/app/model"
\
--volume
"
$(
pwd
)
/sites.geojson"
\
--volume
"
$(
pwd
)
/sites.geojson"
\
--volume
"
$(
pwd
)
/hawaii-rate-output:/app/output"
\
--volume
"
$(
pwd
)
/hawaii-rate-output:/app/output"
\
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz
usgs
/nshmp-haz
```
```
### Run Customization
### Run Customization
...
@@ -222,13 +221,13 @@ be set with the environment flag (-e, -env):
...
@@ -222,13 +221,13 @@ be set with the environment flag (-e, -env):
docker run
\
docker run
\
--env
JAVA_MEMORY
=
<MEMORY>
\
--env
JAVA_MEMORY
=
<MEMORY>
\
...
...
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz
usgs
/nshmp-haz
# Example
# Example
docker run
\
docker run
\
--env
JAVA_MEMORY
=
"12g"
\
--env
JAVA_MEMORY
=
"12g"
\
...
...
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz
usgs
/nshmp-haz
```
```
Where:
Where:
...
...
This diff is collapsed.
Click to expand it.
docs/pages/Web-Services.md
+
7
−
7
View file @
22b32391
...
@@ -119,12 +119,12 @@ Open browser to [http://localhost:8080/](http://localhost:8080/).
...
@@ -119,12 +119,12 @@ Open browser to [http://localhost:8080/](http://localhost:8080/).
### Run from Container Registry
### Run from Container Registry
A public Docker image is avaialable from this repository's
A public Docker image is avaialable from
[
Docker hub
](
https://hub.docker.com/r/usgs/nshmp-haz-ws
)
.
[
container registry
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/container_registry
)
.
There are
3
main tags:
There are
4
main tags:
*
`latest`
: Refers to the latest updates from the main or production branch
*
`latest`
: Refers to the latest updates from the main or production branch
*
`development-latest`
: Refers to forks of the repository.
*
`staging-latest`
: Refers to the
*
`staging-latest`
: Refers to the
[
main
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main
)
branch and is the latest updates
[
main
](
https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main
)
branch and is the latest updates
*
`production-latest`
: Refers to the
*
`production-latest`
: Refers to the
...
@@ -132,10 +132,10 @@ There are 3 main tags:
...
@@ -132,10 +132,10 @@ There are 3 main tags:
```
bash
```
bash
# Pull image
# Pull image
docker pull
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz-ws:latest
docker pull
usgs
/nshmp-haz-ws:latest
# Run
# Run
docker run
-p
8080:8080
-v
"/path/to/model:/model"
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz-ws
docker run
-p
8080:8080
-v
"/path/to/model:/model"
usgs
/nshmp-haz-ws
```
```
Web service runs on
[
http://localhost:8080/
](
http://localhost:8080/
)
Web service runs on
[
http://localhost:8080/
](
http://localhost:8080/
)
...
@@ -146,14 +146,14 @@ The hazard model is read in via Docker volumes.
...
@@ -146,14 +146,14 @@ The hazard model is read in via Docker volumes.
```
bash
```
bash
# Pull image
# Pull image
docker pull
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz-ws:latest
docker pull
usgs
/nshmp-haz-ws:latest
# Download NSHM CONUS
# Download NSHM CONUS
cd
..
cd
..
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-conus
git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-conus
# Run web services
# Run web services
docker run
-p
8080:8080
-v
"
$(
pwd
)
:/model"
code.usgs.gov:5001/ghsc/nshmp/nshmp-haz
/nshmp-haz-ws
docker run
-p
8080:8080
-v
"
$(
pwd
)
:/model"
usgs
/nshmp-haz-ws
```
```
Open browser to
[
http://localhost:8080/
](
http://localhost:8080/
)
.
Open browser to
[
http://localhost:8080/
](
http://localhost:8080/
)
.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment