Skip to content

Commit de21a19

Browse files
author
Marius Isken
committed
Update README
1 parent 10fd02c commit de21a19

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,16 @@
22

33
*Tools for distributed acoustic sensing and modelling.*
44

5-
![PyPI](https://img.shields.io/pypi/v/lightguide)
6-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lightguide)](https://pypi.org/project/lightguide)
7-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
5+
[![PyPI](https://img.shields.io/pypi/v/lightguide)](https://pypi.org/project/lightguide/)
6+
[![build](https://github.com/pyrocko/lightguide/actions/workflows/build.yml/badge.svg)](https://github.com/pyrocko/lightguide/actions/workflows/build.yml)
87
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
9-
[![CI](https://github.com/pyrocko/lightguide/actions/workflows/build.yml/badge.svg)](https://github.com/pyrocko/lightguide/actions/workflows/build.yml)
8+
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
109

1110
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](https://pyrocko.org). Through Pyrocko's I/O engine :rocket: lightguide supports handling the following DAS data formats:
1211

12+
- MiniSEED
1313
- Silixa iDAS (TDMS data)
1414
- ASN OptoDAS
15-
- MiniSEED
1615

1716
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.
1817

@@ -28,22 +27,22 @@ pip install lightguide
2827

2928
## Usage
3029

31-
### Adaptive frequency filter
30+
### Documentation
3231

33-
The adaptive frequency filter (AFK) can be used to suppress incoherent noise in DAS data sets.
32+
Find the [documentation here](https://pyrocko.github.io/lightguide/).
3433

35-
```python
36-
from lightguide import filters
37-
from lightguide.utils import download_numpy, ExampleData
34+
### Adaptive frequency filter
3835

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

40-
das_data = download_numpy(ExampleData.VSPData)
38+
```py
39+
from lightguide.blast import Blast
4140

42-
filtered_data = filters.afk_filter(
43-
das_data, window_size=32, overlap=15, exponent=0.8, normalize_power=False)
41+
blast = Blast.from_miniseed("my-data.mseed")
42+
blast.lowpass(corner_freq=60.0)
43+
blast.afk_filter(exponent=0.8)
4444
```
4545

46-
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/pyrocko/lightguide/blob/master/examples/1-denoise-DAS-data.ipynb)
4746

4847
The filtering performance of the AFK filter, applied to an earthquake recording at an [ICDP](https://www.icdp-online.org/home/) borehole observatory in Germany. The data was recorded on a [Silixa](https://silixa.com/) iDAS v2. For more details see <https://doi.org/10.5880/GFZ.2.1.2022.006>.
4948

@@ -97,6 +96,7 @@ maturin develop
9796
The project utilizes pre-commit for clean commits, install the hooks via:
9897

9998
```sh
99+
pip install pre-commit
100100
pre-commit install
101101
```
102102

0 commit comments

Comments
 (0)