From 660c06b2c349a32117b50298c71268a4ac1b1f27 Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Wed, 20 Oct 2021 07:42:42 -0600
Subject: [PATCH 1/3] minor disagg app edits

---
 .../usgs/earthquake/nshmp/DeaggEpsilon.java   | 36 +++++++++++++++++--
 1 file changed, 33 insertions(+), 3 deletions(-)

diff --git a/src/main/java/gov/usgs/earthquake/nshmp/DeaggEpsilon.java b/src/main/java/gov/usgs/earthquake/nshmp/DeaggEpsilon.java
index c208ec73b..ffb544166 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/DeaggEpsilon.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/DeaggEpsilon.java
@@ -41,6 +41,12 @@ import gov.usgs.earthquake.nshmp.gmm.Imt;
 import gov.usgs.earthquake.nshmp.internal.Logging;
 import gov.usgs.earthquake.nshmp.model.HazardModel;
 
+/**
+ * Disaggregate probabilisitic seismic hazard at a return period of interest or
+ * at specific ground motion levels.
+ *
+ * @author U.S. Geological Survey
+ */
 /**
  * Custom application to support 2018 integration into building codes.
  * Application will process a list of sites for which the risk-targetd response
@@ -58,7 +64,30 @@ public class DeaggEpsilon {
       .create();
 
   /**
-   * Entry point for the application.
+   * Entry point for the disaggregation of probabilisitic seismic hazard.
+   *
+   * <p>Two approaches to disaggregation of seimic hazard are possible with this
+   * application. In the first approach, the 'sites' file is the same as it
+   * would be for a hazard calculation, and disaggregation is performed for all
+   * calculated intensity measures at the 'returnPeriod' (in years)of interest
+   * specified in the config file (default = 2475 years)
+   *
+   * <p>In the second approach, the sites file includes columns for each
+   * spectral period and the target ground motion level to disaggregate for
+   * each. For example, the target values could be a risk-targeted response
+   * spectrum.
+   *
+   * <p>Please refer to the nshmp-haz <a
+   * href="https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main/docs"
+   * target="_top">docs</a> for comprehensive descriptions of source models,
+   * configuration files, site files, and hazard calculations.
+   *
+   * @see <a
+   *      href="https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/blob/main/docs/pages/Building-&-Running.md"
+   *      target="_top"> nshmp-haz Building & Running</a>
+   * @see <a
+   *      href="https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main/etc/examples"
+   *      target="_top"> example calculations</a>
    */
   public static void main(String[] args) {
 
@@ -308,7 +337,7 @@ public class DeaggEpsilon {
 
   private static final String PROGRAM = DeaggEpsilon.class.getSimpleName();
   private static final String USAGE_COMMAND =
-      "java -cp nshmp-haz.jar gov.usgs.earthquake.nshmp.DeaggEpsilon model sites-spectra [config]";
+      "java -cp nshmp-haz.jar gov.usgs.earthquake.nshmp.DeaggEpsilon model sites [config]";
 
   private static final String USAGE = new StringBuilder()
       .append(NEWLINE)
@@ -320,7 +349,8 @@ public class DeaggEpsilon {
       .append("Where:").append(NEWLINE)
       .append("  'model' is a model directory")
       .append(NEWLINE)
-      .append("  'sites-spectra' is a *.csv file of locations and risk-targeted response spectra")
+      .append(
+          "  'sites' is a *.csv file of locations, site parameters and (optional) target ground motion levels")
       .append(NEWLINE)
       .append("     - Header: lon,lat,PGA,SA0P01,SA0P02,...")
       .append(NEWLINE)
-- 
GitLab


From d5c365d778b8e2834652e66b3728d2e55d2848ca Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Wed, 20 Oct 2021 10:23:08 -0600
Subject: [PATCH 2/3] code.json edits

---
 code.json | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/code.json b/code.json
index f524431f1..183cbc7e3 100644
--- a/code.json
+++ b/code.json
@@ -2,31 +2,28 @@
   {
     "name": "nshmp-haz",
     "organization": "U.S. Geological Survey",
-    "description": "National Seismic Hazard Mapping Project (NSHMP) software stack",
-    "version": "#.#.#",
-    "status": "Production",
-    "doi": "doi:###TBD###",
+    "description": "NSHMP command line applications and web services",
+    "version": "2.0.0",
+    "status": "Development",
 
     "permissions": {
       "usageType": "openSource",
       "licenses": [
         {
           "name": "Public Domain, CC0-1.0",
-          "URL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/blob/main/LICENSE.md"
+          "URL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/raw/main/LICENSE.md"
         }
       ]
     },
 
-    "repositoryURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/",
-    "homepageURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/tree/main/docs",
-    "downloadURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/releases/tag/v#.#.#",
-    "disclaimerURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/blob/main/DISCLAIMER.md",
+    "homepageURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/",
+    "downloadURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/archive/main/nshmp-haz-main.zip",
+    "disclaimerURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz/-/raw/main/DISCLAIMER.md",
+    "repositoryURL": "https://code.usgs.gov/ghsc/nshmp/nshmp-haz.git",
     "vcs": "git",
 
     "laborHours": 1200,
 
-    "languages": [ "Java" ],
-
     "tags": [
       "Earthquake Hazards",
       "Geologic Hazards Science Center",
@@ -38,8 +35,11 @@
       "earthquake-source",
       "hazard-curve",
       "disaggregation",
-      "deaggregation",
-      "doi|###TBD###"
+      "doi|https://doi.org/10.5066/P9STF5GK"
+    ],
+
+    "languages": [
+      "Java"
     ],
 
     "contact": {
@@ -48,7 +48,7 @@
     },
 
     "date": {
-      "metadataLastUpdated": "2021-06-##"
+      "metadataLastUpdated": "2021-10-20"
     }
   }
 ]
-- 
GitLab


From e0ca5bca01830faede4f8f42ee0bb81eaffcdbed Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Wed, 20 Oct 2021 10:27:44 -0600
Subject: [PATCH 3/3] updated disclaimer to provisional

---
 DISCLAIMER.md | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

diff --git a/DISCLAIMER.md b/DISCLAIMER.md
index ec593eb18..fb9a9721c 100644
--- a/DISCLAIMER.md
+++ b/DISCLAIMER.md
@@ -1,11 +1,10 @@
 # Disclaimer
 
-This software has been approved for release by the U.S. Geological Survey
-(USGS). Although the software has been subjected to rigorous review, the USGS
-reserves the right to update the software as needed pursuant to further analysis
-and review. No warranty, expressed or implied, is made by the USGS or the U.S.
-Government as to the functionality of the software and related material nor
-shall the fact of release constitute any such warranty. Furthermore, the
-software is released on condition that neither the USGS nor the U.S. Government
-shall be held liable for any damages resulting from its authorized or
-unauthorized use.
+This software is preliminary or provisional and is subject to revision. It is
+being provided to meet the need for timely best science. The software has not
+received final approval by the U.S. Geological Survey (USGS). No warranty,
+expressed or implied, is made by the USGS or the U.S. Government as to the
+functionality of the software and related material nor shall the fact of release
+constitute any such warranty. The software is provided on the condition that
+neither the USGS nor the U.S. Government shall be held liable for any damages
+resulting from the authorized or unauthorized use of the software.
-- 
GitLab