Skip to content

eqcorrscan/RT_EQcorrscan

Repository files navigation

RT EQcorrscan

Real-time implementation of EQcorrscan's matched-filter earthquake detection

License: GPL v3 test codecov Documentation Status Python 3.6+

Installation

Either install EQcorrscan from conda-forge (recommended) using something like:

conda install -c conda-forge RT-EQcorrscan

or from pypi using something like:

pip install RT-EQcorrscan

or from source by cloning this repository and running pip install:

git clone https://github.com/eqcorrscan/RT_EQcorrscan.git
cd RT_EQcorrscan
pip install .  # This should install the required dependencies.

Usage

Have a peruse of the docs to see more information on how to use RT-EQcorrscan.

Feel free to edit the source code and add/change how RT-EQcorrscan works to make it fit your application. If you find any bugs, or have a feature that you want to add, then please do! It would be really valuable to make this project better! See the section below on contributing.

Contributing

RT_EQcorrscan is ready to play with, but don't expect it to be stable yet. If you have any contributions they would be appreciated! Please fork the repository and create a pull-request on Master.

Funding

This project is funded by the Earthquake Commission of New Zealand (EQC).