From 0780c5aa6efbecb2342351f423571ff3ad128df1 Mon Sep 17 00:00:00 2001 From: Jason Altekruse <jaltekruse@usgs.gov> Date: Mon, 26 Jul 2021 11:06:31 -0600 Subject: [PATCH] update haz-v2 to haz --- docs/README.md | 10 +++++----- docs/pages/Building-&-Running.md | 20 ++++++++++---------- docs/pages/Calculation-Configuration.md | 2 +- docs/pages/Developer-Basics.md | 4 ++-- docs/pages/Ground-Motion-Models.md | 4 ++-- docs/pages/Logic-Trees-&-Uncertainty.md | 2 +- docs/pages/Model-Editions.md | 2 +- docs/pages/Model-Files.md | 2 +- docs/pages/Site-Specification.md | 14 +++++++------- docs/pages/Source-Types.md | 6 +++--- docs/pages/USGS-Models.md | 2 +- 11 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/README.md b/docs/README.md index b1343c3bf..a528bb23d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,14 @@ # Documentation: nshmp-haz -***nshmp-haz-v2*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack +***nshmp-haz*** is a U.S. Geological Survey ([USGS](https://www.usgs.gov)) developed software stack that supports probabilistic seismic hazard (PSHA) and related analyses. It is maintained by the National Seismic Hazard Model Project ([NSHMP](https://earthquake.usgs.gov/hazards/)) within the USGS's earthquake hazards program ([EHP](http://earthquake.usgs.gov)). -*nshmp-haz-v2* supports high performance seismic hazard calculations required to generate detailed +*nshmp-haz* supports high performance seismic hazard calculations required to generate detailed maps over large areas and supports a variety of USGS web services and applications related to seismic hazards research and the dissemination of hazard data. This documentation explains how -to use *nshmp-haz-v2* as well as underlying model implementation details. +to use *nshmp-haz* as well as underlying model implementation details. ## Table of Contents @@ -18,7 +18,7 @@ to use *nshmp-haz-v2* as well as underlying model implementation details. * [Calculation Configuration](./pages/Calculation-Configuration.md) * [Site Specification](./pages/Site-Specification.md) * [Examples](../../etc/examples/README.md) (or - [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)) + [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)) * [Hazard Model](./pages/Hazard-Model.md) * [Model Structure](./pages/Model-Structure.md) * [Model Files](./pages/Model-Files.md) @@ -35,7 +35,7 @@ to use *nshmp-haz-v2* as well as underlying model implementation details. * [nshmp-lib](https://code.usgs.gov/ghsc/nshmp/nshmp-lib): USGS hazard modeling library * [nshmp-lib JavaDocs](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/) -* [*nshmp-haz-v2* License](../LICENSE.md) +* [*nshmp-haz* License](../LICENSE.md) ## References diff --git a/docs/pages/Building-&-Running.md b/docs/pages/Building-&-Running.md index 6735ae1d7..4a4d7d1ef 100644 --- a/docs/pages/Building-&-Running.md +++ b/docs/pages/Building-&-Running.md @@ -7,7 +7,7 @@ * [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration) * [Site Specification](./Site-Specification.md#site-specification) * [Examples](../../etc/examples/README.md) (or - [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)) + [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)) ## Build & Run Options @@ -16,12 +16,12 @@ ## Build and Run Locally -Building and running *nshmp-haz-v2* requires prior installation of Git and Java. Please see the +Building and running *nshmp-haz* requires prior installation of Git and Java. Please see the [developer basics](./Developer-Basics.md) page for system configuration guidance. ### Building -Navigate to a location on your system where you want *nshmp-haz-v2* code to reside, clone the +Navigate to a location on your system where you want *nshmp-haz* code to reside, clone the repository, and compile: ```bash @@ -54,7 +54,7 @@ be supplied as a third argument. It can be used to override any calculation sett [default](./Calculation-Configuration.md) values are used. See the [examples](../../etc/examples/README.md) directory for more details (or -[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)) +[on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)) ### Computing Disaggregations @@ -72,7 +72,7 @@ files. Disaggregations also have some independent ## Run with [Docker](https://docs.docker.com/install/) -To ensure you are have the latest *nshmp-haz-v2* update, always first pull the image from Docker: +To ensure you are have the latest *nshmp-haz* update, always first pull the image from Docker: ```bash docker pull usgs/nshmp-haz @@ -80,18 +80,18 @@ docker pull usgs/nshmp-haz ### Docker Memory on Mac -By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *nshmp-haz-v2*, the +By default, Docker Desktop for Mac is set to use 2 GB runtime memory. To run *nshmp-haz*, the memory available to Docker must be [increased](https://docs.docker.com/docker-for-mac/#advanced) to a minimum of 4 GB. ### Run in Docker -TODO: Docker scripts currently only get models from github (XML models), so nshmp-haz-v2 run fails -to parse the models (CONUS_2018 or HAWAII_2021), need to at least update `nshmp-haz-v2/scripts/docker-functions.inc.sh`. +TODO: Docker scripts currently only get models from github (XML models), so nshmp-haz run fails +to parse the models (CONUS_2018 or HAWAII_2021), need to at least update `nshmp-haz/scripts/docker-functions.inc.sh`. TODO: Model identifiers need to be synced between here and the docker scripts (e.g. `HI-2020` vs `HAWAII_2021`). -The *nshmp-haz-v2* 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 on Docker hub at [https://hub.docker.com/r/usgs/nshmp-haz](https://hub.docker.com/r/usgs/nshmp-haz) which can be run with: @@ -140,7 +140,7 @@ Where: ### Run Customization -When running *nshmp-haz-v2* with Docker the initial (Xms) and maximum (Xmx) JVM memory sizes can +When running *nshmp-haz* with Docker the initial (Xms) and maximum (Xmx) JVM memory sizes can be set with the environment flag (-e, -env): ```bash diff --git a/docs/pages/Calculation-Configuration.md b/docs/pages/Calculation-Configuration.md index c3d9150dc..9175a1c6a 100644 --- a/docs/pages/Calculation-Configuration.md +++ b/docs/pages/Calculation-Configuration.md @@ -108,7 +108,7 @@ T ≤ 10 s | 0.000333, 0.000499, 0.000749, 0.00112, 0.00169, 0.00253, <br>0.00 * [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration) * [Site Specification](./Site-Specification.md#site-specification) * [Examples](../../etc/examples/README.md) (or - [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)) + [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)) * [**Documentation Index**](../README.md) --- diff --git a/docs/pages/Developer-Basics.md b/docs/pages/Developer-Basics.md index fe7229242..d83e75564 100644 --- a/docs/pages/Developer-Basics.md +++ b/docs/pages/Developer-Basics.md @@ -53,7 +53,7 @@ git clone https://code.usgs.gov/ghsc/nshmp/nshmp-haz.git ## Eclipse Integration (Optional) Eclipse provides automatic compilation, syntax highlighting, and integration with Git, among -other useful features. To build or modify *nshmp-haz-v2* using [Eclipse](http://www.eclipse.org/), +other useful features. To build or modify *nshmp-haz* using [Eclipse](http://www.eclipse.org/), install the [Eclipse IDE for Java Developers](https://www.eclipse.org/downloads/packages/) or [Eclipse IDE for Enterprise Java and Web Developers](https://www.eclipse.org/downloads/packages/), if you plan on developing web services. Import the project into Eclipse: `File > Import > @@ -68,7 +68,7 @@ Gradle > Existing Gradle Project` * [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration) * [Site Specification](./Site-Specification.md#site-specification) * [Examples](../../etc/examples/README.md) (or - [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)) + [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)) * [**Documentation Index**](../README.md) --- diff --git a/docs/pages/Ground-Motion-Models.md b/docs/pages/Ground-Motion-Models.md index 2c1cb73c7..f3b323def 100644 --- a/docs/pages/Ground-Motion-Models.md +++ b/docs/pages/Ground-Motion-Models.md @@ -43,7 +43,7 @@ The following sample `gmm-config.json` file applies the NGA-West 2 epistemic unc ## GMM Uncertainty Models -*nshmp-haz-v2* supports additional epistemic uncertainty models derived from the PEER NGA-West 1 +*nshmp-haz* supports additional epistemic uncertainty models derived from the PEER NGA-West 1 and PEER NGA-West 2 projects. These models both have factors for distance (`Rrup`) bins Rrup < 10 km, 10 km <= Rrup, < 30 km, and 30 km <= Rrup, and for magnitude bins M < 6.0, 6.0 <= M < 7.0, and 7.0 <= M. These models can be applied within the `gmm-config.json` file as shown in @@ -61,7 +61,7 @@ GMMs to modify model output. ## GMMs By Tectonic Setting -GMMs available in *nshmp-haz-v2* are tabulated by tectonic setting below. See the javadocs for the +GMMs available in *nshmp-haz* are tabulated by tectonic setting below. See the javadocs for the [GMM Package](https://earthquake.usgs.gov/nshmp/docs/nshmp-lib/gov/usgs/earthquake/nshmp/gmm/package-summary.html) for implementation details of each GMM and comprehensive lists of GMM IDs. diff --git a/docs/pages/Logic-Trees-&-Uncertainty.md b/docs/pages/Logic-Trees-&-Uncertainty.md index 093ac1981..a0bdaa6a7 100644 --- a/docs/pages/Logic-Trees-&-Uncertainty.md +++ b/docs/pages/Logic-Trees-&-Uncertainty.md @@ -1,7 +1,7 @@ # USGS Models: Logic Trees & Uncertainty The following page details the logic trees of epistemic uncertainty considered in NSHMs supported -by *nshmp-haz-v2*. Logic trees are represented in a NSHM using files ending in `-tree.json`. +by *nshmp-haz*. Logic trees are represented in a NSHM using files ending in `-tree.json`. [[_TOC_]] diff --git a/docs/pages/Model-Editions.md b/docs/pages/Model-Editions.md index 44dba3c5b..0558f9ee9 100644 --- a/docs/pages/Model-Editions.md +++ b/docs/pages/Model-Editions.md @@ -7,7 +7,7 @@ data, or modeling procedures that warrant a model update. Every model the USGS p associated with a USGS Open-File report or refereed journal article and supporting datasets. However, layered on top of any given model release are bug-fixes and model improvements. -With the update to a new codebase, [nshmp-haz-v2](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2), +With the update to a new codebase, [nshmp-haz](https://code.usgs.gov/ghsc/nshmp/nshmp-haz), the NSHMP has adopted [semantic versioning](http://semver.org) to keep track of different hazard models. For any given model region, the first number (or major version) corresponds to a particular release or update year. For example, we consider the initial diff --git a/docs/pages/Model-Files.md b/docs/pages/Model-Files.md index d78797edd..3ce594a23 100644 --- a/docs/pages/Model-Files.md +++ b/docs/pages/Model-Files.md @@ -113,7 +113,7 @@ For example: ``` See the [ground motion models](./Ground-Motion-Models.md) page for details on GMMs supported in -_nshmp-haz-v2_ and the related `gmm-config.json` files that governs GMM behavior. +_nshmp-haz_ and the related `gmm-config.json` files that governs GMM behavior. ### MFD Logic Trees diff --git a/docs/pages/Site-Specification.md b/docs/pages/Site-Specification.md index fca0e1068..e057616e8 100644 --- a/docs/pages/Site-Specification.md +++ b/docs/pages/Site-Specification.md @@ -4,14 +4,14 @@ The sites at which to perform hazard and related calculations may be defined in ways. Examples of the file formats described below are available in the resource directory: [`etc/nshm`](../../etc/nshm/README.md). -__Note on Coordinates:__ *nshmp-haz-v2* supports longitude and latitude values in the closed +__Note on Coordinates:__ *nshmp-haz* supports longitude and latitude values in the closed ranges `[-360° ‥ 360°]` and `[-90° ‥ 90°]`. Note, however, that mixing site and/or source coordinates across the antimeridian (the -180° to 180° transition) will yield unexpected results. For Pacific models and calculations, always use positive or negative longitudes exclusively. ## Site String -For the case of running a single site of interest, most *nshmp-haz-v2* programs accept a +For the case of running a single site of interest, most *nshmp-haz* programs accept a comma-delimited string of the form: `name,lon,lat[,vs30,vsInf[,z1p0,z2p5]]`, where `vs30`, `vsInf`, `z1p0`, and `z2p5` are optional. Note that if `vs30` is supplied, so too must `vsInf`. Likewise if `z1p0` is supplied, so too must `z2p5`. If the string contains any spaces, escape them or wrap the @@ -45,7 +45,7 @@ it's 'default' basin depth scale factor. ## GeoJSON Format (\*.geojson) Although more verbose than the comma-delimited format, [GeoJSON](http://geojson.org) is a more -versatile format for encoding geographic data. *nshmp-haz-v2* uses GeoJSON for both lists of sites +versatile format for encoding geographic data. *nshmp-haz* uses GeoJSON for both lists of sites and to define map regions. If you encounter problems when formatting JSON files, use [JSONLint](http://jsonlint.com) or [GeoJSONLint](http://geojsonlint.com) for validation. @@ -77,7 +77,7 @@ A site list is expected as a `FeatureCollection` of `Point` features. For exampl As with the CSV format, the minimum required data is a `geometry` `coordinates` array. All `properties` are optional. When using GeoJSON, the `title` property maps to the name of the site. -Additional properties, if present, are ignored by *nshmp-haz-v2* but permitted as they may be +Additional properties, if present, are ignored by *nshmp-haz* but permitted as they may be relevant for other applications. For example, [styling properties](https://help.github.com/articles/mapping-geojson-files-on-github/#styling-features) may be used to improve rendering in mapping applications. For a fully fledged example, see the @@ -85,11 +85,11 @@ may be used to improve rendering in mapping applications. For a fully fledged ex ### Map Regions -GeoJSON is also used to define *nshmp-haz-v2* map regions. For example, see the file that defines a +GeoJSON is also used to define *nshmp-haz* map regions. For example, see the file that defines a region commonly used when creating hazard and other maps for the [Los Angeles basin](../../etc/nshm/map-la-basin.geojson). -A map region is expected as a `Polygon` `FeatureCollection`. Currently, *nshmp-haz-v2* only supports +A map region is expected as a `Polygon` `FeatureCollection`. Currently, *nshmp-haz* only supports a `FeatureCollection` with 1 or 2 polygons. When a single polygon is defined, it must consist of a single, simple closed loop. Additional arrays that define holes in the polygon (per the GeoJSON spec) are not processed and results are undefined for self-intersecting coordinate arrays. This @@ -117,7 +117,7 @@ TODO This needs updating; link to conus-2018 active crust map-region.geojson. * [Calculation Configuration](./Calculation-Configuration.md#calculation-configuration) * [Site Specification](./Site-Specification.md#site-specification) * [Examples](../../etc/examples/README.md) (or - [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2/-/tree/master/etc/examples)) + [on GitLab](https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/master/etc/examples)) * [**Documentation Index**](../README.md) --- diff --git a/docs/pages/Source-Types.md b/docs/pages/Source-Types.md index d56b87194..595e0a912 100644 --- a/docs/pages/Source-Types.md +++ b/docs/pages/Source-Types.md @@ -12,15 +12,15 @@ geometry itself is unknown or very poorly defined. [[_TOC_]] -Source models for use with *nshmp-haz-v2* are defined using [JSON](https://www.json.org) and -[GeoJSON](https://geojson.org). *nshmp-haz-v2* makes determinations about how to represent a source +Source models for use with *nshmp-haz* are defined using [JSON](https://www.json.org) and +[GeoJSON](https://geojson.org). *nshmp-haz* makes determinations about how to represent a source based on a GeoJSON geometry type in conjunction with supporting JSON configuration files. Example source configuration files, `*-config.json`, are provided with each source type description. Configuration files must be fully specified with `null` JSON member values used to specify 'do nothing' where appropriate. Any configuration member value in ALL_CAPS indicates the value is one of a fixed number of options commonly referred to as an enum. -__Note on Coordinates:__ *nshmp-haz-v2* supports longitude and latitude values in the closed ranges +__Note on Coordinates:__ *nshmp-haz* supports longitude and latitude values in the closed ranges `[-360°‥360°]` and `[-90°‥90°]`. Note, however, that mixing site and/or source coordinates across the antimeridian (the -180° to 180° transition) will yield unexpected results. For Pacific models and calculations, always use positive or negative longitudes exclusively. diff --git a/docs/pages/USGS-Models.md b/docs/pages/USGS-Models.md index 3ad949174..8a0226afd 100644 --- a/docs/pages/USGS-Models.md +++ b/docs/pages/USGS-Models.md @@ -6,7 +6,7 @@ years. This window is narrowing, however, and updates are also being undertaken models for states and territories outside the conterminous U.S. These pages describe the models that are available and some of the history and versions of each. The models are intended for use with the USGS probabilistic earthquake hazard codebase: -[*nshmp-haz-v2*](https://code.usgs.gov/ghsc/nshmp/nshmp-haz-v2). +[*nshmp-haz*](https://code.usgs.gov/ghsc/nshmp/nshmp-haz). As specified in this documentation, NSHM files are organized by tectonic setting and then further by source type. For larger models, such as that of the conterminous U.S., sources are commonly -- GitLab