/relocDD-py

Double Difference Relocation Software in Python

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

RELOCDD-PY (v1.0)

Versioning

v1.0 - Released Feb. 2024

Software Description

RELOCDD-PY is a Python program for relocating earthquakes that employs various geometries of the double-difference (DD) method. These include:

  1. Event-Pair DD (Waldhauser and Ellsworth, BSSA, 2000)
  2. Station-Pair DD (Zhang et. al., GRL, 2010)
  3. Double-Pair DD (Guo and Zhang, GJI, 2016)

Where to Download Code

This code is available to download on github: https://github.com/katie-biegel/relocDD-py

To download code you can also run: 

cd ~/PATH/TO/PYTHON/PACKAGES
git clone [GITURL]

Dependencies and Installation

RELOCDD-PY can be installed on any machine that supports python >= 3.5 .

RELOCDD-PY contains several self-contained software functions that may require further software installation. Depending on your usage of the program, you may not need to install all packages.

To install by hand you need the following packages:

  • python
  • os
  • numpy
  • datetime
  • sys
  • subprocess
  • matplotlib
  • scipy
  • glob
  • obspy
  • utm
IF USING TO BUILD CROSS CORRELATION DT FILES:

For problems with large number of data, it is often best to run multi-process cross-correlations. While this software includes scripts to build cross-correlation differential time files for both single-process and multi-process workflows, the multi-process workflow does require usage of the MPI4PY package. Installation instructions for that package can be found here: https://mpi4py.readthedocs.io/en/stable/install.html

IF USING FOR SYNTHETIC TESTING:

If you plan to use RELOCDD-PY for synthetic tests (including building the intial event catalogs), you will need to have installed the fortran program HYPOINVERSE2000 by Fred Klein. https://www.usgs.gov/software/hypoinverse-earthquake-location

In addition, you will have to update the utility/synthetics/hypoinv.py script (line 15) to include the bin path.

References

For this Software in Particular:

K.M. Biegel, & Dettmer, J. (2024). relocDD-py (v1.0). Zenodo. https://doi.org/10.5281/zenodo.10607406.

image

For the Event-Pair DD Method:

Waldhauser, Felix, 2001, hypoDD -- A program to compute double-difference hypocenter locations, U.S. Geological Survey Open-File Report 01-113.

Waldhauser, Felix, and William L. Ellsworth, 2000, A double-difference earthquake location algorithm: Method and application to the northern Hayward fault, California, BSSA, 90, 1353-1368.

For the Station-Pair DD Method:

Zhang, Haijiang, Naudeau, Robert M., and M. Nafi Toksoz, 2010, Locating nonvolcanic tremors beneath the San Andreas fault using a station-pair double-difference location method, GRL, 37(13).

For the Double-Pair DD Method:

Guo, Hao and Haijiang, Zhang, 2016, Development of double-pair double difference earthquake location algorithm for improving earthquake locations, GJI, 208(1), 333-348.

Warranty and Licensing

This software is released opensource under the GNU General Public License . A detailed license can be seen in LICENSE.txt .

Copyright (c) 2024 Katherine Biegel

RELOCDD-PY is free software: you may redistribute or modify it under the terms of the GNU General Public License. RELOCDD-PY is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Contributions

This project is an open-source project and will continue to be updated over time. We welcome all contributions to this project!

Last Update: Feb. 2024

Code Support and Contact

If you have any issues with installation or usage of RELOCDD-PY , please reach out!

Katherine Biegel (katherine.biegel@ucalgary.ca)