PyOcto is a high-throughput seismic phase associator. The best way to get started with PyOcto is through our interactive examples:

Examples
Basics
Velocity models
Interfaces

If you're looking for further guidance, for example, a guide on how to set the associator parameters, check out the PyOcto documentation.

Installation

The easiest way to install PyOcto is through pip:

pip install pyocto

There are prebuilt wheels available for Linux, Mac OS, and Windows. In case you want to use 1D velocity models, you will need to install the optional dependency pyrocko. pyrocko is available through the standard channels, such as pip or conda.

git clone https://github.com/yetinam/pyocto.git
cd pyocto
git submodule update --init
pip install .[test]

To verify your installation is working, use pytest tests/.

Warning: PyOcto uses POSIX threads for threading. As these are not available on Windows, the Windows version is single-threaded. Therefore, we do not recommend running larger computations on Windows.

References

If you're using PyOcto in your work, please cite:

Münchmeyer, J. (2024). PyOcto: A high-throughput seismic phase associator. Seismica. [Paper].