rfsed

rfsed: Receiver function analysis and dealing with sediment effects - Published in JOSS (2024)

https://github.com/akinremisa/rfsed

Science Score: 93.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 19 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Last synced: 4 months ago · JSON representation

Repository

Package for standard and sediment correction receiver functions analysis

Basic Info
  • Host: GitHub
  • Owner: akinremisa
  • License: bsd-3-clause
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 143 MB
Statistics
  • Stars: 13
  • Watchers: 3
  • Forks: 2
  • Open Issues: 2
  • Releases: 3
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

rfsed logo

A software for receiver functions analysis and dealing with sediment effects

python version pypi version JOSS DOI

rfsed is developed specifically to implement different techniques of analysing receiver functions from stations overlying sedimentary layers. The software is adaptable, efficient, and easy-to-use for different analysis of receiver functions obtained from stations overlying sedimentary layers.

Receiver functions techniques implemented in rfsed are: + H-k stacking (one layer) of Zhu and Kanamori (2000) + Sequential H-k stacking (two layers) of Yeck et al., (2013) + Resonance filtering and modified H-k stacking of Yu et al., (2015) + H-k stacking and Waveform Fitting (two-step method) of Akinremi et al., (2024) + Analysis of the synthetic reciever functions with the above-mentioned methods.

Beside these receiver function methods, rfsed has the following features: + Extracting earthquake data from local seismic record files. + Multiprocessing options for waveform fitting and extracting earthquake data from local seismic record files. + Creating publication quality figures for the results of the analysis.

Receiver functions streams in the rfsed are handled by the RFStream class of the rf open software, and it inherits a lot of useful methods from the Obspy class Stream. It is supported via the obspyh5 package. For more information on class RFStream, see documentation on rf. In the rfsed modules to extract earthquake data from local seismic records, read and write support for necessary metadata is provided for SAC, SeismicHanlder and HDF5 formats based on ObsPy.

Installation and testing of this software

Installation from PyPi

The easiest way to install rfsed is via pip::

bash pip install rfsed

Installation development version from source code

To obtain the latest updates, you can install rfsed from the source code from available on GitHub.

Clone the rfsed repository from GitHub bash git clone https://github.com/akinremisa/rfsed.git Change directory to the same directory that this repo is in bash cd rfsed Installing using pip bash pip install .

Test the rfsed software

You can test the software using pytest by running this command in the software directory and will look for all available tests in the current directory and subdirectories recursively

bash pytest Or run individual tests in the /tests/ directory

Getting started

Access rfsed's documentation here.

rfsed comes with tutorials that demonstrates all its methods. See the documentation for more details.

Reporting Bugs / Contact the developers

This version is an early release of rfsed. If you encounter any issues or unexpected behaviour, please open an issue on GitHub.

Questions?

If you have any questions about the software, please use the discussions feature

Contributing

All contributions are welcome ... e.g. report bugs, discuss or add new features.

Citing rfsed

If you use rfsed in your work, please consider citing the following paper. + Akinremi S., Fadel, I., & van der Meijde, M, (2024). rfsed: Receiver function analysis and dealing with sediment effects. Journal of Open Source Software, 9(100), 6612, https://doi.org/10.21105/joss.06612

References

  • Akinremi, S., van der Meijde, M., Thomas, C., Afonso J. C., Ruigrok E., Fadel, I. (2024). Waveform fitting of receiver functions for enhanced retrieval of crustal structure in the presence of sediments. Journal of Geophysical Research: Solid Earth, 5(129). https://doi.org/10.1029/2023JB028393
  • Tom Eulenfeld T., (2020). rf: Receiver function calculation in seismology. Journal of Open Source Software, 5(48), 1808, https://doi.org/10.21105/joss.01808
  • Yeck, W. L., Sheehan, A. F., & Schulte-Pelkum, V. (2013). Sequential h-k stacking to obtain accurate crustal thicknesses beneath sedimentary basins. Bulletin of the Seismological Society of America, 103, 2142-2150. https://doi.org/10.1785/0120120290
  • Yu, Y., Song, J., Liu, K. H., & Gao, S. S. (2015). Determining crustal structure beneath seismic stations overlying a low-velocity sedimentary layer using receiver functions. Journal of Geophysical Research: Solid Earth, 120 , 3208-3218. https://doi.org/10.1002/2014JB011610
  • Zhu, L., & Kanamori, H. (2000). Moho depth variation in southern California from teleseismic receiver functions. Journal of Geophysical Research: Solid Earth, 105, 2969-2980. https://doi.org/10.1029/1999jb900322

Related receiver function projects

  • rf including calculation of receiver functions
  • seispy including hk-stacking
  • RFPy including hk-stacking, harmonic decomposition
  • BayHunter inversion of receiver functions and surface wave dispersion
  • telewavesim teleseismic body wave modeling through stacks of anisotropic layers
  • PyGLImER including common conversion point imaging

Owner

  • Login: akinremisa
  • Kind: user

JOSS Publication

rfsed: Receiver function analysis and dealing with sediment effects
Published
August 22, 2024
Volume 9, Issue 100, Page 6612
Authors
Stephen Akinremi ORCID
Faculty of Geo-Information Science and Earth Observation (ITC), University of Twente, Enschede, The Netherlands
Islam Fadel ORCID
Faculty of Geo-Information Science and Earth Observation (ITC), University of Twente, Enschede, The Netherlands
Mark van der Meijde ORCID
Faculty of Geo-Information Science and Earth Observation (ITC), University of Twente, Enschede, The Netherlands
Editor
Jayaram Hariharan ORCID
Tags
geophysics seismology receiver functions sediment effects Moho discontinuity

GitHub Events

Total
  • Watch event: 4
  • Fork event: 1
Last Year
  • Watch event: 4
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 456
  • Total Committers: 2
  • Avg Commits per committer: 228.0
  • Development Distribution Score (DDS): 0.013
Past Year
  • Commits: 14
  • Committers: 1
  • Avg Commits per committer: 14.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
akinremisa 1****a 450
FadelI i****l@u****l 6
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 3
  • Total pull requests: 0
  • Average time to close issues: 3 months
  • Average time to close pull requests: N/A
  • Total issue authors: 3
  • Total pull request authors: 0
  • Average comments per issue: 4.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • alistairboyce11 (1)
  • paudetseis (1)
  • elbeejay (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 74 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 21
  • Total maintainers: 1
pypi.org: rfsed

Package for receiver functions analysis and dealing with sediment effects in receiver functions

  • Versions: 20
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 74 Last month
Rankings
Dependent packages count: 9.9%
Forks count: 29.8%
Average: 36.6%
Stargazers count: 38.9%
Dependent repos count: 67.7%
Maintainers (1)
Last synced: 4 months ago
pypi.org: rfak

A small example package

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 9.9%
Average: 38.8%
Dependent repos count: 67.7%
Maintainers (1)
Last synced: 4 months ago

Dependencies

pyproject.toml pypi
  • OWSLib *
  • cartopy *
  • decorator *
  • geographiclib *
  • h5 *
  • h5py *
  • importlib-metadata python_version>">=3.6"
  • matplotlib >=2
  • numpy *
  • obspy >=1.0.3
  • obspyh5 *
  • rf *
  • scikit-learn *
  • scipy *
  • seaborn *
  • shapely *
  • tqdm *
setup.py pypi
.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite