gmprocess 2.3.0__tar.gz → 2.4.0__tar.gz

{gmprocess-2.3.0 → gmprocess-2.4.0}/CHANGELOG.md

@@ -1,13 +1,28 @@
 ## main
 
+## 2.4.0 / 2025-04-04
+
+- Enhancements
+  - Store only the peak value instead of the whole trace for waveform_metrics, resulting in significantly less memory usage.
+  - Use P phase pickers within time window around P phase travel time to set split time between noise (pre-event window) and signal (event window). Update the `pickers` section of the configuration file to include relevant parameters.
+  - COSMOS v0 writer incorporates sensitivity from StationXML stages in real #22 and real #42 headers
+  - Support FAS metric for individual channel components (this could be classified as a bugfix).
+  - Add helper functions to facilitate developers tracking memory usage with `tracemalloc`.
+- Bugfix
+  - Fix error with zeropad method using 'fhp' to extracts filter order
+  - Fix cosmos v0 writer header failing to write sensitivities due to if statement testing 'trace.stats.standard' instead of 'trace.stats'
+  - Set self.output_units in instrument_response.RemoveResponse._remove_sensivitiy() to "ACC" (was not set).
+  - Get structure type from correct field in DMG format.
+  - Fix two calls to `numpy.mean()` to avoid warnings about zero length arrays.
+  - Fixed error in parsing units from COSMOS format.
 
 ## 2.3.0 / 2025-01-23
 
 - Enhancements
   - Substantial changes to the default processing steps.
-  - Add support for psudo-response spectra (PSA and PSV) and change default metrics to use PSA rather than SA.
-  - Allow for user to set a different query window duration for different tectonic envirnments.
-  - Increase default query window duraiton.
+  - Add support for psuedo-response spectra (PSA and PSV) and change default metrics to use PSA rather than SA.
+  - Allow for user to set a different query window duration for different tectonic environments.
+  - Increase default query window duration.
   - Add a new "source_path" method to compute the signal end that uses 1/fc as the source duration, which is then added to a path duration that is parameterized with coefficients for an intercept and distance term.
   - Exclude network 7D, which is for ocean bottom stations.
   - Apply clipping check to strong motion instruments. In the past, we thought it was safe to assume strong motion instruments did not clip but we have found exceptions to this. 
@@ -57,7 +72,7 @@
 ## 2.1.2 / 2024-11-14
 - Enhancements
   - Station distance (epicentral distance) added to the reports
-  - Add support velocity and dispacement COSMOS and DMG files
+  - Add support velocity and displacement COSMOS and DMG files
   - More graceful exiting when bad eventid is inputted to `download`
   - Allow `reports` to continue processing when an event directory is empty (no data)
   - Update default config to use the Ramos-Sepulveda et al. (2023) high-pass corner selection method, and increase the p-wave shift to -2 sec from -1 sec. 
@@ -93,7 +108,7 @@
   - Updated line styles of annotation lines in SNR plots.
   - Remove the `export_shakemap` subcommand.
   - Default config updates
-    - Change KO smoothing paramter to 188.5.
+    - Change KO smoothing parameter to 188.5.
     - Add arias intensity.
     - Lower pga threshold on distance search criteria.
     - Update release instructions in CONTRIBUTING.md.
@@ -120,7 +135,7 @@
 - Other
   - Turned off automatic generation of moveout plot since it isn't getting used.
   - Renamed src/gmprocess/utils/test_utils.py to src/gmprocess/utils/test_utils.py to avoid it being detected as a unit test module.
-  - Decrease precision in fetcher bounds and fix Geonet bounds to include negaive longitudes.
+  - Decrease precision in fetcher bounds and fix Geonet bounds to include negative longitudes.
   - Move the "config" subcommand to be a stand-alone command line program called "gmprocess_config".
   - Removed "list_metrics" command.
   - Removed cap on python version, increased minimum version to 3.9
@@ -168,7 +183,7 @@
 - Added station metric units to constants.
 - Bugfixes
   - Resolve key error that was preventing writing of metric tables when Arias Intensity was requested. 
-  - Resolve bug that occurs when multiple channels/stations are present in the invetory when trying to retrieve the sampling rate for the metric table.
+  - Resolve bug that occurs when multiple channels/stations are present in the inventory when trying to retrieve the sampling rate for the metric table.
 
 ## 1.2.8 / 2023-08-21
 
@@ -296,7 +311,7 @@
 - More gracefully handle cases where workspace file does not exist but is expected.
 - Add label arg to gmconvert.
 - Make colocated selection optional.
