Metadata-Version: 2.4
Name: enveloc
Version: 1.1.9
Summary: enveloc - seismic envelope cross-correlation location method
Project-URL: Homepage, https://code.usgs.gov/vsc/seis/tools/enveloc
Project-URL: Documentation, https://vsc.code-pages.usgs.gov/seis/tools/enveloc/
Author-email: Aaron Wech <awech@usgs.gov>
License-Expression: CC0-1.0
License-File: LICENSE.md
Keywords: cross-correlation,earthquake,seismology,tremor,volcano,volcano seismology
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Requires-Dist: cartopy
Requires-Dist: obspy
Requires-Dist: scikit-learn
Requires-Dist: utm
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-jupyter; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: ipykernel; extra == 'test'
Requires-Dist: nbclient; extra == 'test'
Requires-Dist: nbformat; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# enveloc
A Python package to locate emergent seismicity using a network of seismic stations. 
*enveloc* uses envelope cross correlation of seismic traces on a fixed time window and performs a 3D grid search to maximize signal coherency.

### Dependencies
- obspy
- cartopy
- scikit-learn
- utm


### Installation
[![PyPI](https://img.shields.io/pypi/v/enveloc.svg?style=flat)](https://pypi.python.org/pypi/enveloc)
[![Compatible Python Versions](https://img.shields.io/pypi/pyversions/enveloc.svg?style=flat)](https://pypi.org/project/enveloc/)

It is recommended to do this in a fresh virtual environment:

```bash
# Create a virtual environment (conda example)
conda create -n enveloc python=3.13
conda activate enveloc
```

To install from PyPI:
```bash
pip install enveloc
```

> Alternatively, to install from source:
> ```bash
> git clone https://code.usgs.gov/vsc/seis/tools/enveloc.git
> cd enveloc
> pip install .
> ```

Test install with:
```bash
from enveloc.example_utils import test
test()
```

### Documentation
Go [here](https://vsc.code-pages.usgs.gov/seis/tools/enveloc/) for more information and tutorials.


### Citation
The software package can be cited as:<br>
Wech, A.G., enveloc (Version 1.2.0), U.S. Geological Survey Software Release, doi:[10.5066/P13L3AR7](https://doi.org/10.5066/P13L3AR7).

And the underlying methodology can be cited as:<br>
Wech, A.G., and K.C. Creager (2008), Automated detection and location of Cascadia tremor, Geophysical Research Letters, 35, L20302, doi:[10.1029/2008GL035458](https://doi.org/10.1029/2008GL035458).