Metadata-Version: 2.4
Name: DASPy-toolbox
Version: 1.2.5
Summary: DASPy is an open-source Python package for Distributed Acoustic Sensing (DAS) data processing.
Home-page: https://github.com/HMZ-03/DASPy
Author: Minzhe Hu, Zefeng Li
Author-email: hmz2018@mail.ustc.edu.cn
Maintainer: Minzhe Hu
Maintainer-email: hmz2018@mail.ustc.edu.cn
License: MIT License
Project-URL: Documentation (EN), https://daspy-tutorial.readthedocs.io/en/latest/
Project-URL: Documentation (ZH), https://daspy-tutorial-cn.readthedocs.io/zh-cn/latest/
Project-URL: Source, https://github.com/HMZ-03/DASPy
Project-URL: Issue Tracker, https://github.com/HMZ-03/DASPy/issues
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy>=1.13
Requires-Dist: matplotlib
Requires-Dist: geographiclib
Requires-Dist: pyproj
Requires-Dist: h5py
Requires-Dist: segyio
Requires-Dist: nptdms
Requires-Dist: tqdm
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<img src="https://raw.githubusercontent.com/HMZ-03/DASPy/main/website/logo.png" height="200" />

[![Supported Python versions](https://img.shields.io/badge/python-3.9%20and%20up-blue)](https://pypi.org/project/DASPy-toolbox/)
[![License](https://img.shields.io/pypi/l/daspy-toolbox.svg)](https://opensource.org/license/mit)
[![PyPI Version](https://img.shields.io/pypi/v/daspy-toolbox.svg)](https://pypi.org/project/DASPy-toolbox/)
[![DOI](https://img.shields.io/badge/DOI-10.1785/0220240124-blue.svg)](https://doi.org/10.1785/0220240124)
[![PyPI Downloads](https://img.shields.io/pypi/dm/daspy-toolbox.svg?label=pypi)](https://pypi.org/project/DASPy-toolbox/)
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/daspy-toolbox?label=conda)](https://anaconda.org/conda-forge/daspy-toolbox)

# DASPy

DASPy is an open-source Python package for **Distributed Acoustic Sensing (DAS)**
data processing.

The project aims to lower the barrier for DAS processing and to provide a
practical toolkit for DAS seismology workflows.

## Features

DASPy includes:

- **Classic seismic processing**: preprocessing, filtering, spectral analysis,
  and visualization.
- **DAS-oriented algorithms**: denoising, wavefield decomposition, channel
  analysis, and strain-velocity conversion.
- **Convenient data structures**: `Section`, `Collection`, and `DASDateTime`
  for waveform, continuous acquisition, and time handling workflows.

## Documentation

- English tutorial: <https://daspy-tutorial.readthedocs.io/en/latest/>
- 中文教程: <https://daspy-tutorial-cn.readthedocs.io/zh-cn/latest/>
- Example notebook: [`document/example.ipynb`](document/example.ipynb)

## Installation

DASPy supports **Python 3.9+** on Linux, macOS, and Windows.

### pip

Install from PyPI:

```bash
pip install daspy-toolbox
```

Install the latest development version:

```bash
pip install git+https://github.com/HMZ-03/DASPy.git
```

### conda

```bash
conda install conda-forge::daspy-toolbox
```

If you are using Python 3.13 or later, installation through conda may fail
because `segyio` is not yet available for all conda-forge builds. In that case,
use `pip` or Python 3.12 and earlier.

### Manual installation

1. Install dependencies: `numpy`, `scipy>=1.13`, `matplotlib`,
   `geographiclib`, `pyproj`, `h5py`, `segyio`, `nptdms`, `tqdm`.
2. Add DASPy to your Python path, or install it in editable mode:

```bash
git clone https://github.com/HMZ-03/DASPy.git
cd DASPy
pip install -e .
```

## Quick start

```python
from daspy import read

sec = read()  # load the built-in example waveform
sec.bandpass(1, 15)
sec.plot()
```

<img src="./website/waveform.png" height="500" />

## Contributing

Contributions are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Reference

- Minzhe Hu and Zefeng Li (2024),
  [DASPy: A Python Toolbox for DAS Seismology](https://pubs.geoscienceworld.org/ssa/srl/article/95/5/3055/645865/DASPy-A-Python-Toolbox-for-DAS-Seismology),
  *Seismological Research Letters*, 95(5), 3055–3066,
  doi: `https://doi.org/10.1785/0220240124`.

## Contact

If you have questions, please contact <hmz2018@mail.ustc.edu.cn>.
