lightguide

Tools for distributed acoustic sensing data.

https://github.com/pyrocko/lightguide

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary

Keywords

das distributed-acoustic-sensing seismology
Last synced: 6 months ago · JSON representation ·

Repository

Tools for distributed acoustic sensing data.

Basic Info
  • Host: GitHub
  • Owner: pyrocko
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 18.3 MB
Statistics
  • Stars: 58
  • Watchers: 5
  • Forks: 13
  • Open Issues: 7
  • Releases: 6
Topics
das distributed-acoustic-sensing seismology
Created almost 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation Zenodo

README.md

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 :rocket: 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:

sh 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.

```py from lightguide.blast import Blast

blast = Blast.fromminiseed("my-data.mseed") blast.lowpass(cornerfreq=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:

```sh

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.

sh cd lightguide pip3 install .[dev]

or

sh cd lightguide maturin develop

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

sh 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.

Owner

  • Name: Pyrocko
  • Login: pyrocko
  • Kind: organization
  • Email: info@pyrocko.org
  • Location: Earth

A seismology toolkit for Python. Official read-only mirrors of https://git.pyrocko.org/pyrocko

Citation (CITATION.cff)

cff-version: 0.2.0
title: Lightguide
message: "If you use this software, please cite it as below."
authors:
  - given-names: Marius Paul
    family-names: Isken
    email: mi@gfz-potsdam.de
    affiliation: GFZ German Research Centre for Geosciences
    orcid: 'https://orcid.org/0000-0003-2464-1630'
  - given-names: Sebastian
    family-names: Heimann
    email: sebastian.heimann@gfz-potsdam.de
    affiliation: University of Potsdam, Germany
  - given-names: Hannes
    family-names: Vasyura-Bathke
    affiliation: GFZ German Research Centre for Geosciences
  - given-names: Christopher
    family-names: Wollin
    affiliation: GFZ German Research Centre for Geosciences
  - given-names: Torsten
    family-names: Dahm
    affiliation: GFZ German Research Centre for Geosciences
    email: dahm@gfz-potsdam.de
version: v0.2.0
date-released: 2022-07-01

GitHub Events

Total
  • Watch event: 16
  • Delete event: 1
  • Push event: 1
  • Pull request event: 1
  • Fork event: 3
Last Year
  • Watch event: 16
  • Delete event: 1
  • Push event: 1
  • Pull request event: 1
  • Fork event: 3

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 272 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 1
pypi.org: lightguide

Tools for distributed acoustic sensing and modelling.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 272 Last month
Rankings
Dependent packages count: 10.1%
Average: 16.8%
Downloads: 18.8%
Dependent repos count: 21.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

Cargo.lock cargo
  • adler 1.0.2
  • aho-corasick 0.5.3
  • anyhow 1.0.57
  • autocfg 1.1.0
  • bitflags 1.3.2
  • byteorder 1.4.3
  • bzip2 0.4.3
  • bzip2-sys 0.1.11+1.0.8
  • cc 1.0.73
  • cfg-if 1.0.0
  • chrono 0.2.25
  • crc32fast 1.3.2
  • crossbeam-channel 0.5.4
  • crossbeam-deque 0.8.1
  • crossbeam-epoch 0.9.8
  • crossbeam-utils 0.8.8
  • either 1.6.1
  • flate2 1.0.23
  • fs_extra 1.2.0
  • ftp 3.0.1
  • hermit-abi 0.1.19
  • indoc 1.0.6
  • kernel32-sys 0.2.2
  • lazy_static 0.1.16
  • lazy_static 1.4.0
  • libc 0.2.126
  • lock_api 0.4.7
  • matrixmultiply 0.2.4
  • matrixmultiply 0.3.2
  • memchr 0.1.11
  • memoffset 0.6.5
  • miniz_oxide 0.5.1
  • ndarray 0.14.0
  • ndarray 0.15.4
  • num 0.1.42
  • num-complex 0.3.1
  • num-complex 0.4.1
  • num-integer 0.1.45
  • num-iter 0.1.43
  • num-traits 0.2.15
  • num_cpus 1.13.1
  • numpy 0.16.2
  • once_cell 1.12.0
  • parking_lot 0.12.0
  • parking_lot_core 0.9.3
  • pkg-config 0.3.25
  • proc-macro2 1.0.39
  • pyo3 0.16.5
  • pyo3-build-config 0.16.5
  • pyo3-ffi 0.16.5
  • pyo3-macros 0.16.5
  • pyo3-macros-backend 0.16.5
  • quote 1.0.18
  • rawpointer 0.2.1
  • rayon 1.5.3
  • rayon-core 1.9.3
  • redox_syscall 0.2.13
  • regex 0.1.80
  • regex-syntax 0.3.9
  • scopeguard 1.1.0
  • smallvec 1.8.0
  • syn 1.0.95
  • target-lexicon 0.12.4
  • thiserror 1.0.31
  • thiserror-impl 1.0.31
  • thread-id 2.0.0
  • thread_local 0.2.7
  • time 0.1.44
  • unicode-ident 1.0.0
  • unindent 0.1.9
  • utf8-ranges 0.1.3
  • wasi 0.10.0+wasi-snapshot-preview1
  • winapi 0.2.8
  • winapi 0.3.9
  • winapi-build 0.1.1
  • winapi-i686-pc-windows-gnu 0.4.0
  • winapi-x86_64-pc-windows-gnu 0.4.0
  • windows-sys 0.36.1
  • windows_aarch64_msvc 0.36.1
  • windows_i686_gnu 0.36.1
  • windows_i686_msvc 0.36.1
  • windows_x86_64_gnu 0.36.1
  • windows_x86_64_msvc 0.36.1
  • zip 0.5.13
.github/workflows/build.yml actions
  • PyO3/maturin-action v1 composite
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/documentation.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • peaceiris/actions-gh-pages v3 composite
Cargo.toml cargo
pyproject.toml pypi
  • numpy >=1.20.0
  • pyrocko >=2022.4.28
  • requests >=2.20.0
setup.py pypi