Metadata-Version: 2.1
Name: ELEP
Version: 0.0.2
Summary: Ensemble Learning for Earthquake Processing
Author-email: Congcong Yuan <cyuan@g.harvard.edu>
Maintainer-email: Congcong Yuan <cyuan@g.harvard.edu>, Yiyu Ni <niyiyu@uw.edu>
License: GPLv3
Project-URL: GitHub, https://github.com/congcy/ELEP
Project-URL: Documentation, https://ssec-python-project-template.readthedocs.io/en/latest
Project-URL: Issues, https://github.com/othneildrew/Best-README-Template/issues
Keywords: seismology,machine learning,ensemble learning,seismic signal processing
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy (>=1.21.6)
Requires-Dist: pandas (>=1.1)
Requires-Dist: h5py (>=3.1)
Requires-Dist: obspy (>=1.2)
Requires-Dist: tqdm (>=4.52)
Requires-Dist: torch (>=1.10.0)
Requires-Dist: scipy (>=1.5)
Requires-Dist: nest-asyncio (>=1.5.3)
Provides-Extra: development
Requires-Dist: flake8 ; extra == 'development'
Requires-Dist: black ; extra == 'development'
Requires-Dist: isort ; extra == 'development'
Requires-Dist: pre-commit ; extra == 'development'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-asyncio ; extra == 'tests'

# ELEP

<!-- PROJECT LOGO & STATUS -->
<br />
<div align="center">
  <a href="https://github.com/congcy/ELEP">
    <img src="docs/images/ELEP_logo.png" alt="Logo" width="100" height="80">
  </a>
  <h3 align="center">ELEP</h3>
  <p align="center">
    A ensemble-learning based toolkit for seismologists to make the best pick on earthquake phases by combining multiple predictions into the one. 
    <br />
    <br />
    <a href="https://github.com/congcy/ELEP/blob/main/LICENSE" alt="Liscence">
        <img src="https://badgen.net/badge/license/BSD-3-Clause/blue" /></a>
    <a href="https://github.com/congcy/ELEP/tree/main/docs" alt="Documentation Status">
        <img src="https://readthedocs.org/projects/ssec-python-project-template/badge/?version=latest" /></a>
    <a href="https://github.com/congcy/ELEP/tree/main/.github/workflows" alt="Test">
        <img src="https://github.com/uw-ssec/python-project-template/actions/workflows/test.yaml/badge.svg" /></a>
    <br />
    <a href="https://ssec-python-project-template.readthedocs.io/en/latest/?badge=latest">Tutorials</a>
    ·
    <a href="https://github.com/othneildrew/Best-README-Template/issues">Report Bug</a>
    ·
    <a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a>
  </p>
</div>


## Prerequisites & installations

* create a new environment using [Anaconda](https://www.anaconda.com/) 
  ```python
  >>> conda create --name myenv
  ```
* install [Seisbench](https://github.com/seisbench/seisbench)
  ```python
  >>> pip install seisbench
  ```
* install other packages
  ```python
  >>> pip install jupyter mpi4py
  ```
* install our toolkit (under development)
  ```python
  >>> pip install ELEP
  ```

<p align="right">(<a href="https://github.com/congcy/ELEP">back to top</a>)</p>

## Features

![workflow](/docs/images/ELEP_framework.png)

This toolkit contains the following features:

1. It provides broadband and multiband prediction workflows.
2. It provides three ensemble estimation or combination approaches.
3. It provides GPU-supported batch predictions on avilable datasets.
4. It supports parallel predictions for real-time earthquake monitoring.
5. It possess a good generalization capability.

<p align="right">(<a href="https://github.com/congcy/ELEP">back to top</a>)</p>

## Demo
Please see the notebooks under the folder `tutorials` for more details.
<p align="right">(<a href="https://github.com/congcy/ELEP">back to top</a>)</p>

## Citation 
Yuan, C., Ni, Y., Lin, Y., Denolle, M., Ensemble Learning for Earthquake Detection and Phase Picking, 2023, in preparation.
<p align="right">(<a href="https://github.com/congcy/ELEP">back to top</a>)</p>

## Contact
Congcong Yuan - cyuan@g.harvard.edu
<p align="right">(<a href="https://github.com/congcy/ELEP">back to top</a>)</p>
