README.md 2.35 KB
Newer Older
Sebastian Heimann's avatar
Sebastian Heimann committed
1
2
3
4
# Lassie

*A friendly earthquake detector.*

Sebastian Heimann's avatar
Sebastian Heimann committed
5
6
7
8
9
## Installation

First, install [Pyrocko](http://emolch.github.io/pyrocko/v0.3/install.html),
then install Lassie:

10
```bash
Sebastian Heimann's avatar
Sebastian Heimann committed
11
12
13
14
15
git clone https://gitext.gfz-potsdam.de/heimann/lassie.git
cd lassie
sudo python setup.py install
```

Sebastian Heimann's avatar
Sebastian Heimann committed
16
17
18
## Tutorial: detecting events in a regional network

This tutorial explains how to use Lassie to detect events in a regional
19
20
21
network. The one-day test dataset from the Alentejo region in South Portugal
can be downloaded from
http://kinherd.org/lassie-example-alentejo.tar (235 MB). Data from 12 seismic
Sebastian Heimann's avatar
Sebastian Heimann committed
22
23
stations from the
[DOCTAR](http://www.geo.uni-potsdam.de/doctar-1317/articles/doctar-1317.html)
24
25
26
experiment and from 5 permanent stations from regional networks [REFERENCE] are
included. A region of roughly 100 x 100 km is covered by the available data.

27
#### Dataset preparation
28
29
30
31
32
33

```bash
# download data and unpack
wget http://kinherd.org/lassie-example-alentejo.tar
tar -xf lassie-example-alentejo.tar
cd lassie-example-alentejo
Sebastian Heimann's avatar
Sebastian Heimann committed
34
ls
35
# data/                 - raw waveforms in mseed format
Sebastian Heimann's avatar
Sebastian Heimann committed
36
37
38
39
40
41
42
43
44
45
# stations.txt          - text file with station coordinates
# confirmed-events.txt  - catalog with some known events
```

To get a quick overview on the dataset, use the 
[Snuffler](http://emolch.github.io/pyrocko/v0.3/snuffler_tutorial.html) 
application which is part of [Pyrocko](http://emolch.github.io/pyrocko/).

```bash
snuffler --stations=stations.txt --events=confirmed-events.txt data/
46
```
Sebastian Heimann's avatar
Sebastian Heimann committed
47

Sebastian Heimann's avatar
Sebastian Heimann committed
48
#### Hints, when preparing your own dataset:
49
50
51
52
53
54
55
56

* NET.STA.LOC codes in waveform files must match exactly what is given in the
  stations file.
* Waveform files and directory layout do not have to follow any specific
  convention, but with large files, data access can become less efficient. As a
  rule of thumb, use files smaller than 1MB each. To cut a dataset into a new
  chunksize, use the Jackseis program which is part of
  [Pyrocko](http://emolch.github.io/pyrocko/):
Sebastian Heimann's avatar
Sebastian Heimann committed
57
```bash
58
59
  # cut whole dataset to hour files:
  jackseis INPUT_DIR --tinc=3600 --output-dir=OUTPUT_DIR
Sebastian Heimann's avatar
Sebastian Heimann committed
60
```
61
62
63
64
65
66
67
68
69
70
71
72
73

#### Lassie configuration

Lassie reads its configuration from a text file in the
[YAML](https://en.wikipedia.org/wiki/YAML) format. To create an initial
configuration, run

```bash
lassie init > config.lassie
# or filling in already the names of the stations file and the waveform directory:
lassie init --stations=stations.txt data > config.lassie
```

Sebastian Heimann's avatar
Sebastian Heimann committed
74