Releases: jpvantassel/hvsrpy
Release list
v2.1.0
In this release:
- 🐛 Support real SAF values
- ✨ Trim MSEED, GCF, and SAC time series to common length by default, see #34
- ✨ Add verbose flag to read to assist in debugging file reads
- ✨ Allow "123" and "XYZ" component naming, see #36
- 📚 New all-in-one example
- 📚 Add example to highlight typical file formatting issues, see #37
- 📚 Update citations to include Vantassel (2025)
- 🔧 Remove PyQt5 as a dependency
- 🔨 Improve code quality and test coverage
v2.0.0
The release of v2.0.0 of hvsrpy is a culmination of approximately 2 years of development and has resulted in almost a complete rewrite of the package. hvsrpy v2.0.0 includes all previous functionality and many new features requested by the community:
✨ Ability to process earthquake and microtremor data.
✨ Support for all common earthquake and microtremor file types (see Issue #8 for details).
✨ Multiple approaches for Fourier spectra smoothing.
✨ Multiple approaches for window rejection (e.g., STA/LTA, Cox et al. (2020), Manual, ...).
✨ Support for Python versions 3.8 to 3.12.
✨ Multiple approaches for combining horizontal components (e.g., geometric mean, RotD50, squared average ...)
✨ Multiple processing approaches (traditional, azimuthal, diffuse field)
✨ Overhaul of the input-output (IO) for processing settings and HVSR results such that they can be shared for reproducible results.
✨ Post-processing tools for quickly presenting HVSR results (e.g., plotting tools, automatic SESAME checks, ...)
✨ 12 example notebooks that demonstrate the breadth of the hvsrpy package.
v1.0.0
In this release
- ✨ Add support for Python 3.9.
- ✨ Add total number of windows to
HvsrRotatedsummary file. - ✨ Add command line interface (see #12).
- 🐎 Add multiprocessing to command line interface for improved performance.
- 🔒 Remove exec call for reading version number.
- 💥 Rename master to main.
- 🔧 Remove Python 3.8 from local tox tests.
- 📚 Update documentation to include command line interface.
- 📚 Other various documentation updates.
v0.5.2
In this release
- 🐛 Fix to Issue #13.
- 🔨 Parsing of
f_lowandf_highinparse_hvsrpy_outputfor use with SESAME. - 📚 Updates to README and documentation.
v0.5.1
In this release
- 🐛 Fix bug related to
f0_mcwhen using upper and lower frequency limits. - 💥 Remove reference to
WindowedTimeSeriesandFourierTransformSuitein compliance with recentsigpropyrelease. - 🔨 Refactor methods to remove superfluous if statements after aforementioned removals.
- ✅ Improve
testtools.pyto be more performant and easier to understand. - ✅ Increase unit test coverage.
- 📚 Various updates to API documentation.
v0.5.0
In this release
- ✨ Add
f_lowandf_highkwargs for peak selection to simplify processing of HVSR curves with multiple peaks. - 💥 Deprecate use of
log-normalas a function/method argument and replace withlognormal. - 🔨 Treat HVSR amplitude from a single window as a 2D tensor for consistency with those from multiple windows.
- 🔨 Change
valid_window_indicesproperty to boolean array of constant length, rather than index array of non-constant length. - 📚 Add examples of HVSR statistics to
README.mdand other general documentation improvements.
v0.4.2
In this release
- 🐛 Fix in response to issue #7.
v0.4.1
In this release
- 🐛 Fix in
azimuthal_hvsrpy_interface.ipynb, remove 180 degrees from statistical calculation but keep for plotting. - ✨ Allow the use of 3 separate 1-component miniSEED files in
hvsrpy.Sensor1c.from_mseedwith addition offnames_1cargument. - ✨ Add SESAME (2004) reliability and clarity checking to
simple_hvsrpy_interface.ipynb. - 🎨 Add combination method and azimuth to the output file for
simple_hvsrpy_interface.ipynb. - 🎨 Add number of accepted and rejected windows to output file for
azimuthal_hvsrpy_interface.ipynb. - 🎨 Change methods "azimuth"->"single-azimuth" and "rotate"->"multiple-azimuths" to be more descriptive.
- ✅ Improved test coverage.
- 🔧 Add
__version__to package to ensure consistency in output files and docs.
v0.4.0
In this release
- ✨ New spatial statistics module.
- 📚 New user-friendly jupyter notebook for computing spatial statistics.
- 📚 Extended documentation.
- 🎨 Various other minor improvements.
v0.3.0
In this release
- ✨ A new class definition
HvsrRotatedfor HVSR calculations considering azimuth. - ✨ A new notebook
azimuthal_hvsrpy_interface.ipynbspecifically for azimuthal calculations. - ✅ Significantly improved test coverage.
- 🐎 Various performance improvements.
- 📖 Various improvements to the documentation.