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.

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.

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.

The creation of this project was funded by the Earthquake Commission of New Zealand (EQC). Currently the maintainence of this project is unfunded.

If you use our software in your research please cite our paper on the RT-EQcorrscan package. These citations help to keep the developers in work and keep maintaining these software!

Chamberlain, C. J., J. Townend, and M. C. Gerstenberger (2020). RT-EQcorrscan: Near-Real-Time Matched-Filtering for Rapid Development of Dense Earthquake Catalogs, Seismol. Res. Lett. XX, 1–11, doi: 10.1785/0220200171.

Continued development of the RT-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.