https://github.com/yetinam/pyocto

PyOcto: A high-throughput seismic phase associator
https://github.com/yetinam/pyocto

Last synced: 4 months ago
JSON representation

PyOcto: A high-throughput seismic phase associator

• Host: GitHub
• URL: https://github.com/yetinam/pyocto
• Owner: yetinam
• License: mit
• Created: 2023-09-28T12:16:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-31T19:59:34.000Z (6 months ago)
• Last Synced: 2025-01-02T03:25:13.467Z (4 months ago)
• Language: Python
• Size: 447 KB
• Stars: 44
• Watchers: 5
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-seismology - PyOcto - High-throughput seismic phase associator.  (Phase picking and association)

README

        


  



[![PyPI - License](https://img.shields.io/pypi/l/pyocto)](https://github.com/yetinam/pyocto/blob/main/LICENSE)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/yetinam/pyocto/lint_and_test.yml?branch=main)](https://github.com/yetinam/pyocto)

[![Read the Docs](https://img.shields.io/readthedocs/pyocto)](https://pyocto.readthedocs.io/en/latest/)

[![PyPI](https://img.shields.io/pypi/v/pyocto)](https://pypi.org/project/pyocto/)

[![Python 3.9](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/release/python-390/)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10016666.svg)](https://doi.org/10.5281/zenodo.10016666)

PyOcto is a high-throughput seismic phase associator.

The best way to get started with PyOcto is through our interactive examples:

| Examples                             |                                                                                                                                                                                   |

|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| Basics                               | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/yetinam/pyocto/blob/main/examples/01_basics.ipynb)          |

| Velocity models                      | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/yetinam/pyocto/blob/main/examples/02_velocity_models.ipynb) |

| Interfaces                           | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/yetinam/pyocto/blob/main/examples/03_interfaces.ipynb)      |

If you're looking for further guidance, for example, a guide on how to set

the associator parameters, check out the [PyOcto documentation](https://pyocto.readthedocs.io).

## Installation

The easiest way to install PyOcto is through pip:

```bash

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](https://pyrocko.org/). pyrocko is available through the

standard channels, such as `pip` or `conda`.

```bash

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]](https://seismica.library.mcgill.ca/article/view/1130)*.