diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md index 02e22aa93665ed6634cb14e51497862c590106c9..64a04b86e3bd56b2dc2cbd124c8c0752d0a381f1 100644 --- a/docs/pages/Building-&-Running.md +++ b/docs/pages/Building-&-Running.md @@ -73,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 @@ -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 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 \ @@ -124,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: @@ -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 # 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 \ @@ -165,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 @@ -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 # 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 \ @@ -188,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 @@ -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 # 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 \ @@ -210,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 @@ -222,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: diff --git a/docs/pages/Web-Services.md b/docs/pages/Web-Services.md index 3076ca1dbf115e770cb9ec0e4793b87533c32412..bbfa9ced8fc80eb4b00083aa0a9ef0c682bbe76b 100644 --- a/docs/pages/Web-Services.md +++ b/docs/pages/Web-Services.md @@ -119,12 +119,12 @@ Open browser to [http://localhost:8080/](http://localhost:8080/). ### Run from Container Registry -A public Docker image is avaialable from this repository's -[container registry](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/container_registry). +A public Docker image is avaialable from [Docker hub](https://hub.docker.com/r/usgs/nshmp-haz-ws). -There are 3 main tags: +There are 4 main tags: * `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 [main](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main) branch and is the latest updates * `production-latest`: Refers to the @@ -132,10 +132,10 @@ There are 3 main tags: ```bash # Pull image -docker pull code.usgs.gov:5001/ghsc/nshmp/nshmp-haz/nshmp-haz-ws:latest +docker pull usgs/nshmp-haz-ws:latest # 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/) @@ -146,14 +146,14 @@ The hazard model is read in via Docker volumes. ```bash # 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 cd .. git clone https://code.usgs.gov/ghsc/nshmp/nshms/nshm-conus # 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/).