eqcorrscan

Earthquake detection and analysis in Python.

https://github.com/eqcorrscan/eqcorrscan

Science Score: 46.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 24 committers (8.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.2%) to scientific vocabulary

Keywords

cross-correlation detection earthquake-detection earthquakes matched-filtering python repeating-earthquakes seismology subspace template-matching

Keywords from Contributors

sequences distributed annotation interactive ecosystem-models embedded networking weather state-management interpreter
Last synced: 6 months ago · JSON representation

Repository

Earthquake detection and analysis in Python.

Basic Info
Statistics
  • Stars: 178
  • Watchers: 17
  • Forks: 91
  • Open Issues: 36
  • Releases: 37
Topics
cross-correlation detection earthquake-detection earthquakes matched-filtering python repeating-earthquakes seismology subspace template-matching
Created almost 11 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog

README.md

EQcorrscan

A python package for the detection and analysis of repeating and near-repeating earthquakes.

Citation:

We have a manuscript on the development of EQcorrscan, if you make use of EQcorrscan please cite the following paper:

Chamberlain, C. J., Hopp, C. J., Boese, C. M., Warren-Smith, E., Chambers, D., Chu, S. X., Michailos, K., Townend, J., EQcorrscan: Repeating and near-repeating earthquake detection and analysis in Python. Seismological Research Letters 2017

If you want to you should also cite the version number: DOI

Installation

The easiest way to install EQcorrscan is through anaconda: Anaconda-Server Badge

Instructions for installing EQcorrscan and the required dependency, fftw are linked from the docs

Updates

If you want to be kept informed about releases, bug-tracking and enhancements without having to keep looking on github, subscribe to our google group.

Documentation

The full documentation for this package can be found here: Docs. Any errors including typos and just missing bits can either be fixed by you, or flagged in the issues tab here. We host our docs on readthedocs, which uses sphinx to scrape the docstrings in the codes, so it is simple to match the docs to the codes and change the docstrings.

Contributing

Please fork this project and work on it there then create a pull request to merge back to this main repository. Please create a branch from develop.

When you make changes please run the tests in the test directory to ensure everything merges with minimum effort. If there is not yet a test to cope with your changes then please write one.

Please document your functions following the other documentation within the functions, these doc-scripts will then be built into the main documentation using Sphinx.

Functionality

This package contains routines to enable the user to conduct matched-filter earthquake detections using obspy bindings when reading and writing seismic data, as well as subspace detection, brightness source-scanning, relative moment calculation using singular-value decomposition, and correlation pick-adjustment for similar events.

Also within this package are: * Clustering routines for seismic data; * Peak finding algorithm (basic, but appropriate for noisy data); * Automatic amplitude picker for local magnitude scale; * Obspy.core.event integration, which opens up lots of other functions (Seishub, hypoDDpy etc.); * Stacking routines including phase-weighted stacking based on Thurber at al. (2014); * Brightness based template creation based on the work of Frank et al. (2014); * Singular Value Decomposition derived magnitude calculations based on Rubinstein & Ellsworth (2010).

The code-base has grown to be quite large - it is probably worth having a look at the docs to check what functions we have. We are writing a series of tutorials included on the EQcorrscan API to highlight key functions.

A note on correlation precision EQcorrscan computes normalised cross-correlations in the frequency-domain using the fftw (Fastest Fourier Transform in the West). Internally the C routines enforce double-precision (64-Bit floating point numbers) for all aspects of the cross-correlations (despite requiring 32-Bit float input and output). Results in testing are accurate to within ~0.0001 of time-domain cross-correlation results.

Test status

Note that tests for travis and appveyor are run daily on master as cron jobs, and may reflect time-out issues.

| Service tests | Badge | |---------------|-------| | CI checks | test | Code coverage | codecov

Licence

This package is written and maintained by the EQcorrscan developers, and is distributed under the LGPL GNU License, Copyright EQcorrscan developers 2018.

Funding

RCET

Continued development of the EQcorrscan package is directly supported by the RCET, Rapid Characterisation of Earthquakes and Tsunami programme funded by the New Zealand Ministry of Business, Innovation and Employment Endeavour fund.

Development is indirectly funded by grants from Toku T Ake: EQC and a Rutherford Discovery Fellowship.

Owner

  • Name: EQcorrscan
  • Login: eqcorrscan
  • Kind: organization

Host for the EQcorrscan Python package

GitHub Events

Total
  • Create event: 6
  • Release event: 1
  • Issues event: 25
  • Watch event: 13
  • Delete event: 9
  • Issue comment event: 42
  • Push event: 53
  • Pull request review comment event: 1
  • Pull request review event: 3
  • Pull request event: 20
  • Fork event: 4
Last Year
  • Create event: 6
  • Release event: 1
  • Issues event: 25
  • Watch event: 13
  • Delete event: 9
  • Issue comment event: 42
  • Push event: 53
  • Pull request review comment event: 1
  • Pull request review event: 3
  • Pull request event: 20
  • Fork event: 4

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 2,971
  • Total Committers: 24
  • Avg Commits per committer: 123.792
  • Development Distribution Score (DDS): 0.143