-- Replace stastic map with interactive HTML map and add to CLI tutorial in documentation.
+- Replace statistic map with interactive HTML map and add to CLI tutorial in documentation.
 - Remove cartopy dependency.
 - Get scnl from COSMOS comments.
 - Add freq differentiation option.

{gmprocess-2.3.0 → gmprocess-2.4.0}/CONTRIBUTING.md

@@ -47,7 +47,7 @@ DOCS: [one line description]
 ```
 
 We use the set of commit types from the [angular][9] project:
-* **BUILD**: Changes that affect the build system or external dependencies (e.g., pyrpoject.toml)
+* **BUILD**: Changes that affect the build system or external dependencies (e.g., pyproject.toml)
 * **CI**: Changes to our CI configuration files and scripts (e.g., .gitlab-ci.yml)
 * **DOCS**: Documentation only changes
 * **FEAT**: A new feature
@@ -76,7 +76,7 @@ Common reasons to rebase include:
 ## Releases
 
 1. Create a release candidate branch with a name related to the release version like `v1.2.1.rc0`.
-2. Update `code.json`, this is now automated with the `esi-releases` pacakge. For example, use the following command to increase the minor version number (options are "major", "minor", and "patch"):
+2. Update `code.json`, this is now automated with the `esi-releases` package. For example, use the following command to increase the minor version number (options are "major", "minor", and "patch"):
    ```
    releases minor
    ```
@@ -95,7 +95,7 @@ Common reasons to rebase include:
    - This git push command is what triggers the "release" pipeline that includes the test, build, and deploy stages.
    - *Note that we cannot have a hyphen in the tag name.* 
    - Also, if we end the tag name with "dev" then it will be build and uploaded to pypi as a pre-release version, which means that it will never be pip installed unless the user specifies the exact version of the pre-release.
-   - Maintainence note: the PYPI tokens are maintained in gitlab for the ESI group, under Settings then CI/CD, then Variables. These tokens are associated with the "pager_cicd" pypi service account.  
+   - Maintenance note: the PYPI tokens are maintained in gitlab for the ESI group, under Settings then CI/CD, then Variables. These tokens are associated with the "pager_cicd" pypi service account.  
 8. Create release from tag in gitlab. Give it a release title like `v1.2.1`.
 9. Copy/paste the relevant part of the changelog into the "describe this release" section.
 
@@ -126,7 +126,7 @@ Note that the script includes the follow arguments:
 Notes:
  - Never commit the built documentation files.
  - Remember that the notebooks run gmprocess code when you build the docs, 
-   so please be sure to check that the tutorials ran sucessfully. 
+   so please be sure to check that the tutorials ran successfully. 
  - The result of the tutorials will depend on your config file options, 
    so I recommend having a project with the default config file set up 
    and use that project when building the docs. 

{gmprocess-2.3.0 → gmprocess-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: gmprocess
-Version: 2.3.0
+Version: 2.4.0
 Summary: USGS Automated Ground Motion Processing Software
 Author-email: Eric Thompson <emthompsone@usgs.gov>, Mike Hearne <mhearne@usgs.gov>, Brad Aagaard <baagaard@usgs.gov>, Bruce Worden <cbworden@contractor.usgs.gov>, John Rekoske <jrekoske@ucsd.edu>, Heather Hunsinger <hhunsinger@usgs.gov>, Gabe Ferragut <gferragut@usgs.gov>
 License: License
@@ -109,6 +109,7 @@ Provides-Extra: build
 Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
 Requires-Dist: check-wheel-contents; extra == "build"
+Dynamic: license-file
 
 # Introduction
 This is a project designed to provide a number of functions related to parsing and processing earthquake ground motion data, building on top of the [ObsPy](https://github.com/obspy/obspy/wiki) library.
@@ -132,22 +133,34 @@ This will require that you create an account at code.usgs.gov, which is a more i
 # Suggested Citation
 If you wish to cite this software please cite:
 
-- Thompson, E.M., M. Hearne, B.T. Aagaard, J.M. Rekoske, C.B. Worden, M.P. Moschetti, H.E. Hunsinger, G.C. Ferragut, G.A. Parker, J.A. Smith, K.K. Smith, and A.R. Kottke (2024). USGS Automated Ground Motion Processing Software Version 2, U.S. Geological Survey software release. [https://doi.org/10.5066/P13HMKFJ](https://doi.org/10.5066/P13HMKFJ)
-  
+- Thompson, E.M., M. Hearne, B.T. Aagaard, J.M. Rekoske, C.B. Worden, M.P. Moschetti, H.E. Hunsinger, G.C. Ferragut, G.A. Parker, J.A. Smith, K.K. Smith, and A.R. Kottke (2024). USGS Automated Ground Motion Processing Software Version 2, U.S. Geological Survey software release, doi: [10.5066/P13HMKFJ](https://doi.org/10.5066/P13HMKFJ).
+
+- Thompson, E.M., M. Hearne, B.T. Aagaard, J.M. Rekoske, C.B. Worden, M.P. Moschetti, H.E. Hunsinger, G.C. Ferragut, G.A. Parker, J.A. Smith, Smith, K.K., and A.R. Kottke (2025). Automated, Near Real‐Time Ground‐Motion Processing at the US Geological Survey. _Seismological Research Letters_, 96(1), pp.538-553, doi: [10.1785/0220240021](https://doi.org/10.1785/0220240021).
+
 # Journal Articles
 The list below is a subset of articles that made use of this software in their study. If you would like to have an article added to this list, please open an issue or email the developers.
 
-- Ahdi, S.K., B.T. Aagaard, M.P. Moschetti, G.A. Parker, O.S. Boyd, W.J. Stephenson (2024). Empirical ground-motion basin response in the California Great Valley, Reno, Nevada, and Portland, Oregon. _Earthquake Spectra_, 40(2):1099-1131. [https://doi.org/10.1177/87552930241237250](https://doi.org/10.1177/87552930241237250)
+- Ahdi, S.K., B.T. Aagaard, M.P. Moschetti, G.A. Parker, O.S. Boyd, and W.J. Stephenson (2024). Empirical ground-motion basin response in the California Great Valley, Reno, Nevada, and Portland, Oregon. _Earthquake Spectra_, 40(2): 1099-1131, doi: [10.1177/87552930241237250](https://doi.org/10.1177/87552930241237250).
+
+- Boyd OS, D. Churchwell, M.P. Moschetti, et al. (2024). Sediment thickness map of United States Atlantic and Gulf Coastal Plain Strata, and their influence on earthquake ground motions. _Earthquake Spectra_, 40(1): 89-112, doi: [10.1177/87552930231204880](https://doi.org/10.1177/87552930231204880).
+
+- Chatterjee, A., D.T. Trugman, G. Hirth, J. Lee, and V.C. Tsai (2024). High‐frequency ground motions of earthquakes correlate with fault network complexity. _Geophysical Research Letters_, 51(12), doi: [10.1029/2024GL109418](https://doi.org/10.1029/2024GL109418).
+
+- Hirakawa, E., G.A. Parker, A. Baltay, and T. Hanks (2023). Rupture directivity of the 25 October 2022 Mw 5.1 Alum Rock earthquake. _The Seismic Record_, 3(2): 144-155, doi: [10.1785/0320230013](https://doi.org/10.1785/0320230013).
+
+- Ji, C., A. Cabas, A. Kottke, M. Pilz, J. Macedo, and C. Liu (2023). A DesignSafe earthquake ground motion database for California and surrounding regions. _Earthquake Spectra_, 39(1): 702–721, doi: [10.1177/87552930221141108](https://doi.org/10.1177/87552930221141108).
+
+- Li, M., E.M. Rathje, J.P. Stewart, M.E. Ramos-Sepulveda, and Y.M. Hashash (2025). Regional adjustment to the NGA-East GMM for Texas, Oklahoma, and Kansas. _Earthquake Spectra_, doi: [10.1177/87552930251313817](https://doi.org/10.1177/87552930251313817).
 
-- Boyd OS, D. Churchwell, M.P. Moschetti, et al. (2024). Sediment thickness map of United States Atlantic and Gulf Coastal Plain Strata, and their influence on earthquake ground motions. _Earthquake Spectra_, 40(1):89-112. [https://doi.org/10.1177/87552930231204880](https://doi.org/10.1177/87552930231204880)
+- Mohammed, S., R. Shams, C.C. Nweke, T.E. Buckreis, M.D. Kohler, Y. Bozorgnia, and J.P. Stewart (2024). Usability of Community Seismic Network recordings for ground-motion modeling. _Earthquake Spectra_, 40(4): 2598-2622, doi: [10.1177/87552930241267749](https://doi.org/10.1177/87552930241267749).
 
-- Ji, C., A. Cabas, A. Kottke, M. Pilz, J. Macedo, C. Liu (2023). A DesignSafe earthquake ground motion database for California and surrounding regions. _Earthquake Spectra_, 39 (1): 702–721. [https://doi.org/10.1177/87552930221141108](https://doi.org/10.1177/87552930221141108)
+- Moschetti M.P., E.M. Thompson, J.M. Rekoske, M. Hearne, P. Powers, D. McNamara, and C. Tape (2019). Ground‐Motion Amplification in Cook Inlet Region, Alaska, from Intermediate‐Depth Earthquakes, Including the 2018  7.1 Anchorage Earthquake. _Seismological Research Letters_, 91(1): 142–152, doi: [10.1785/0220190179](https://doi.org/10.1785/0220190179).
 
-- Moschetti M.P., E.M. Thompson, J.M. Rekoske, M. Hearne, P. Powers, D. McNamara, C. Tape (2019). Ground‐Motion Amplification in Cook Inlet Region, Alaska, from Intermediate‐Depth Earthquakes, Including the 2018  7.1 Anchorage Earthquake. _Seismological Research Letters_, 91 (1): 142–152. [https://doi.org/10.1785/0220190179](https://doi.org/10.1785/0220190179)
+- Moschetti, M.P., B.T. Aagaard, S.K. Ahdi, J. Altekruse, O.S. Boyd, A.D. Frankel, J. Herrick, M.D. Petersen, P.M. Powers, S. Rezaeian, and A.M. Shumway (2024). The 2023 US national seismic hazard model: Ground-motion characterization for the conterminous United States. _Earthquake Spectra_, 40(2): 1158-1190, doi: [10.1177/87552930231223995](https://doi.org/10.1177/87552930231223995).
 
-- Parker G, A. Baltay (2022). Empirical Map‐Based Nonergodic Models of Site Response in the Greater Los Angeles Area. _Bulletin of the Seismological Society of America_, 112 (3): 1607–1629. [https://doi.org/10.1785/0120210175](https://doi.org/10.1785/0120210175)
+- Parker, G.A., and A.S. Baltay (2022). Empirical Map‐Based Nonergodic Models of Site Response in the Greater Los Angeles Area. _Bulletin of the Seismological Society of America_, 112(3): 1607–1629, doi: [10.1785/0120210175](https://doi.org/10.1785/0120210175)
 
-- Rekoske J.M., E.M. Thompson, M.P. Moschetti, M. Hearne, B.T. Aagaard, G. Parker (2020). The 2019 Ridgecrest, California, Earthquake Sequence Ground Motions: Processed Records and Derived Intensity Metrics. _Seismological Research Letters_, 91 (4): 2010–2023. [https://doi.org/10.1785/0220190292](https://doi.org/10.1785/0220190292)
+- Rekoske J.M., E.M. Thompson, M.P. Moschetti, M. Hearne, B.T. Aagaard, and G.A. Parker (2020). The 2019 Ridgecrest, California, Earthquake Sequence Ground Motions: Processed Records and Derived Intensity Metrics. _Seismological Research Letters_, 91(4): 2010–2023, doi: [10.1785/0220190292](https://doi.org/10.1785/0220190292)
 
 # Disclaimer
 

gmprocess-2.4.0/README.md

@@ -0,0 +1,54 @@
+# Introduction
+This is a project designed to provide a number of functions related to parsing and processing earthquake ground motion data, building on top of the [ObsPy](https://github.com/obspy/obspy/wiki) library.
+Most of the extensions that we provide are to handle strong motion data and related issues.
+
+
+# Documentation
+- Please note, we are in the process of improving the documentation and that there are some incomplete sections.
+- The full documentation can be viewed locally by running the `docs/makedocs.sh` script.
+- The documentation is also available [here](https://ghsc.code-pages.usgs.gov/esi/groundmotion-processing/).
+- The MATLAB functions included in the `tools/matlab` directory include a short [tutorial](tools/matlab/readme.md)
+
+# Getting Help
+The developers can be reached at [gmprocess@usgs.gov](mailto:gmprocess@usgs.gov).
+
+If you would like to post an issue to ask a question, request a new feature, or report a bug, you can do so at the [github mirror](https://github.com/DOI-USGS/ghsc-esi-groundmotion-processing) of this repository. 
+
+If you would like to contribute merge requests to this repository, please let us know and we can add you as a collaborator. 
+This will require that you create an account at code.usgs.gov, which is a more involved process than creating a personal account at gitub.com and posting to the issues on the github mirror.
+
+# Suggested Citation
+If you wish to cite this software please cite:
+
+- Thompson, E.M., M. Hearne, B.T. Aagaard, J.M. Rekoske, C.B. Worden, M.P. Moschetti, H.E. Hunsinger, G.C. Ferragut, G.A. Parker, J.A. Smith, K.K. Smith, and A.R. Kottke (2024). USGS Automated Ground Motion Processing Software Version 2, U.S. Geological Survey software release, doi: [10.5066/P13HMKFJ](https://doi.org/10.5066/P13HMKFJ).
+
+- Thompson, E.M., M. Hearne, B.T. Aagaard, J.M. Rekoske, C.B. Worden, M.P. Moschetti, H.E. Hunsinger, G.C. Ferragut, G.A. Parker, J.A. Smith, Smith, K.K., and A.R. Kottke (2025). Automated, Near Real‐Time Ground‐Motion Processing at the US Geological Survey. _Seismological Research Letters_, 96(1), pp.538-553, doi: [10.1785/0220240021](https://doi.org/10.1785/0220240021).
+
+# Journal Articles
+The list below is a subset of articles that made use of this software in their study. If you would like to have an article added to this list, please open an issue or email the developers.
+
+- Ahdi, S.K., B.T. Aagaard, M.P. Moschetti, G.A. Parker, O.S. Boyd, and W.J. Stephenson (2024). Empirical ground-motion basin response in the California Great Valley, Reno, Nevada, and Portland, Oregon. _Earthquake Spectra_, 40(2): 1099-1131, doi: [10.1177/87552930241237250](https://doi.org/10.1177/87552930241237250).
+
+- Boyd OS, D. Churchwell, M.P. Moschetti, et al. (2024). Sediment thickness map of United States Atlantic and Gulf Coastal Plain Strata, and their influence on earthquake ground motions. _Earthquake Spectra_, 40(1): 89-112, doi: [10.1177/87552930231204880](https://doi.org/10.1177/87552930231204880).
+
+- Chatterjee, A., D.T. Trugman, G. Hirth, J. Lee, and V.C. Tsai (2024). High‐frequency ground motions of earthquakes correlate with fault network complexity. _Geophysical Research Letters_, 51(12), doi: [10.1029/2024GL109418](https://doi.org/10.1029/2024GL109418).
+
+- Hirakawa, E., G.A. Parker, A. Baltay, and T. Hanks (2023). Rupture directivity of the 25 October 2022 Mw 5.1 Alum Rock earthquake. _The Seismic Record_, 3(2): 144-155, doi: [10.1785/0320230013](https://doi.org/10.1785/0320230013).
+
+- Ji, C., A. Cabas, A. Kottke, M. Pilz, J. Macedo, and C. Liu (2023). A DesignSafe earthquake ground motion database for California and surrounding regions. _Earthquake Spectra_, 39(1): 702–721, doi: [10.1177/87552930221141108](https://doi.org/10.1177/87552930221141108).
+
+- Li, M., E.M. Rathje, J.P. Stewart, M.E. Ramos-Sepulveda, and Y.M. Hashash (2025). Regional adjustment to the NGA-East GMM for Texas, Oklahoma, and Kansas. _Earthquake Spectra_, doi: [10.1177/87552930251313817](https://doi.org/10.1177/87552930251313817).
+
+- Mohammed, S., R. Shams, C.C. Nweke, T.E. Buckreis, M.D. Kohler, Y. Bozorgnia, and J.P. Stewart (2024). Usability of Community Seismic Network recordings for ground-motion modeling. _Earthquake Spectra_, 40(4): 2598-2622, doi: [10.1177/87552930241267749](https://doi.org/10.1177/87552930241267749).
+
+- Moschetti M.P., E.M. Thompson, J.M. Rekoske, M. Hearne, P. Powers, D. McNamara, and C. Tape (2019). Ground‐Motion Amplification in Cook Inlet Region, Alaska, from Intermediate‐Depth Earthquakes, Including the 2018  7.1 Anchorage Earthquake. _Seismological Research Letters_, 91(1): 142–152, doi: [10.1785/0220190179](https://doi.org/10.1785/0220190179).
+
+- Moschetti, M.P., B.T. Aagaard, S.K. Ahdi, J. Altekruse, O.S. Boyd, A.D. Frankel, J. Herrick, M.D. Petersen, P.M. Powers, S. Rezaeian, and A.M. Shumway (2024). The 2023 US national seismic hazard model: Ground-motion characterization for the conterminous United States. _Earthquake Spectra_, 40(2): 1158-1190, doi: [10.1177/87552930231223995](https://doi.org/10.1177/87552930231223995).
+
+- Parker, G.A., and A.S. Baltay (2022). Empirical Map‐Based Nonergodic Models of Site Response in the Greater Los Angeles Area. _Bulletin of the Seismological Society of America_, 112(3): 1607–1629, doi: [10.1785/0120210175](https://doi.org/10.1785/0120210175)
+
+- Rekoske J.M., E.M. Thompson, M.P. Moschetti, M. Hearne, B.T. Aagaard, and G.A. Parker (2020). The 2019 Ridgecrest, California, Earthquake Sequence Ground Motions: Processed Records and Derived Intensity Metrics. _Seismological Research Letters_, 91(4): 2010–2023, doi: [10.1785/0220190292](https://doi.org/10.1785/0220190292)
+
+# Disclaimer
+
+Any use of trade, firm, or product names is for descriptive purposes only and does not imply endorsement by the U.S. Government.

{gmprocess-2.3.0 → gmprocess-2.4.0}/code.json

@@ -1,4 +1,45 @@
 [
+    {
+        "name": "groundmotion-processing",
+        "description": "Read and process ground motion waveform data",
+        "version": "v2.4.0",
+        "status": "Production",
+        "organization": "U.S. Geological Survey",
+        "vcs": "git",
+        "repositoryURL": "https://code.usgs.gov/ghsc/esi/groundmotion-processing.git",
+        "homepageURL": "https://code.usgs.gov/ghsc/esi/groundmotion-processing",
+        "downloadURL": "https://code.usgs.gov/ghsc/esi/groundmotion-processing/-/archive/v2.4.0/groundmotion-processing-v2.4.0.zip",
+        "disclaimerURL": "https://code.usgs.gov/ghsc/esi/groundmotion-processing/-/raw/v2.4.0/DISCLAIMER.md",
+        "permissions": {
+            "licenses": [
+                {
+                    "name": "Public Domain, CC0-1.0",
+                    "URL": "https://code.usgs.gov/ghsc/esi/groundmotion-processing/-/raw/v2.4.0/LICENSE.md"
+                }
+            ],
+            "usageType": "openSource",
+            "exemptionText": null
+        },
+        "laborHours": 1,
+        "languages": [
+            "python"
+        ],
+        "tags": [
+            "earthquake",
+            "impact",
+            "strong motion",
+            "amplitudes",
+            "ground motion",
+            "usg-artificial-intelligence"
+        ],
+        "contact": {
+            "name": "Eric Thompson",
+            "email": "emthompson@usgs.gov"
+        },
+        "date": {
+            "metadataLastUpdated": "2025-04-04"
+        }
+    },
     {
         "name": "groundmotion-processing",
         "description": "Read and process ground motion waveform data",

{gmprocess-2.3.0 → gmprocess-2.4.0}/src/gmprocess/apps/gmrecords.py

@@ -357,7 +357,7 @@ class GMrecordsApp(object):
                 "(1) a single column with ComCat event IDs, or "
                 "(2) six columns in which those columns are: "
                 "event_id (string, no spaces), time (any ISO standard for date/time), "
-                "latitutde (float, decimal degrees), longitude (float, decimal "
+                "latitude (float, decimal degrees), longitude (float, decimal "
                 "degrees), depth (float, km), magnitude (float), and magnitude type "
                 "(string)."
             ),

{gmprocess-2.3.0 → gmprocess-2.4.0}/src/gmprocess/bin/cwa_gather.py

@@ -111,6 +111,7 @@ class App:
             msg = "Failed to download STREC results."
         print(msg)
 
+
 def cli():
     """Command line interface to the cwa_gather application."""
 
@@ -133,7 +134,7 @@ def cli():
      - For "Channel", choose "HN?" for all strong motion stations.
      - For "Start Time (UTC)", enter a date before the event of interest.
      - For "End Time (UTC)", enter a date after the event of interest.
-     - "Label", doesn't matter becasue they don't use what you put here.
+     - "Label", doesn't matter because they don't use what you put here.
      - Click the "Submit" button, and you should see a "Success!" pop up.
      - Next will be a screen showing a list of all of your downloads.
      - Right click on the most recent entry, it will be called "output.stationXML"
@@ -228,5 +229,6 @@ def cli():
     app = App()
     app.main(args.event_id, args.datafile, args.metadata)
 
+
 if __name__ == "__main__":
     cli()

{gmprocess-2.3.0 → gmprocess-2.4.0}/src/gmprocess/core/stationstream.py

@@ -103,7 +103,7 @@ class StationStream(Stream):
                             if not isinstance(trace, StationTrace):
                                 raise ValueError(
                                     "Input Traces to StationStream must be of subtype "
-                                    "StationTrace unless an invenotry is also provided."
+                                    "StationTrace unless an inventory is also provided."
                                 )
                         else:
                             if not isinstance(trace, StationTrace):
@@ -136,23 +136,27 @@ class StationStream(Stream):
 
                     # If not, resample
                     if not success:
-                        for tr in self.traces:
-                            tr.interpolate(
-                                sampling_rate=1 / new_delta,
-                                method="lanczos",
-                                starttime=newstart,
-                                npts=new_npts,
-                                a=N_LANCZOS,
-                            )
-                            tr.set_provenance(
-                                "interpolate",
-                                {
-                                    "interpolation_method": "lanczos",
-                                    "new_number_of_samples": new_npts,
-                                    "new_start_time": newstart,
-                                    "a": N_LANCZOS,
-                                },
-                            )
+                        try:
+                            for tr in self.traces:
+                                tr.interpolate(
+                                    sampling_rate=1 / new_delta,
+                                    method="lanczos",
+                                    starttime=newstart,
+                                    npts=new_npts,
+                                    a=N_LANCZOS,
+                                )
+                                tr.set_provenance(
+                                    "interpolate",
+                                    {
+                                        "interpolation_method": "lanczos",
+                                        "new_number_of_samples": new_npts,
+                                        "new_start_time": newstart,
+                                        "a": N_LANCZOS,
+                                    },
+                                )
+                        except BaseException:
+                            for tr in self.traces:
+                                tr.fail("Traces within stream are misaligned.")
             else:
                 # start/end times may be different but within tolerance
                 # to prevent further issues downstream, setting these
@@ -164,7 +168,7 @@ class StationStream(Stream):
                         if not isinstance(trace, StationTrace):
                             raise ValueError(
                                 "Input Traces to StationStream must be of subtype "
-                                "StationTrace unless an invenotry is also provided."
+                                "StationTrace unless an inventory is also provided."
                             )
                     else:
                         if not isinstance(trace, StationTrace):
@@ -273,7 +277,7 @@ class StationStream(Stream):
         return self.id
 
     def get_net_sta(self):
-        """Get just the network and station compopnent of the ID."""
+        """Get just the network and station component of the ID."""
         return ".".join(self.get_id().split(".")[0:2])
 
     def get_net_sta_loc(self):

{gmprocess-2.3.0 → gmprocess-2.4.0}/src/gmprocess/core/stationtrace.py

@@ -192,14 +192,30 @@ class StationTrace(Trace):
 
         # Sometimes the channel names do not indicate which one is the
         # Z channel. If we have vertical_orientation information, then
-        # let's get that and change the vertical channel to end in Z.
+        # let's get that and change the vertical channel to end in Z
+        # as long as the channel name does not include the direction (E, N, Z).
+        # Some inventory files mistakenly include a vertical orientation for horizontal channels.
         #     NOTE: `vertical_orientation` here is defined as the angle
         #           from horizontal (aka, dip), not inclination.
         if not np.isnan(header["standard"]["vertical_orientation"]):
             delta = np.abs(np.abs(header["standard"]["vertical_orientation"]) - 90.0)
-            is_z = header["channel"].endswith("Z")
-            if delta < MAX_DIP_OFFSET and not is_z:
-                header["channel"] = header["channel"][0:-1] + "Z"
+            is_horizcomp = header["channel"][-1] in ["E", "N"]
+            is_vertcomp = header["channel"][-1] in ["Z"]
+            if delta < MAX_DIP_OFFSET:
+                trace_id = f"{header['network']}.{header['station']}.{header['location']}.{header['channel']}"
+                if is_vertcomp:
+                    pass
+                elif is_horizcomp:
+                    logging.warning(
+                        "Found vertical orientation in trace %s, which seems to be a horizontal component. Assuming vertical orientation is incorrect.",
+                        trace_id,
+                    )
+                else:
+                    header["channel"] = header["channel"][0:-1] + "Z"
+                    logging.warning(
+                        "Found vertical orientation in trace %s. Component direction is unknown from channel name, so renaming channel to vertical component 'Z'.",
+                        trace_id,
+                    )
 
         super(StationTrace, self).__init__(data=data, header=header)
         self.provenance = TraceProvenance(self.stats)
@@ -283,6 +299,10 @@ class StationTrace(Trace):
         """Has this trace passed checks?"""
         return not self.has_parameter("failure")
 
+    @property
+    def is_horizontal(self):
+        return "z" not in self.stats.channel.lower()
+
     def validate(self):
         """Ensure that all required metadata fields have been set.
 
@@ -480,14 +500,14 @@ class StationTrace(Trace):
             type (str):
                  Method to use for detrending.
         """
-
-        self.set_provenance(
-            "detrend",
-            {
-                "detrending_method": type,
-            },
-        )
-        return super().detrend(type=type)
+        prov_dict = {"detrending_method": type}
+        if type in ["constant", "demean"]:
+            prov_dict["value"] = np.mean(self.data)
+            self.data = np.array(self.data, dtype=float) - prov_dict["value"]
+        else:
+            super().detrend(type=type)
+        self.set_provenance("detrend", prov_dict)
+        return self
 
     def trim(
         self,
@@ -515,7 +535,7 @@ class StationTrace(Trace):
             fill_value (int, float):
                 Fill value for gaps.
             suppress_provenance (bool):
-                Do not put a provenance entry. Useful becasue we need a custom
+                Do not put a provenance entry. Useful because we need a custom
                 provenance entry for zero padding, which calls this method.
         """
         if not suppress_provenance:
@@ -623,9 +643,8 @@ class StationTrace(Trace):
         zerophase=False,
         config=None,
         frequency_domain=True,
-        **options,
     ):
-        """Overwrite parent function to allow for conf options.
+        """Overwrite parent function to allow for configuration options.
 
         Args:
             type (str):
@@ -666,7 +685,6 @@ class StationTrace(Trace):
                     freq=freq,
                     corners=corners,
                     zerophase=zerophase,
-                    **options,
                 )
 
             else:
@@ -706,7 +724,6 @@ class StationTrace(Trace):
                     freq=freq,
                     corners=corners,
                     zerophase=zerophase,
-                    **options,
                 )
 
             else:
@@ -748,7 +765,6 @@ class StationTrace(Trace):
                     freqmax=freqmax,
                     corners=corners,
                     zerophase=zerophase,
-                    **options,
                 )
 
             else:
@@ -790,7 +806,6 @@ class StationTrace(Trace):
                     freqmax=freqmax,
                     corners=corners,
                     zerophase=zerophase,
-                    **options,
                 )
 
             else:

{gmprocess-2.3.0 → gmprocess-2.4.0}/src/gmprocess/core/streamcollection.py

@@ -60,7 +60,7 @@ class StreamCollection(StreamArray):
                 List of StationStream objects.
             drop_non_free (bool):
                 If True, drop non-free-field Streams from the collection.
-            hande_duplicates (bool):
+            handle_duplicates (bool):
                 If True, remove duplicate data from the collection.
             max_dist_tolerance (float):
                 Maximum distance tolerance for determining whether two streams
@@ -74,7 +74,7 @@ class StreamCollection(StreamArray):
                 which process level is the most preferred (most preferred goes
                 first in the list).
             format_preference (list):
-                A list continaing strings of the file source formats (found
+                A list containing strings of the file source formats (found
                 in gmprocess.io). Does not need to list all of the formats.
                 Example: ['cosmos', 'dmg'] indicates that cosmos files are
                 preferred over dmg files.
@@ -179,32 +179,19 @@ class StreamCollection(StreamArray):
                 if event.magnitude > m:
                     dist_thresh = d
 
-        # Create a list of streams with matching id (combo of net and station).
-        all_matches = []
-        match_list = []
-        for idx1, stream1 in enumerate(self):
-            cond1 = idx1 in all_matches
-            cond2 = not stream1.passed
-            if cond1 or cond2:
+        # Create a dict of colocated streams.
+        # net_sta -> array of indices for matching stations in stream
+        match_list = {}
+        for i_st, stream in enumerate(self):
+            if not stream.passed:
                 continue
-            matches = [idx1]
-            net_sta = stream1.get_net_sta()
-            for idx2, stream2 in enumerate(self):
-                cond1 = idx1 != idx2
-                cond2 = idx1 not in all_matches
-                cond3 = net_sta == stream2.get_net_sta()
-                cond4 = stream2.passed
-                if cond1 and cond2 and cond3 and cond4:
-                    matches.append(idx2)
-            if len(matches) > 1:
-                match_list.append(matches)
-                all_matches.extend(matches)
+            net_sta = stream.get_net_sta()
+            if not net_sta in match_list:
+                match_list[net_sta] = [i_st]
             else:
-                if matches[0] not in all_matches:
-                    match_list.append(matches)
-                    all_matches.extend(matches)
+                match_list[net_sta].append(i_st)
 
-        for group in match_list:
+        for group in match_list.values():
             # Are there colocated instruments for this group?
             if len(group) > 1:
                 # If so, loop over list of preferred instruments
@@ -433,8 +420,7 @@ class StreamCollection(StreamArray):
 
         traces = []
         for st in self.streams:
-            for tr in st:
-                traces.append(tr)
+            traces += [tr for tr in st]
         preferred_traces = []
 
         for tr_to_add in traces: