EQcorrscan 0.0.9

EQcorrscan
==========

A python package to conduct match-filter earthquake detections.
---------------------------------------------------------------

`|Join the chat at
https://gitter.im/calum-chamberlain/EQcorrscan| <https://gitter.im/calum-chamberlain/EQcorrscan?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge>`_
`|TravisCIStatus| <https://travis-ci.org/calum-chamberlain/EQcorrscan>`_
`|DOI| <https://zenodo.org/badge/latestdoi/18852/calum-chamberlain/EQcorrscan>`_
`|DocumentationStatus| <http://eqcorrscan.readthedocs.org/en/latest/?badge=latest>`_

Installation
============

We are now listed on pypi! Installation has been tested on both OSX and
Linux (Ubuntu) and is as simple as:

*pip install EQcorrscan*

If upgrading from a previous version, rather than running install
--upgrade, I recommend the following:

*pip install -U --no-deps EQcorrscan*

This will not try to upgrade your dependencies, which is not needed for
0.0.8.

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 <https://groups.google.com/forum/#!forum/eqcorrscan-users>`_.

You will likely need sudo permissions to run this command. This
installation method is quite new to the package (as of v0.0.4), so there
are some things that are changing in the install process at the moment.
This should be smoothed out by v0.1.0 (maybe mid 2016).

If you have any issues installing please let me know. You will need to
install openCV seperately using (on Linux):

*sudo apt-get install python-opencv*

Or, for Mac users, this is available on Macports or other similar
package managers.

The full documentation for this package can be found here:
`Docs <http://calum-chamberlain.github.io/EQcorrscan/>`_ - you are also
welcome to suggest documentation updates or update the doc in the
develop branch, please do not work on the documentation in the gh-pages
branch!

This package contains routines to enable the user to conduct
match-filter earthquake detections using
`obspy <https://github.com/obspy/obspy/wiki>`_ bindings when reading and
writing seismic data, and the correlation routine in
`openCV <http://opencv.org/>`_. Neither of these packages are installed
by this software, due to a range of licenses being implemented. However,
both are open-source and should be installed before using this package.
This package was written to implement the Matlab routines used by
Chamberlain et al. (2014) for the detection of low-frequency
earthquakes.

Also within this package are: \* Clustering routines for seismic data;
\* Peak finding algorithm (basic); \* Automatic amplitude picker for
local magnitude scale; \* `Seisan <http://seisan.info/>`_ S-file
integration for database management and routine earthquake location; \*
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)

This package is written by Calum Chamberlain of Victoria University of
Wellington, and is distributed under the LGPL GNU License, Copyright
Calum Chamberlain 2015.

Parameter files
===============

To use this package you will need to set up default parameters in the
parameter file. Currently these are located in the source directory,
this will change in the future, hopefully. It is recommended that you
copy these default parameter files before adding your own to allow you
to easily transfer back to other parameter set ups. **These are being
migrated to a script directory along with all scripts for version
0.0.5**\*

Contributing
============

Please fork this project and work on it there then create a pull request
to merge back into develop.

When you make changes please run the tests in the test directory to
ensure everything merges with minimum effort.

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

We are trying to implement a better branching model, following that
found here: http://nvie.com/posts/a-successful-git-branching-model/ To
this end, please fork the development branch if you want to develop
things, and flag issues in the master for us to bugfix. If you have a
feature you want to develop please create a new branch of the
development branch for this and work in there, we can then merge it back
in to the development branch when it is stable enough.

This branching model (git-flow) is pretty well established, and I would
recommend you to install
`git-flow <https://github.com/nvie/gitflow/wiki/Installation>`_ and read
their `documentation <https://github.com/nvie/gitflow>`_. It seems
pretty intuitive and will keep us all branching in the same way.

References
==========

- CJ Chamberlain, DR Shelly, J Townend, TA Stern (2014) `Low‐frequency
earthquakes reveal punctuated slow slip on the deep extent of the
Alpine Fault, New
Zealand <http://onlinelibrary.wiley.com/doi/10.1002/2014GC005436/full>`_,
**G-cubed**,doi:10.1002/2014GC005436
- Thurber, C. H., Zeng, X., Thomas, A. M., & Audet, P. (2014).
`Phase‐Weighted Stacking Applied to Low‐Frequency
Earthquakes <http://www.bssaonline.org/content/early/2014/08/12/0120140077.abstract>`_,
**BSSA**, doi:10.1785/0120140077.
- Frank, W. B., & Shapiro, N. M. (2014). `Automatic detection of
low-frequency earthquakes (LFEs) based on a beamformed network
response <http://gji.oxfordjournals.org/content/197/2/1215.short>`_,
**Geophysical Journal International**, 197(2), 1215-1223,
doi:10.1093/gji/ggu058.

.. |Join the chat at
https://gitter.im/calum-chamberlain/EQcorrscan| image:: https://badges.gitter.im/Join%20Chat.svg
.. |TravisCIStatus| image:: https://travis-ci.org/calum-chamberlain/EQcorrscan.svg?branch=master
.. |DOI| image:: https://zenodo.org/badge/18852/calum-chamberlain/EQcorrscan.svg
.. |DocumentationStatus| image:: http://readthedocs.org/projects/eqcorrscan/badge/?version=latest