Welcome to the beampower repository!

About the package

beampower is a package for beamforming (or backprojection) of seismic signal for event detection and location. The Python wrapper can call the C (CPU) or CUDA-C (GPU) implementation. See the documentation at https://ebeauce.github.io/beampower/.

How to cite this package

There is no publication (yet) for this repository, but if you use it, please acknowledge it in your manuscript's Data and Resources or Acknowledgements section.

Installation

Option 1: manual build

Download the repository on your computer at any location with the following command or with another GitHub repository manager

git clone https://github.com/ebeauce/beampower.git

Then, from the root of the repository, run the following commands:

python setup.py build_ext
pip install .

Option 2: via pip

From anywhere, run:

pip install git+https://github.com/ebeauce/beampower

Documentation and tutorials

See the documentation on how to use beampower to detect and locate earthquakes. The package also comes with several tutorial notebooks (included also in the doc):

• Download data
• Pre-process data
• Calculate travel times
• Locate events

These notebooks require to install the following packages to be ran properly:

• xarray
• obspy>=1.3.0
• matplotlib
• tqdm
• pykonal

To-do's

• Describe pykonal issues with some grids (?).
• Compare our locs with a catalog (?).
• Reduce use of xarray and use more explicit numpy.
• Investigate apparent issues in location.