-
Notifications
You must be signed in to change notification settings - Fork 2
Home
SpRĪT (HVSR): Spectral Ratio Investigation Toolset (Horizontal Vertical Spectral Ratio)
The Horizontal to Vertical Spectral Ratio (HVSR) technique is a method used to analyze ambient seismic noise to calculate the dominant frequency at a site.
This package will allow ambient seismic data to be read in the most common seismic data formats, and will perform Horizontal Vertical Spectral Ratio (HVSR) analysis on the data. H/V analysis was standardized and popularized by the Site EffectS assessment using AMbient Excitations (SESAME) project, with a comprehensive final report issued in 2003.1 This SESAME project and its J-SESAME pacakge were crucial in the developing of the HVSR technique, and the outputs aided in the development of this software package.
This python package is built in large part off the Incorporated Research Institutions in Seismology (IRIS) Horizontal to Vertical Spectral Ratio (HVSR) processing package.2 Specifically, the computeHVSR.py tools that enable the ability to rank HVSR peaks, calculate data quality and peak quality, and the combining of the horizontal components was adapted directly from that package. Because the SpRĪT package is intended to be used to analyze data from rapid field data acquisitions (less than an hour per site), much of the IRIS package was adapted from daily to HV curve calculations to sub-hourly and even sub-minute HV calculations. Because there is limited data, there is no baseline to compare to, so that element is excluded from this package.
That version is intended to read data from the IRIS Data Management Center (DMC) MUSTANG online service,3 which is a toolbox that provides processes for enabling data quality analysis services to data archived in the DMC. For example, a simple service query can extract power spectral density estimates, noise spectrograms, H/V plots, etc.
For guidelines on acquisition, processing, and interpration of H/V data, see: http://sesame.geopsy.org/Papers/HV_User_Guidelines.pdf.
Sprit may be installed from the pypi repository using the pip command in a command line terminal:
pip install sprit
The sprit package is in active development. If sprit is already installed and/or you would like to ensure you have the most up-to-date release, add the --upgrade argument (pip install sprit --upgrade) to ensure you have the latest version. If there are prerelease versions newer than the most recent stable version, you can also use the --pre flag to try those out. pip install sprit --pre
It is recommended to perform this task this in a virtual environment. For information on creating virtual environments in python, see this page. For the creation of anaconda environments, see here. Note that it is not officially recommended to use pip repositories in anaconda environments, but it often works without any issues. Inclusion of sprit in the conda-forge repository is expected to be completed soon.
For troubleshooting issues with installation or usage of the sprit package, see the Troubleshooting page of the wiki.
SpRĪT can be used directly using a python API, using a graphical user interface (GUI), or using a command-line interface (CLI).
If you are just learning how to use SpRĪT, the Python API and the API documentation are the recommended places to begin. See the appropriate section for workflows for each interface option(s):
Also see more information at the API Documentation page here.
This package is still a work in progress. Any feedback is appreciated, but may not be able to be implemented. Please consult the Troubleshooting wiki page, then use the Issues tab to report any issues.
If you use the sprit package in your research, please use one of the following citations:
Riley Balikian, Hongyu Xaio, Alexandra Sanchez. SPRIT HVSR: An open-source software package for processing, analyzing, and visualizing ambient seismic vibrations. Proceedings of the Geological Society of America, 2023. Pittsburgh, PA.
For the software itself:
Riley Balikian. (2024). RJbalikian/SPRIT-HVSR: SpRIT HVSR Initial Release (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.11035542
MIT license
Copyright (c) 2023 RJbalikian
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.