1. Introduction to the EQcorrscan package

1.1. Supported environments

We support Linux, OSX and Windows environments running Python 3.x.

1.2. Functionality

Within EQcorrscan you will find the core routines to generate templates (template_gen), compute cross-channel correlations from these templates (match_filter), generate cross-correlation corrected pick-times (lag_calc), and run subspace detection (subspace).

1.3. Running tests

You can run tests yourself locally to ensure that everything runs as you would expect in your environment. Although we try to ensure that these tests run smoothly on all supported environments (using the ci bots), if you do find any issues, please let us know on the github page.

To run the tests you will need to have pytest installed along with a couple of extras (pytest-pep8 and pytest-cov). These can be installed by pip:

pip install pytest pytest-pep8 pytest-cov

To test your installed version of EQcorrscan we provide a test-script. For version<=0.3.2 you should download the script and run it. In later versions this script is included in the package.

This test-script will download the test data and run the tests (you no longer have to clone the git repository). Just run (from anywhere):

test_eqcorrscan.py

Tests will take about half an hour to run (as of version 0.3.2) and will provide a coverage report at the end and notify you of any failures.