hvsrprocpy
A python package for performing microtremor and earthquake record processing to develop horizontal-to-vertical spectral ratios (HVSR).
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
✓Academic publication links
Links to: springer.com, zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.6%) to scientific vocabulary
Keywords
Repository
A python package for performing microtremor and earthquake record processing to develop horizontal-to-vertical spectral ratios (HVSR).
Basic Info
- Host: GitHub
- Owner: fjornelas
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://fjornelas.github.io/hvsrprocpy/
- Size: 33 MB
Statistics
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
- Releases: 6
Topics
Metadata Files
README.md
hvsrprocpy
A python library that performs Horizontal-to-Vertical Spectral Ratio (HVSR) processing.
Authors
Francisco Javier G. Ornelas1, Pengfei Wang2, Scott J. Brandenberg1, Jonathan P. Stewart1
1 University of California, Los Angeles (UCLA)
2 Old Dominion University
Table of Contents
Introduction
A python library that can perform Horizontal-to-Vertical Spectral
Ratio (HVSR) processing from recordings of microtremors or earthquakes from 3-component
seismometers. This library was developed by Francisco Javier G. Ornelas under the supervision
of Dr. Jonathan P. Stewart and Dr. Scott J. Brandenberg at the University of California, Los Angeles (UCLA).
Other contributions came from Dr. Pengfei Wang a professor at Old Dominion University, who wrote hvsrProc
a rstudio package, which this python library is based on. That work can be found here:
Wang, P. wltcwpf/hvsrProc: First release (Version v1.0.0). Zenodo. http://doi.org/10.5281/zenodo.4724141
Background
HVSR is derived from ratios of the horizontal and vertical components of a Fourier Amplitude Spectrum (FAS) from a 3-component recording of microtremors or earthquakes. This is done by recording ground vibrations either from temporarily-deployed or permanently-installed seismometers, for a relatively short period of time (~1-2 hrs) or a longer period of time.
This method or technique was first proposed by Nogoshi and Igarashi (1971) [ABSTRACT] and later popularized by Nakamura (1989) [ABSTRACT]. The method works by assuming that the horizontal wavefield is amplified as seismic waves propagate through the soil deposits compared to the vertical wavefield.
HVSR can be useful in site characterization since it can identify resonant frequencies at sites, through peaks in an HVSR spectrum. Studies have also found that the lowest peak in HVSR spectra can be associated with the fundamental frequency of a site (e.g., [ABSTRACT]).
Getting started
Installation
hvsrprocpy is available using pip and can be installed with:
- Jupyter Notebook
pip install hvsrprocpy - PyPI
py -m pip install hvsrprocpy## Usage
hvsrprocpy is a library that performs hvsr related processing. The library contains various features, such as:
- Manual selection of windows in the time domain and the frequency domain.
- Rotated HVSR to see the azimuthal variability of HVSR.
- Different distibutions such as normal or log-normal.
- Different smoothing functions such as Konno and Ohmachi and Parzen smoothing.
- Different type of horizontal combinations, such as geometric mean, squared average, and RotD50.
- Various outputs such as mean FAS and HVSR, selected HVSR and ts, and rotated HVSR.
Examples of these can be found under the examples folder in the Github repository [GIT]
Example of manual window selection on time series

Example of manual window selection on HVSR

Example of azimuthal plots

Example of Mean Curve plot with Metadata

Example comparisons of Konno and Ohmachi (left) and Parzen smoothing (right) on FAS
Citation
If you use hvsrprocpy (directly or as a dependency of another package) for work resulting in an academic publication or other instances, we would appreciate if you cite the following:
Ornelas, F. J. G., Wang, P., Brandenberg, S. J., & Stewart, J. P. (2024). hvsrprocpy (Version 1.1.0) [Computer software]. https://doi.org/10.5281/zenodo.13352470
Issues
Please report any issues or leave comments on the Issues page.
License
This project has been licensed under
more information about the license can be found here [LICENSE].
Acknowledgements
We would also like to thank the many others who aided in the development of this python library, these are:
- John Stapleton
- Chukwuma Okonkwo
- Chukwuebuka C. Nweke
- Tristan Buckreis
- Christopher de la Torre
for their support in helping develop this python library.
Owner
- Login: fjornelas
- Kind: user
- Repositories: 1
- Profile: https://github.com/fjornelas
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Ornelas
given-names: Francisco Javier G.
orcid: https://orcid.org/0009-0008-3798-6332
- family-names: Wang
given-names: Pengfei
orcid: https://orcid.org/0000-0002-2844-4557
- family-names: Brandenberg
given-names: Scott J.
orcid: https://orcid.org/0000-0003-2493-592X
- family-names: Stewart
given-names: Jonathan P.
orcid: https://orcid.org/0000-0003-3602-3629
title: "hvsrprocpy"
version: 1.1.0
doi: 10.5281/zenodo.13352470
date-released: 2024-09-04
repository-code: https://doi.org/10.5281/zenodo.13352470
GitHub Events
Total
- Watch event: 1
- Fork event: 1
Last Year
- Watch event: 1
- Fork event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 2,117 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: hvsrprocpy
A python library for performing horizontal-to-vertical spectral ratio (HVSR) processing
- Homepage: https://github.com/fjornelas/hvsrprocpy
- Documentation: https://hvsrprocpy.readthedocs.io/
- License: GNU General Public License v3
-
Latest release: 1.1.0
published almost 2 years ago
Rankings
Maintainers (1)
Dependencies
- matplotlib *
- mplcursors *
- numpy *
- obspy *
- os *
- pandas *
- warnings *
- actions/checkout v2 composite
- actions/setup-python v2 composite
- peaceiris/actions-gh-pages v3 composite
- Pygments *
- jupyter-book *
- matplotlib *
- numpy *