From 1cee11ebbb4e025efdf1bd63ab8104c2d00943c0 Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Tue, 12 Apr 2022 08:28:47 -0600
Subject: [PATCH] renamed nga east gmm trees

---
 .../earthquake/nshmp/gmm/CombinedGmm.java     | 16 ++--
 .../gov/usgs/earthquake/nshmp/gmm/Gmm.java    | 78 +++++++++----------
 .../earthquake/nshmp/gmm/NgaEast_2018.java    | 11 ++-
 .../usgs/earthquake/nshmp/gmm/NgaEast.java    |  6 +-
 4 files changed, 55 insertions(+), 56 deletions(-)

diff --git a/src/main/java/gov/usgs/earthquake/nshmp/gmm/CombinedGmm.java b/src/main/java/gov/usgs/earthquake/nshmp/gmm/CombinedGmm.java
index 12780172..375f7e22 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/gmm/CombinedGmm.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/gmm/CombinedGmm.java
@@ -15,10 +15,10 @@ import static gov.usgs.earthquake.nshmp.gmm.Gmm.CY_14;
 import static gov.usgs.earthquake.nshmp.gmm.Gmm.CY_14_BASIN;
 import static gov.usgs.earthquake.nshmp.gmm.Gmm.FRANKEL_96;
 import static gov.usgs.earthquake.nshmp.gmm.Gmm.IDRISS_14;
-import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_USGS;
-import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_USGS_CPA;
-import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_USGS_SEEDS;
-import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_USGS_SEEDS_CPA;
+import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_2018;
+import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_2023;
+import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_SEEDS_2018;
+import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_SEEDS_2023;
 import static gov.usgs.earthquake.nshmp.gmm.Gmm.PEZESHK_11;
 import static gov.usgs.earthquake.nshmp.gmm.Gmm.SILVA_02;
 import static gov.usgs.earthquake.nshmp.gmm.Gmm.SOMERVILLE_01;
