Metadata-Version: 2.5
Name: pysmo.aimbat
Version: 1.0.8
Summary: Automated and Interactive Measurement of Body-wave Arrival Times
Project-URL: Documentation, https://aimbat.readthedocs.io
Project-URL: Repository, https://github.com/pysmo/aimbat
Author: Suzan van der Lee
Author-email: Xiaoting Lou <xlou@u.northwestern.edu>, "Simon M. Lloyd" <simon@slloyd.net>
License-Expression: GPL-3.0-or-later
Classifier: Development Status :: 7 - Inactive
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Requires-Python: <3.15,>=3.11
Requires-Dist: matplotlib>=3.9
Requires-Dist: numpy>=2.1
Requires-Dist: pyqtgraph>=0.13.7
Requires-Dist: pyside6>=6.7
Requires-Dist: pysmo<0.9,>=0.8.4
Requires-Dist: scipy>=1.14
Provides-Extra: dev
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest-mpl>=0.17; extra == 'dev'
Requires-Dist: pytest>=8.3; extra == 'dev'
Requires-Dist: ruff>=0.11; extra == 'dev'
Requires-Dist: sphinx-rtd-theme>=3.0; extra == 'dev'
Requires-Dist: sphinx>=7.4; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-rtd-theme>=3.0; extra == 'docs'
Requires-Dist: sphinx>=7.4; extra == 'docs'
Provides-Extra: lint
Requires-Dist: ruff>=0.11; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest-mpl>=0.17; extra == 'test'
Requires-Dist: pytest>=8.3; extra == 'test'
Description-Content-Type: text/x-rst

======
AIMBAT
======

.. warning::

   ``pysmo.aimbat`` is the legacy AIMBAT 1 line and is no longer actively
   developed. It has been superseded by **AIMBAT 2**, distributed as ``aimbat``
   (``pip install aimbat``) and imported as ``aimbat``, no longer under the
   ``pysmo`` namespace. See https://github.com/pysmo/aimbat.

Overview
--------
AIMBAT (Automated and Interactive Measurement of Body wave Arrival Times) is an
open-source software package for efficiently measuring teleseismic body wave arrival
times for large seismic arrays (Lou et al., 2013). It is based on a widely used
method called MCCC (Multi-Channel Cross-Correlation; VanDecar & Crosson, 1990). The package
is automated in the sense of initially aligning seismograms for MCCC, which is achieved
by an ICCS (Iterative Cross Correlation and Stack) algorithm. Meanwhile, a GUI
(graphical user interface) is built to perform seismogram quality control interactively.
Therefore, user processing time is reduced while valuable input from a user's expertise
is retained. As a byproduct, SAC (Goldstein et al., 2003) plotting and phase picking
functionalities are replicated and enhanced.

Modules and scripts included in the AIMBAT package were developed using
`Python <http://www.python.org/>`_ and its open-source modules on the Mac OS X platform
since 2009. The original MCCC (VanDecar & Crosson, 1990) code was transcribed into Python.
The GUI of AIMBAT was inspired and initiated at the
`2009 EarthScope USArray Data Processing and Analysis Short Course <http://www.iris.edu/hq/es_course/content/2009.html>`_.
AIMBAT runs on Mac OS X, Linux/Unix and Windows thanks to the platform-independent
feature of Python. It has been tested on Mac OS 10.6.8 and 10.7, and Fedora 29.

For more information visit the
`project website <http://www.earth.northwestern.edu/~xlou/aimbat.html>`_ or the
`Pysmo repository <https://github.com/pysmo>`_.

Documentation
-------------
For detailed installation and usage instructions see: https://aimbat.readthedocs.org.

Requirements
------------

* Python version 3.6 or higher
* Fortran (optional, but highly recommended for better performance)

Installation
------------

::

   $ pip install pysmo.aimbat


Citation
--------

AIMBAT: A Python/Matplotlib Tool for Measuring Teleseismic Arrival Times. Xiaoting Lou,
Suzan van der Lee, and Simon Lloyd (2013), Seismol. Res. Lett., 84(1), 85-93,
`doi:10.1785/0220120033 <https://doi.org/10.1785/0220120033>`_.

.. _authors-contacts:

Authors' Contacts
-----------------


* `Xiaoting Lou <http://geophysics.earth.northwestern.edu/people/xlou/aimbat.html>`_ Email: xlou at u.northwestern.edu

* `Suzan van der Lee <http://geophysics.earth.northwestern.edu/seismology/suzan/>`_ Email: suzan at northwestern.edu

* `Simon Lloyd <https://www.slloyd.net/>`_ Email: simon at slloyd.net

Contributors
------------
* Lay Kuan Loh

Licence
-------
The AIMBAT software package is distributed under the
`GNU General Public License Version 3 (GPLv3) <http://www.gnu.org/licenses/gpl.html>`_
as published by the Free Software Foundation.

Copyright (c) 2009-2019 Xiaoting Lou
