sdatip 1.0.0__tar.gz

sdatip-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 He Xingchen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdatip-1.0.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: sdatip
+Version: 1.0.0
+Summary: Fast stochastic determination of arrival time and initial polarity of seismic waveforms
+Author: Chuan1937
+License: MIT
+Project-URL: Homepage, https://github.com/Chuan1937/SDATIP-Fast
+Project-URL: Documentation, https://github.com/Chuan1937/SDATIP-Fast#readme
+Project-URL: Repository, https://github.com/Chuan1937/SDATIP-Fast
+Keywords: seismic,waveform,arrival-time,polarity,geophysics
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: scipy>=1.7.0
+Requires-Dist: numba>=0.55.0
+Requires-Dist: obspy>=1.3.0
+Requires-Dist: matplotlib>=3.5.0
+Requires-Dist: tqdm>=4.60.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# SDATIP
+
+[![PyPI version](https://badge.fury.io/py/sdatip.svg)](https://badge.fury.io/py/sdatip)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Fast Stochastic Determination of Arrival Time and Initial Polarity of Seismic Waveforms**
+
+A high-performance Python package for seismic waveform analysis that determines arrival time and initial polarity using Markov chain-based stochastic methods.
+
+## Performance
+
+| Metric | Original | SDATIP |
+|--------|----------|--------|
+| 100Hz, 10s waveform | ~30 minutes | ~55 seconds |
+| Speedup | - | **30x faster** |
+
+## Installation
+
+```bash
+pip install sdatip
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/Chuan1937/SDATIP-Fast.git
+cd SDATIP-Fast
+pip install -e .
+```
+
+## Quick Start
+
+### Process a Single Waveform
+
+```python
+import numpy as np
+import sdatip
+
+# Your waveform data (1D numpy array)
+data = np.random.randn(1000)
+
+# Process the waveform
+result = sdatip.process_waveform(
+    name="STATION_A",
+    data=data,
+    output_dir="./output/"
+)
+
+# Get results
+print(f"Arrival time: {result['results'][0]['arrival_time']:.3f}s")
+print(f"Polarity (up): {result['results'][0]['polarity_up']:.3f}")
+```
+
+### Process Multiple Waveforms
+
+```python
+import sdatip
+
+# Batch process all SAC files in a directory
+results = sdatip.process_batch(
+    input_dir="./data/",
+    output_dir="./output/",
+    num_workers=4,  # Use 4 CPU cores
+    plot_enabled=False
+)
+```
+
+### Step-by-Step Processing
+
+```python
+import sdatip
+
+# Create waveform object
+wf = sdatip.Waveform("station")
+wf.importdata(data, delta=0.01)
+wf.analyzedata()
+wf.rmmean()
+wf.interpolate(1)
+wf.denseunique()
+wf.denselong(hvcoefficient=2.5, mininsertco=200)
+wf.extremearr()
+wf.densebin()
+
+# Build state model
+state = wf.constructstate()
+timeprobs, num_solutions = state.markovmatrix()
+ampprob = state.ampprobcalculate()
+
+# Estimate results
+state.estimation(0)
+print(f"Arrival: {state.arrivalestimate:.3f}s")
+print(f"Polarity up: {state.polarityup:.3f}")
+```
+
+## API Reference
+
+### `process_waveform(name, data, output_dir, ...)`
+
+Process a single seismic waveform.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `name` | str | required | Station name |
+| `data` | np.ndarray | required | 1D amplitude array |
+| `output_dir` | str | required | Output directory |
+| `delta` | float | 0.01 | Sampling interval (s) |
+| `plot_enabled` | bool | True | Generate plots |
+
+### `process_batch(input_dir, output_dir, ...)`
+
+Process multiple waveforms in parallel.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `input_dir` | str | required | Input directory with SAC files |
+| `output_dir` | str | required | Output directory |
+| `num_workers` | int | -1 | CPU cores (-1 = all) |
+| `plot_enabled` | bool | False | Generate plots |
+
+### Classes
+
+- `Waveform(name)` - Waveform preprocessing container
+- `State(name)` - Markov state model
+
+## Output Files
+
+| File | Description |
+|------|-------------|
+| `{station}.txt` | Text summary with arrival time and polarity |
+| `{station}.npz` | Main results (matrix, probabilities, thresholds) |
+| `{station}_timeprob_{i}.npz` | Time probability distribution |
+| `{station}_{i}.pdf` | Probability plot (if enabled) |
+| `{station}.eps` | Publication-ready plot (if enabled) |
+
+## Algorithm
+
+Based on: Pei, W., Zhuang, J. & Zhou, S. "Stochastic determination of arrival time and initial polarity of seismic waveform." *Earth Planets Space* 77, 36 (2025). https://doi.org/10.1186/s40623-025-02161-5
+
+## Validation
+
+```bash
+python benchmark_validate.py check
+```
+
+## Citation
+
+```bibtex
+@article{pei2025stochastic,
+  title={Stochastic determination of arrival time and initial polarity of seismic waveform},
+  author={Pei, W. and Zhuang, J. and Zhou, S.},
+  journal={Earth, Planets and Space},
+  volume={77},
+  pages={36},
+  year={2025},
+  doi={10.1186/s40623-025-02161-5}
+}
+```
+
+## License
+
+MIT License
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=Chuan1937/SDATIP-Fast&type=Date)](https://star-history.com/#Chuan1937/SDATIP-Fast&Date)

sdatip-1.0.0/README.md

@@ -0,0 +1,165 @@
+# SDATIP
+
+[![PyPI version](https://badge.fury.io/py/sdatip.svg)](https://badge.fury.io/py/sdatip)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Fast Stochastic Determination of Arrival Time and Initial Polarity of Seismic Waveforms**
+
+A high-performance Python package for seismic waveform analysis that determines arrival time and initial polarity using Markov chain-based stochastic methods.
+
+## Performance
+
+| Metric | Original | SDATIP |
+|--------|----------|--------|
+| 100Hz, 10s waveform | ~30 minutes | ~55 seconds |
+| Speedup | - | **30x faster** |
+
+## Installation
+
+```bash
+pip install sdatip
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/Chuan1937/SDATIP-Fast.git
+cd SDATIP-Fast
+pip install -e .
+```
+
+## Quick Start
+
+### Process a Single Waveform
+
+```python
+import numpy as np
+import sdatip
+
+# Your waveform data (1D numpy array)
+data = np.random.randn(1000)
+
+# Process the waveform
+result = sdatip.process_waveform(
+    name="STATION_A",
+    data=data,
+    output_dir="./output/"
+)
+
+# Get results
+print(f"Arrival time: {result['results'][0]['arrival_time']:.3f}s")
+print(f"Polarity (up): {result['results'][0]['polarity_up']:.3f}")
+```
+
+### Process Multiple Waveforms
+
+```python
+import sdatip
+
+# Batch process all SAC files in a directory
+results = sdatip.process_batch(
+    input_dir="./data/",
+    output_dir="./output/",
+    num_workers=4,  # Use 4 CPU cores
+    plot_enabled=False
+)
+```
+
+### Step-by-Step Processing
+
+```python
+import sdatip
+
+# Create waveform object
+wf = sdatip.Waveform("station")
+wf.importdata(data, delta=0.01)
+wf.analyzedata()
+wf.rmmean()
+wf.interpolate(1)
+wf.denseunique()
+wf.denselong(hvcoefficient=2.5, mininsertco=200)
+wf.extremearr()
+wf.densebin()
+
+# Build state model
+state = wf.constructstate()
+timeprobs, num_solutions = state.markovmatrix()
+ampprob = state.ampprobcalculate()
+
+# Estimate results
+state.estimation(0)
+print(f"Arrival: {state.arrivalestimate:.3f}s")
+print(f"Polarity up: {state.polarityup:.3f}")
+```
+
+## API Reference
+
+### `process_waveform(name, data, output_dir, ...)`
+
+Process a single seismic waveform.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `name` | str | required | Station name |
+| `data` | np.ndarray | required | 1D amplitude array |
+| `output_dir` | str | required | Output directory |
+| `delta` | float | 0.01 | Sampling interval (s) |
+| `plot_enabled` | bool | True | Generate plots |
+
+### `process_batch(input_dir, output_dir, ...)`
+
+Process multiple waveforms in parallel.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `input_dir` | str | required | Input directory with SAC files |
+| `output_dir` | str | required | Output directory |
+| `num_workers` | int | -1 | CPU cores (-1 = all) |
+| `plot_enabled` | bool | False | Generate plots |
+
+### Classes
+
+- `Waveform(name)` - Waveform preprocessing container
+- `State(name)` - Markov state model
+
+## Output Files
+
+| File | Description |
+|------|-------------|
+| `{station}.txt` | Text summary with arrival time and polarity |
+| `{station}.npz` | Main results (matrix, probabilities, thresholds) |
+| `{station}_timeprob_{i}.npz` | Time probability distribution |
+| `{station}_{i}.pdf` | Probability plot (if enabled) |
+| `{station}.eps` | Publication-ready plot (if enabled) |
+
+## Algorithm
+
+Based on: Pei, W., Zhuang, J. & Zhou, S. "Stochastic determination of arrival time and initial polarity of seismic waveform." *Earth Planets Space* 77, 36 (2025). https://doi.org/10.1186/s40623-025-02161-5
+
+## Validation
+
+```bash
+python benchmark_validate.py check
+```
+
+## Citation
+
+```bibtex
+@article{pei2025stochastic,
+  title={Stochastic determination of arrival time and initial polarity of seismic waveform},
+  author={Pei, W. and Zhuang, J. and Zhou, S.},
+  journal={Earth, Planets and Space},
+  volume={77},
+  pages={36},
+  year={2025},
+  doi={10.1186/s40623-025-02161-5}
+}
+```
+
+## License
+
+MIT License
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=Chuan1937/SDATIP-Fast&type=Date)](https://star-history.com/#Chuan1937/SDATIP-Fast&Date)

sdatip-1.0.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sdatip"
+version = "1.0.0"
+description = "Fast stochastic determination of arrival time and initial polarity of seismic waveforms"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    {name = "Chuan1937"}
+]
+keywords = ["seismic", "waveform", "arrival-time", "polarity", "geophysics"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "numpy>=1.20.0",
+    "scipy>=1.7.0",
+    "numba>=0.55.0",
+    "obspy>=1.3.0",
+    "matplotlib>=3.5.0",
+    "tqdm>=4.60.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Chuan1937/SDATIP-Fast"
+Documentation = "https://github.com/Chuan1937/SDATIP-Fast#readme"
+Repository = "https://github.com/Chuan1937/SDATIP-Fast"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["sdatip*"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"

sdatip-1.0.0/sdatip/__init__.py

@@ -0,0 +1,46 @@
+"""SDATIP: Fast Stochastic Determination of Arrival Time and Initial Polarity.
+
+A high-performance Python package for seismic waveform analysis that determines
+arrival time and initial polarity using Markov chain-based stochastic methods.
+
+Example usage:
+    >>> import sdatip
+    >>> 
+    >>> # Quick processing
+    >>> result = sdatip.process_waveform(
+    ...     name="station_A",
+    ...     data=waveform_array,
+    ...     output_dir="./output/"
+    ... )
+    >>> print(f"Arrival time: {result['arrival_time']:.3f}s")
+    >>> print(f"Polarity: {result['polarity_up']:.3f}")
+    >>> 
+    >>> # Step-by-step processing
+    >>> wf = sdatip.Waveform("station_A")
+    >>> wf.importdata(data, delta=0.01)
+    >>> wf.analyzedata()
+    >>> # ... continue with other steps
+"""
+
+from sdatip.waveform import Waveform, findnoise
+from sdatip.state import State
+from sdatip.pmi import entropy, pmi, maxpmi, calculate_general
+from sdatip.processor import process_waveform, process_batch
+
+__version__ = "1.0.0"
+__author__ = "Chuan1937"
+
+__all__ = [
+    # Main classes
+    "Waveform",
+    "State",
+    # High-level API
+    "process_waveform",
+    "process_batch",
+    # Utility functions
+    "findnoise",
+    "entropy",
+    "pmi",
+    "maxpmi",
+    "calculate_general",
+]