cmp

Author: peer-open-source

source/_static/images/peer-small.png

@@ -7,17 +7,18 @@ Cite
      title = {An Open-Access Simulated Earthquake Ground Motion Database for a {M7} Hayward Fault Earthquake in the San Francisco Bay Region},
      author = {{McCallen}, David and Eeri, M and Pitarka, Arben and Tang, Houjun and Mosalam, Khalid and Eeri, M and Petrone, Floriana and Eeri, M and Günay, Selim and Perez, Claudio M.},
      langid = {english},
-     journal={Earthquake Spectra},
-     note={\textbf{Under review}}
+     year = {2025},
+     journal={Earthquake Spectra}
    }
 
    @software{mccallen_peer-lbnl_nodate,
-           title = {{PEER}-{LBNL} Simulated Ground Motion Dataset},
-           url = {https://sgmd.peer.berkeley.edu/},
-           doi = {10.55461/datasets.12302004},
-           author = {{McCallen}, David and Pitarka, Arben and Tang, Houjun and Nakata, Rie and Mosalam, Khalid and Petrone, Floriana and Gunay, Selim and Perez, Claudio},
-           urldate = {2025-01-01},
-           langid = {english},
-           note = {Institution: Pacific Earthquake Engineering Research Center, Lawrence Berkeley National Laboratory},
+      title = {{PEER}-{LBNL} Simulated Ground Motion Dataset},
+      url = {https://sgmd.peer.berkeley.edu/},
+      doi = {10.55461/datasets.12302004},
+      year = {2025},
+      author = {{McCallen}, David and Pitarka, Arben and Tang, Houjun and Nakata, Rie and Mosalam, Khalid and Petrone, Floriana and Gunay, Selim and Perez, Claudio},
+      urldate = {2025-01-01},
+      langid = {english},
+      note = {Institution: Pacific Earthquake Engineering Research Center, Lawrence Berkeley National Laboratory},
    }
 

source/cite.rst

@@ -7,18 +7,16 @@ The development and maintenance of SGMD is supported by the Department of Energy
 ```{eval-rst}
 .. figure:: sgmd.png
    :align: center
+   :width: 50%
 ```
 
 
 ```{eval-rst}
 .. toctree::
+   :maxdepth: 2
 
-   manual/region
-   manual/realizations
-   manual/search
-   manual/files
-   manual/glossary
-   references
+   Overview <self>
+   manual/index
    cite
 
 ```

source/launch.md

@@ -0,0 +1,9 @@
+# Examples
+
+
+  - Figure 3 shows a search for all ground motions in Realizations 1 and 2, and Realizations with patches 4 and 5 within a region defined by latitude boundaries of $37.68^{\circ}$ and $37.72^{\circ}$ and longitude boundaries of $-122.30^{\circ}$ and $-121.90^{\circ}$.
+  - Figure 4 shows a search for all ground motions in the same region, but only those with $\mathrm{V}_{\mathrm{s} 30}$ between $300 \mathrm{~m} / \mathrm{s}$ and $500 \mathrm{~m} / \mathrm{s}$.
+  - Figure 5 shows a search for all ground motions in the same region but only those with $\mathrm{V}_{\mathrm{s} 30}$ between $300 \mathrm{~m} / \mathrm{s}$ and $500 \mathrm{~m} / \mathrm{s}$, and $\mathrm{R}_{\mathrm{jb}}$ between 10 km and 20 km .
+  - Figure 6 shows a search for all ground motions with PGV between $0.8 \mathrm{~m} / \mathrm{s}$ and $1.0 \mathrm{~m} / \mathrm{s}$ in Realizations 1-10, and Realizations with Patches 1-10.
+
+  

source/manual/examples.md

@@ -0,0 +1,17 @@
+# Manual
+
+
+```{eval-rst}
+.. toctree::
+   :maxdepth: 1
+
+   region
+   realizations
+   search
+   metadata
+   files
+   examples
+   glossary
+   references
+
+```

source/manual/figures/region-input.png

@@ -0,0 +1,15 @@
+# Metadata
+
+Two types of metadata are provided in the dowloaded archive. 
+The first type is metadata for the  rupture realizations and the second type is metadata for the ground motion histories. 
+The metadata for the realizations is provided in a file titled ``Simulations_Flatfile.xlsx``, and includes three sets of information:
+- A general description of the simulated earthquake including the region name, corresponding region code, and the realization number.
+- Fault rupture parameters, including fault geometry characterized by the fault name; rupture geometry defined by fault length and width, depth to top of rupture, dip, strike, and rake; earthquake magnitude and hypocenter location; the rupture model utilized in the regional simulations (e.g., the *Graves-Pitarka* kinematic rupture model) and slip characteristics. 
+A  graphic that displays the slip, slip-rate and rise time across the fault rupture is also provided to assist in interpretation.
+
+- Simulation model parameters, which include maximum frequency resolved, minimum shear wave velocity included in the model (Vsmin), surface grid spacing that defines the distance between computational nodes in the simulation model, output spacing that provides distance between the down-sampled grid points where ground motion data is available, and the geologic velocity model utilized in the simulation (e.g., the USGS velocity model for SFBA).
+
+For each region, the metadata for the ground motions of all realizations are provided in a separate file. 
+The metadata includes two sets of information; the first set includes the *name*, *latitude* and *longitude* coordinates of the grid point, the vertical elevation of the grid point from sea level, the 2D cartesian coordinates of the grid point in the computational model domain (with X and Y axes in the fault normal and parallel directions respectively), the $V_{s30}$, and the depth at which the shear-wave velocity reaches $1.0 \mathrm{~km} / \mathrm{s}$ and $2.5 \mathrm{~km} / \mathrm{s}(\mathrm{Z} 1.0$ and Z $2.5$ at the location of the grid point. 
+The second set consists of the distance parameters ( $R_{jb}$ , $R_{\mathrm{rup}}$ and $R_x$ ) and peak ground motion values (*RotD50*, *PGA*, *PGV*, and *PGD*). 
+The file for the SFBA region is titled ``Hayward_M7_GMs_Flatfile.xlsx``.

source/manual/index.md

@@ -13,11 +13,7 @@ After selecting the region, the next window allows the user to search for ground
   Each *realization* represents a unique earthquake, and it is recommended that users make themselves familiar with all the 50 realizations, details of which are provided in the file [`Simulations_Flatfile.xlsx`](Simulations_Flatfile.xlsx).
 
 - All search parameters are initially deactivated. Users can activate the parameters of interest using the Switch buttons (Figures 3-6). 
-  At least one parameter must be activated for the search, and users can utilize as many parameters as needed. For example:
-  - Figure 3 shows a search for all ground motions in Realizations 1 and 2, and Realizations with patches 4 and 5 within a region defined by latitude boundaries of $37.68^{\circ}$ and $37.72^{\circ}$ and longitude boundaries of $-122.30^{\circ}$ and $-121.90^{\circ}$.
-  - Figure 4 shows a search for all ground motions in the same region, but only those with $\mathrm{V}_{\mathrm{s} 30}$ between $300 \mathrm{~m} / \mathrm{s}$ and $500 \mathrm{~m} / \mathrm{s}$.
-  - Figure 5 shows a search for all ground motions in the same region but only those with $\mathrm{V}_{\mathrm{s} 30}$ between $300 \mathrm{~m} / \mathrm{s}$ and $500 \mathrm{~m} / \mathrm{s}$, and $\mathrm{R}_{\mathrm{jb}}$ between 10 km and 20 km .
-  - Figure 6 shows a search for all ground motions with PGV between $0.8 \mathrm{~m} / \mathrm{s}$ and $1.0 \mathrm{~m} / \mathrm{s}$ in Realizations 1-10, and Realizations with Patches 1-10.
+  At least one parameter must be activated for the search, and users can utilize as many parameters as needed.
 
 - If a user wants to search for a specific location, such as the site of a building or a bridge, they should set the maximum latitude equal to the minimum latitude and the maximum longitude equal to the minimum longitude. 
   This search finds ground motions at the locations closest to the specified coordinates. 

source/manual/metadata.md

@@ -0,0 +1,16 @@
+---
+bibliography:
+- ./references.biblatex
+---
+
+# References
+
+*EQSim* is a core component of the SGMD computational backend. 
+This program is described by {cite}`mccallen2021eqsim`, {cite}`mccallen2021eqsima`,
+{cite}`pinilla-ramos2025performance`.
+
+Kinematic model {cite}`graves2010broadband`, {cite}`graves2015refinements`, {cite}`pitarka2021refinements`
+
+```{bibliography}
+:style: unsrt
+```

source/manual/realizations.md

@@ -7,3 +7,9 @@
 Once in the database, the first step is to select the region to download ground motions (Figure 2).
 Currently, the San Francisco Bay Area (SFBA) is available as a region, and Greater Los Angeles Area
 and New Madrid Seismic Zone are two regions that will be included in the near future. 
+
+```{figure} figures/region-input.png
+  :width: 50%
+
+  Input field for the selection of a region.
+```