Skip to content

Latest commit

 

History

History
107 lines (66 loc) · 4.28 KB

README.md

File metadata and controls

107 lines (66 loc) · 4.28 KB
Raw

Lightguide

Tools for distributed acoustic sensing and modelling.

PyPI build Code style: black pre-commit

Lightguide is a package for handling, filtering and modelling distributed acoustic sensing (DAS) data. The package interfaces handling and processing routines of DAS data to the Pyrocko framework. Through Pyrocko's I/O engine 🚀 lightguide supports handling the following DAS data formats:

  • MiniSEED
  • Silixa iDAS (TDMS data)
  • ASN OptoDAS

Numerical forward modelling of various dislocation sources in layered and homogeneous half-space towards DAS strain and strain-rate is employed through Pyrocko-Green's function package.

The framework is still in Beta. Expect changes throughout all functions.

Installation

Install the compiled Python wheels from PyPI:

pip install lightguide

Usage

Documentation

Find the documentation here.

Adaptive frequency filter

The adaptive frequency filter (AFK) can be used to suppress incoherent noise in DAS data sets.

from lightguide.blast import Blast

blast = Blast.from_miniseed("my-data.mseed")
blast.lowpass(corner_freq=60.0)
blast.afk_filter(exponent=0.8)

The filtering performance of the AFK filter, applied to an earthquake recording at an ICDP borehole observatory in Germany. The data was recorded on a Silixa iDAS v2. For more details see https://doi.org/10.5880/GFZ.2.1.2022.006.

AFK Filter Performance

The figures show the performance of the AFK filter applied to noisy DAS data. (a) Raw data. (b) The filtered wave field using the AFK filter with exponent = 0.6, 0.8, 1.0, 32 x 32 sample window size and 15 samples overlap. (c) The normalized residual between raw and filtered data. (d) Normalized raw (black) waveform and waveforms filtered (colored) by different filter exponents, the shaded area marks the signal duration. (e) Power spectra of signal shown in (d; shaded duration), the green area covers the noise band used for estimating the reduction in spectral amplitude in dB. The data are neither tapered nor band-pass filtered, the images in (a-c) are not anti-aliased.

Citation

Lightguide can be cited as:

Marius Paul Isken, Sebastian Heimann, Christopher Wollin, Hannes Bathke, & Torsten Dahm. (2022). Lightguide - Seismological Tools for DAS data. Zenodo. https://doi.org/10.5281/zenodo.6580579

DOI

Details of the adaptive frequency filter are published here:

Marius Paul Isken, Hannes Vasyura-Bathke, Torsten Dahm, Sebastian Heimann, De-noising distributed acoustic sensing data using an adaptive frequency-wavenumber filter, Geophysical Journal International, 2022;, ggac229, https://doi.org/10.1093/gji/ggac229

DOI

Packaging

To package lightguit requires Rust and the maturin build tool. maturin can be installed from PyPI or packaged as well. This is the simplest and recommended way of installing from source:

# Install rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install maturin and build
pip install maturin
maturin build

Development

Local development through pip or maturin.

cd lightguide
pip3 install .[dev]

or

cd lightguide
maturin develop

The project utilizes pre-commit for clean commits, install the hooks via:

pip install pre-commit
pre-commit install

License

Contribution and merge requests by the community are welcome!

Lightguide was written by Marius Paul Isken and is licensed under the GNU GENERAL PUBLIC LICENSE v3.