marcel/pylot
3
0
Fork 0
Code Issues 7 Pull Requests 1 Releases Wiki Activity

[update] README.md

Browse Source
This commit is contained in:
Marcel Paffrath 2017-09-21 15:34:29 +02:00
parent c19f057abf
commit af5953b053
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,6 +1,6 @@
# PyLoT
version: 0.1a
version: 0.2
The Python picking and Localisation Tool
@ -14,7 +14,7 @@ to redevelop the software package in Python. The great work of the ObsPy
group allows easy handling of a bunch of seismic data and PyLoT will
benefit a lot compared to the former MatLab version.
The development of PyLoT is part of the joint research project MAGS2.
The development of PyLoT is part of the joint research project MAGS2 and AlpArray.
## Installation
@ -44,11 +44,15 @@ In the next step you have to copy some files to this directory:
for local distance seismicity
cp path-to-pylot/inputs/autoPyLoT_local.in ~/.pylot/autoPyLoT.in
cp path-to-pylot/inputs/pylot_local.in ~/.pylot/pylot.in
for regional distance seismicity
cp path-to-pylot/inputs/autoPyLoT_regional.in ~/.pylot/autoPyLoT.in
cp path-to-pylot/inputs/pylot_regional.in ~/.pylot/pylot.in
for global distance seismicity
cp path-to-pylot/inputs/pylot_global.in ~/.pylot/pylot.in
and some extra information on error estimates (just needed for reading old PILOT data) and the Richter magnitude scaling relation
@ -56,14 +60,16 @@ and some extra information on error estimates (just needed for reading old PILOT
You may need to do some modifications to these files. Especially folder names should be reviewed.
PyLoT has been tested on Mac OSX (10.11) and Debian Linux 8.
PyLoT has been tested on Mac OSX (10.11), Debian Linux 8 and on Windows 10.
## Release notes
#### Features:
- event organisation in project files and waveform visualisation
- consistent manual phase picking through predefined SNR dependant zoom level
- consistent automatic phase picking routines using Higher Order Statistics, AIC and Autoregression
- uniform uncertainty estimation from waveform's properties for automatic and manual picks
- pdf representation and comparison of picks taking the uncertainty intrinsically into account
- Richter and moment magnitude estimation
@ -71,7 +77,7 @@ PyLoT has been tested on Mac OSX (10.11) and Debian Linux 8.
#### Known issues:
- Magnitude estimation from manual PyLoT takes some time (instrument correction)
- Sometimes an error might occur when using Qt
We hope to solve these with the next release.
@ -87,4 +93,4 @@ Others: A. Bruestle, T. Meier, W. Friederich
[ObsPy]: http://github.com/obspy/obspy/wiki
October 2016
September 2017