@@ -149,8 +149,8 @@ class CombinedGmm implements GroundMotionModel {
 
   /* 5.0 */
   private static final Map<Gmm, Double> CEUS_2018 = Map.of(
-      NGA_EAST_USGS, 0.667,
-      NGA_EAST_USGS_SEEDS, 0.333);
+      NGA_EAST_2018, 0.667,
+      NGA_EAST_SEEDS_2018, 0.333);
 
   static final class Ceus2018 extends CombinedGmm {
 
@@ -165,8 +165,8 @@ class CombinedGmm implements GroundMotionModel {
 
   /* 5.0 Gulf Coast */
   private static final Map<Gmm, Double> CEUS_2018_CPA = Map.of(
-      NGA_EAST_USGS_CPA, 0.667,
-      NGA_EAST_USGS_SEEDS_CPA, 0.333);
+      NGA_EAST_2023, 0.667,
+      NGA_EAST_SEEDS_2023, 0.333);
 
   static final class Ceus2018Cpa extends CombinedGmm {
 
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/gmm/Gmm.java b/src/main/java/gov/usgs/earthquake/nshmp/gmm/Gmm.java
index 16228862..7c8e78ab 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/gmm/Gmm.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/gmm/Gmm.java
@@ -852,15 +852,15 @@ public enum Gmm {
 
   /* NGA-East for USGS */
 
-  /** @see NgaEastUsgs_2017 */
-  NGA_EAST_USGS(
-      NgaEast_2018.Usgs17.class,
-      NgaEast_2018.Usgs17.NAME,
+  /** @see NgaEast_2018 */
+  NGA_EAST_2018(
+      NgaEast_2018.NgaEastBase.class,
+      NgaEast_2018.NgaEastBase.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
   /** NGA-East for USGS with Guo &amp; Chapman Gulf CPA **/
-  NGA_EAST_USGS_CPA(
+  NGA_EAST_2023(
       NgaEast_2018.Usgs17Cpa.class,
       NgaEast_2018.Usgs17Cpa.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
@@ -868,15 +868,15 @@ public enum Gmm {
 
   /* NGA-East USGS Seed Tree */
 
-  /** @see NgaEastUsgs_2017 */
-  NGA_EAST_USGS_SEEDS(
+  /** @see NgaEast_2018 */
+  NGA_EAST_SEEDS_2018(
       NgaEast_2018.UsgsSeeds.class,
       NgaEast_2018.UsgsSeeds.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
   /** NGA-East for USGS Seed Models with Guo &amp; Chapman Gulf CPA **/
-  NGA_EAST_USGS_SEEDS_CPA(
+  NGA_EAST_SEEDS_2023(
       NgaEast_2018.UsgsSeedsCpa.class,
       NgaEast_2018.UsgsSeedsCpa.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
@@ -884,189 +884,189 @@ public enum Gmm {
 
   /* NGA-East Seed Models */
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_1CCSP(
       NgaEast_2018.Seed_1CCSP.class,
       NgaEast_2018.Seed_1CCSP.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_1CVSP(
       NgaEast_2018.Seed_1CVSP.class,
       NgaEast_2018.Seed_1CVSP.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_2CCSP(
       NgaEast_2018.Seed_2CCSP.class,
       NgaEast_2018.Seed_2CCSP.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_2CVSP(
       NgaEast_2018.Seed_2CVSP.class,
       NgaEast_2018.Seed_2CVSP.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B_A04(
       NgaEast_2018.Seed_B_a04.class,
       NgaEast_2018.Seed_B_a04.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B_AB14(
       NgaEast_2018.Seed_B_ab14.class,
       NgaEast_2018.Seed_B_ab14.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B_AB95(
       NgaEast_2018.Seed_B_ab95.class,
       NgaEast_2018.Seed_B_ab95.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B_BCA10D(
       NgaEast_2018.Seed_B_bca10d.class,
       NgaEast_2018.Seed_B_bca10d.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B_BS11(
       NgaEast_2018.Seed_B_bs11.class,
       NgaEast_2018.Seed_B_bs11.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B_SGD02(
       NgaEast_2018.Seed_B_sgd02.class,
       NgaEast_2018.Seed_B_sgd02.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B20_AB14MOD1(
       NgaEast_2018.Seed_B20_ab14mod1.class,
       NgaEast_2018.Seed_B20_ab14mod1.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B20_AB14MOD2(
       NgaEast_2018.Seed_B20_ab14mod2.class,
       NgaEast_2018.Seed_B20_ab14mod2.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_B20_BCA10D(
       NgaEast_2018.Seed_B20_bca10d.class,
       NgaEast_2018.Seed_B20_bca10d.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_FRANKEL(
       NgaEast_2018.Seed_Frankel.class,
       NgaEast_2018.Seed_Frankel.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_GRAIZER(
       NgaEast_2018.Seed_Graizer.class,
       NgaEast_2018.Seed_Graizer.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_GRAIZER16(
       NgaEast_2018.Seed_Graizer16.class,
       NgaEast_2018.Seed_Graizer16.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_GRAIZER17(
       NgaEast_2018.Seed_Graizer17.class,
       NgaEast_2018.Seed_Graizer17.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_HA15(
       NgaEast_2018.Seed_HA15.class,
       NgaEast_2018.Seed_HA15.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_PEER_EX(
       NgaEast_2018.Seed_PEER_EX.class,
       NgaEast_2018.Seed_PEER_EX.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_PEER_GP(
       NgaEast_2018.Seed_PEER_GP.class,
       NgaEast_2018.Seed_PEER_GP.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_PZCT15_M1SS(
       NgaEast_2018.Seed_PZCT15_M1SS.class,
       NgaEast_2018.Seed_PZCT15_M1SS.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_PZCT15_M2ES(
       NgaEast_2018.Seed_PZCT15_M2ES.class,
       NgaEast_2018.Seed_PZCT15_M2ES.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see PezeshkEtAl_2018 */
+  /** @see NgaEast_2018 @see PezeshkEtAl_2018 */
   NGA_EAST_SEED_PZCT18_M1SS(
       PezeshkEtAl_2018.Seed_PZCT18_M1SS.class,
       PezeshkEtAl_2018.Seed_PZCT18_M1SS.NAME,
       PezeshkEtAl_2018.COEFFS_M1SS,
       PezeshkEtAl_2018.CONSTRAINTS),
 
-  /** @see PezeshkEtAl_2018 */
+  /** @see PezeshkEtAl_2018 @see PezeshkEtAl_2018 */
   NGA_EAST_SEED_PZCT18_M2ES(
       PezeshkEtAl_2018.Seed_PZCT18_M2ES.class,
       PezeshkEtAl_2018.Seed_PZCT18_M2ES.NAME,
       PezeshkEtAl_2018.COEFFS_M2ES,
       PezeshkEtAl_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_SP15(
       NgaEast_2018.Seed_SP15.class,
       NgaEast_2018.Seed_SP15.NAME,
       NgaEast_2018.COEFFS_SIGMA_PANEL,
       NgaEast_2018.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 @see ShahjoueiPezeshk_2016 */
+  /** @see NgaEast_2018 @see ShahjoueiPezeshk_2016 */
   NGA_EAST_SEED_SP16(
       ShahjoueiPezeshk_2016.class,
       ShahjoueiPezeshk_2016.NAME,
       ShahjoueiPezeshk_2016.COEFFS,
       ShahjoueiPezeshk_2016.CONSTRAINTS),
 
-  /** @see NgaEastUsgs_2017 */
+  /** @see NgaEast_2018 */
   NGA_EAST_SEED_YA15(
       NgaEast_2018.Seed_YA15.class,
       NgaEast_2018.Seed_YA15.NAME,
@@ -1511,10 +1511,10 @@ public enum Gmm {
     NGA_EAST(
         "NGA-East Logic Trees",
         List.of(
-            NGA_EAST_USGS,
-            NGA_EAST_USGS_SEEDS,
-            NGA_EAST_USGS_CPA,
-            NGA_EAST_USGS_SEEDS_CPA)),
+            NGA_EAST_2018,
+            NGA_EAST_SEEDS_2018,
+            NGA_EAST_2023,
+            NGA_EAST_SEEDS_2023)),
 
     NGA_EAST_SEEDS(
         "NGA-East Seed Models",
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/gmm/NgaEast_2018.java b/src/main/java/gov/usgs/earthquake/nshmp/gmm/NgaEast_2018.java
index 847c04b9..e3d0ca5f 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/gmm/NgaEast_2018.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/gmm/NgaEast_2018.java
@@ -101,8 +101,8 @@ import gov.usgs.earthquake.nshmp.tree.LogicTree;
  * <p><b>Component:</b> average horizontal (RotD50)
  *
  * @author U.S. Geological Survey
- * @see Gmm#NGA_EAST_USGS
- * @see Gmm#NGA_EAST_USGS_SEEDS
+ * @see Gmm#NGA_EAST_2018
+ * @see Gmm#NGA_EAST_SEEDS_2018
  * @see Gmm#NGA_EAST_SEED_1CCSP
  * @see Gmm#NGA_EAST_SEED_1CVSP
  * @see Gmm#NGA_EAST_SEED_2CCSP
@@ -126,7 +126,6 @@ import gov.usgs.earthquake.nshmp.tree.LogicTree;
  * @see Gmm#NGA_EAST_SEED_SP16
  * @see Gmm#NGA_EAST_SEED_YA15
  */
-@Beta
 public abstract class NgaEast_2018 implements GroundMotionModel {
 
   /*
@@ -363,7 +362,7 @@ public abstract class NgaEast_2018 implements GroundMotionModel {
    * Base model used for sammons and seed model groups that share common site
    * class and sigma models.
    */
-  static class Usgs17 extends NgaEast_2018 {
+  static class NgaEastBase extends NgaEast_2018 {
 
     static final int MODEL_COUNT = 17;
     static final String[] MEAN_IDS = IntStream.range(1, MODEL_COUNT + 1)
@@ -377,7 +376,7 @@ public abstract class NgaEast_2018 implements GroundMotionModel {
     final double[] μWts;
 
     /* Specifiy an array of models ids. */
-    Usgs17(Imt imt) {
+    NgaEastBase(Imt imt) {
       super(imt);
       this.tables = GroundMotionTables.getNgaEast(imt);
       this.pgaTables = GroundMotionTables.getNgaEast(Imt.PGA);
@@ -405,7 +404,7 @@ public abstract class NgaEast_2018 implements GroundMotionModel {
   }
 
   /* Guo and Chapman Gulf Coastal Plain Amplification (CPA) model. */
-  static class Usgs17Cpa extends Usgs17 {
+  static class Usgs17Cpa extends NgaEastBase {
 
     // static final String NAME = "NGA-East (2023)";
     static final String NAME = NgaEast_2018.NAME + " (Gulf Coast)";
diff --git a/src/test/java/gov/usgs/earthquake/nshmp/gmm/NgaEast.java b/src/test/java/gov/usgs/earthquake/nshmp/gmm/NgaEast.java
index c40c735a..d60eb6f7 100644
--- a/src/test/java/gov/usgs/earthquake/nshmp/gmm/NgaEast.java
+++ b/src/test/java/gov/usgs/earthquake/nshmp/gmm/NgaEast.java
@@ -1,7 +1,7 @@
 package gov.usgs.earthquake.nshmp.gmm;
 
-import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_USGS;
-import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_USGS_SEEDS;
+import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_2018;
+import static gov.usgs.earthquake.nshmp.gmm.Gmm.NGA_EAST_SEEDS_2018;
 import static gov.usgs.earthquake.nshmp.gmm.Imt.PGA;
 import static gov.usgs.earthquake.nshmp.gmm.Imt.SA0P02;
 import static gov.usgs.earthquake.nshmp.gmm.Imt.SA0P1;
@@ -39,7 +39,7 @@ class NgaEast implements ArgumentsProvider {
   }
 
   /* Result generation sets */
-  private static Set<Gmm> gmms = EnumSet.of(NGA_EAST_USGS, NGA_EAST_USGS_SEEDS);
+  private static Set<Gmm> gmms = EnumSet.of(NGA_EAST_2018, NGA_EAST_SEEDS_2018);
   private static Set<Imt> imts = EnumSet.of(PGA, SA0P02, SA0P1, SA0P2, SA1P0, SA3P0, SA5P0, SA10P0);
 
   public static void main(String[] args) throws IOException {
-- 
GitLab