SCDetect - A SeisComP Module for cross-correlation based earthquake detection

About

SCDetect is a SeisComP package. With the extension module scdetect-cc it implements both real-time and classical offline earthquake detection based on waveform cross-correlation, also called matched filtering or template matching. Again, the underlying cross-correlation algorithm is based on computing the Pearson Correlation Coefficient .

The module allows both single-stream and multi-stream earthquake detection.

In case the detection parameters exceed the configured thresholds, scdetect-cc declares a new origin.

Besides, magnitudes may be estimated based on multiple magnitude estimation methods (regression, amplitude ratios).

Documentation

For user documentation please refer to scdetect.readthedocs.io.

Compiling and Installation

Clone

Get a copy of SeisComP:

# Select a tag for an apropriate SeisComP release (https://github.com/SeisComP/seiscomp/releases)
TAG='X.Y.Z'

# Get a copy of SeisComP (follow the official documentation https://www.seiscomp.de/doc/base/build.html?highlight=compile)
git clone --branch $TAG https://github.com/SeisComP/seiscomp.git 
git clone --branch $TAG https://github.com/SeisComP/common.git seiscomp/src/base/common
git clone --branch $TAG https://github.com/SeisComP/main.git seiscomp/src/base/main

# [... etc ...]

Next, clone SCDetect:

git clone https://github.com/swiss-seismological-service/scdetect.git seiscomp/src/extras/scdetect

Dependencies

Besides of the SeisComP core dependencies the following packages must be installed to compile SCDetect:

libsqlite3-dev (Debian, Ubuntu), sqlite-devel (RedHat, Fedora, CentOS), dev-db/sqlite (Gentoo)

E.g. on Ubuntu simply invoke:

sudo apt-get install libsqlite3-dev

Compile and Install

For compiling and installing SeisComP (including SCDetect), please refer to https://github.com/SeisComP/seiscomp#build.

Tests

NOTE: executing SCDetect related tests requires SeisComP to be installed, beforehand.

In order to run all SeisComP tests (including those of scdetect-cc and possibly additionally installed third party modules), either execute

make test

in the build directory, or use the ctest executable from cmake (also within the build directory). E.g. in order to run only SCDetect related tests, invoke

ctest -R "^test_scdetect.*"

For additional information, please also refer to SeisComP's unit testing guide .

Issues

Please report bugs, issues, feature requests, etc on GitHub.

Contributions

Contributions are very welcome. Made with 💕🌈.

Cite

Armbruster, D., Mesimeri, M., Kästli, P., Diehl, T., Massin, F., and Wiemer, S. (2022)
SCDetect: Near real-time computationally efficient waveform cross-correlation based earthquake detection during intense earthquake sequences
EGU General Assembly 2022, Vienna, Austria, 23–27 May 2022 EGU22-12443
DOI: https://doi.org/10.5194/egusphere-egu22-12443

NOTE: A manuscript is currently in preparation.

License

Licensed under the the AGPLv3. For more information see the LICENSE file.