Past Year
  • Commits: 166
  • Committers: 4
  • Avg Commits per committer: 41.5
  • Development Distribution Score (DDS): 0.09
Top Committers
Name Email Commits
Calum Chamberlain work c****n@v****z 2,546
cjhopp c****p@m****u 130
flixha f****p@u****o 125
Chris Scott c****t@n****z 46
iman kahbasi i****i 39
derrick d****r@g****m 26
flixha f****3@u****o 21
calum.chamberlain g****2@g****m 7
eQ 4****t 5
emilyws1 w****9@g****m 3
xiansch s****u@g****m 3
iman kahbasi 4****i 3
Calum Chamberlain c****n@b****) 2
The Gitter Badger b****r@g****m 2
snyk-bot s****t@s****o 2
Tyler Newton 5****n 2
dependabot[bot] 4****] 2
stickler-ci s****t@s****m 1
Yvonne Fröhlich 9****h 1
Stephen Hicks s****s@s****k 1
Calum Chamberlain c****a@s****z 1
Felix Halpaap f****x@d****o 1
Emily Warren w****m@c****z 1
Tyler Newton t****i@g****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 51
  • Total pull requests: 128
  • Average time to close issues: 5 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 23
  • Total pull request authors: 14
  • Average comments per issue: 3.78
  • Average comments per pull request: 1.56
  • Merged pull requests: 89
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 9
  • Pull requests: 11
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 19 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 2.56
  • Average comments per pull request: 0.36
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • calum-chamberlain (10)
  • zhong-yy (9)
  • tonino0013 (5)
  • flixha (4)
  • HGeoAle (3)
  • roshan-koirala (3)
  • fontiela (2)
  • dr-glenn (2)
  • ylseanna (1)
  • darren-tpk (1)
  • d-chambers (1)
  • GlasG0w (1)
  • Lukesovarenata (1)
  • vSahakian (1)
  • xiansch (1)
Pull Request Authors
  • calum-chamberlain (92)
  • flixha (21)
  • imankahbasi (5)
  • tjnewton (2)
  • yvonnefroehlich (2)
  • cjhopp (2)
  • arif-geo (2)
  • zhong-yy (2)
  • h-a-r-s-h-a (1)
  • dependabot[bot] (1)
  • erhmestel (1)
  • snyk-bot (1)
  • TrellixVulnTeam (1)
  • dr-glenn (1)
Top Labels
Issue Labels
core.match_filter (4) bug (4) enhancement (2) utils.pre_processing (2) utils.plotting (2) packaging.windows (2) core.template_gen (2) question (2) utils.correlate (1) docs (1) utils.mag_calc (1) dependencies (1) help wanted (1) utils.findpeaks (1) packaging (1)
Pull Request Labels
enhancement (12) core.match_filter (6) utils.correlate (3) bug (3) docs (2) utils.plotting (2) in progress (2) tests (2) core.lag_calc (2) utils.pre_processing (1) invalid (1) hacktoberfest (1) core.template_gen (1) utils.catalog_to_dd (1) utils.mag_calc (1) dependencies (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 203 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 3
    (may contain duplicates)
  • Total versions: 40
  • Total maintainers: 1
pypi.org: eqcorrscan

EQcorrscan - matched-filter earthquake detection and analysis

  • Versions: 28
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 203 Last month
Rankings
Forks count: 4.8%
Stargazers count: 5.7%
Average: 9.8%
Dependent packages count: 10.1%
Dependent repos count: 11.5%
Downloads: 16.9%
Maintainers (1)
Last synced: 6 months ago
conda-forge.org: eqcorrscan

EQcorrscan is a Python package for detection and analysis of repeating and near-repeating earthquakes.

  • Versions: 12
  • Dependent Packages: 1
  • Dependent Repositories: 1
Rankings
Forks count: 19.7%
Dependent repos count: 24.4%
Average: 25.7%
Dependent packages count: 29.0%
Stargazers count: 29.7%
Last synced: 6 months ago

Dependencies

eqcorrscan/doc/requirements.txt pypi
  • Pygments ==2.7.4
  • matplotlib *
  • nbsphinx *
  • sphinx >=1.5.1
  • sphinx_bootstrap_theme *
.github/workflows/runtest.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • conda-incubator/setup-miniconda v2 composite
requirements.txt pypi
  • bottleneck *
  • codecov *
  • h5py *
  • matplotlib >=1.3.0
  • numpy >=1.12
  • pillow >=6.2.3
  • pytest >=2.0.0
  • pytest-cov *
  • pytest-mpl *
  • pytest-pep8 *
  • pytest-rerunfailures *
  • pytest-xdist *
  • scipy >=0.18,<1.9.0
  • setuptools >=65.5.1
setup.py pypi
  • bottleneck *
  • h5py *
  • matplotlib >=1.3.0
  • numpy >=1.12
  • obspy >=1.0.3
  • scipy >=0.18,<1.9.0
.github/workflows/flake8.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
eqcorrscan/doc/environment.yml conda
  • bottleneck
  • fftw
  • h5py
  • matplotlib
  • nbsphinx
  • numpy
  • obspy
  • pyfftw