[README] added some necessary information to the README for first release; renamed pylot_sample.in for convenience and removed an obsolete import
This commit is contained in:
parent
ae0cc5e160
commit
91c181ef2d
74
README.md
74
README.md
@ -5,7 +5,7 @@ version: 0.1a
|
|||||||
The Python picking and Localisation Tool
|
The Python picking and Localisation Tool
|
||||||
|
|
||||||
This python library contains a graphical user interfaces for picking
|
This python library contains a graphical user interfaces for picking
|
||||||
seismic phases. This software needs ObsPy (http://github.com/obspy/obspy/wiki)
|
seismic phases. This software needs [ObsPy][ObsPy]
|
||||||
and the PySide Qt4 bindings for python to be installed first.
|
and the PySide Qt4 bindings for python to be installed first.
|
||||||
|
|
||||||
PILOT has originally been developed in Mathworks' MatLab. In order to
|
PILOT has originally been developed in Mathworks' MatLab. In order to
|
||||||
@ -16,7 +16,67 @@ 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.
|
||||||
|
|
||||||
staff:
|
##Installation
|
||||||
|
|
||||||
|
At the moment there is no automatic installation procedure available for PyLoT.
|
||||||
|
Best way to install is to clone the repository and add the path to your Python path.
|
||||||
|
|
||||||
|
####prerequisites:
|
||||||
|
|
||||||
|
In order to run PyLoT you need to install:
|
||||||
|
|
||||||
|
- python
|
||||||
|
- scipy
|
||||||
|
- numpy
|
||||||
|
- matplotlib
|
||||||
|
- obspy
|
||||||
|
- pyside
|
||||||
|
|
||||||
|
####some handwork
|
||||||
|
|
||||||
|
PyLoT needs a properties folder on your system to work. It should be situated in your home directory:
|
||||||
|
|
||||||
|
mkdir ~/.pylot
|
||||||
|
|
||||||
|
In the next step you have to copy some files to this directory:
|
||||||
|
|
||||||
|
cp path-to-pylot/inputs/pylot.in ~/.pylot/
|
||||||
|
|
||||||
|
for local distance seismicity
|
||||||
|
|
||||||
|
cp path-to-pylot/inputs/autoPyLoT_local.in ~/.pylot/autoPyLoT.in
|
||||||
|
|
||||||
|
for regional distance seismicity
|
||||||
|
|
||||||
|
cp path-to-pylot/inputs/autoPyLoT_regional.in ~/.pylot/autoPyLoT.in
|
||||||
|
|
||||||
|
and some extra information on filtering, error estimates (just needed for reading old PILOT data) and the Richter magnitude scaling relation
|
||||||
|
|
||||||
|
cp path-to-pylot/inputs/filter.in path-to-pylot/inputs/PILOT_TimeErrors.in path-to-pylot/inputs/richter_scaling.data ~/.pylot/
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
##release notes:
|
||||||
|
==============
|
||||||
|
|
||||||
|
#### Features
|
||||||
|
|
||||||
|
- consistent manual phase picking through predefined SNR dependant zoom level
|
||||||
|
- 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
|
||||||
|
- location determination with external installation of [NonLinLoc](http://alomax.free.fr/nlloc/index.html)
|
||||||
|
|
||||||
|
#### Known issues
|
||||||
|
|
||||||
|
- Magnitude estimation from manual PyLoT takes some time (instrument correction)
|
||||||
|
|
||||||
|
We hope to solve these with the next release.
|
||||||
|
|
||||||
|
####staff:
|
||||||
======
|
======
|
||||||
|
|
||||||
original author(s): L. Kueperkoch, S. Wehling-Benatelli, M. Bischoff (PILOT)
|
original author(s): L. Kueperkoch, S. Wehling-Benatelli, M. Bischoff (PILOT)
|
||||||
@ -26,15 +86,7 @@ developer(s): S. Wehling-Benatelli, L. Kueperkoch, K. Olbert, M. Bischoff,
|
|||||||
|
|
||||||
others: A. Bruestle, T. Meier, W. Friederich
|
others: A. Bruestle, T. Meier, W. Friederich
|
||||||
|
|
||||||
release notes:
|
|
||||||
==============
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- consistent manual phase picking through:
|
|
||||||
1. predefined SNR dependant zoom level
|
|
||||||
2.
|
|
||||||
|
|
||||||
|
|
||||||
|
[ObsPy]: http://github.com/obspy/obspy/wiki
|
||||||
|
|
||||||
October 2016
|
October 2016
|
||||||
|
@ -17,7 +17,6 @@ from pylot.core.pick.charfuns import CharacteristicFunction
|
|||||||
from pylot.core.pick.charfuns import HOScf, AICcf, ARZcf, ARHcf, AR3Ccf
|
from pylot.core.pick.charfuns import HOScf, AICcf, ARZcf, ARHcf, AR3Ccf
|
||||||
from pylot.core.pick.utils import checksignallength, checkZ4S, earllatepicker, \
|
from pylot.core.pick.utils import checksignallength, checkZ4S, earllatepicker, \
|
||||||
getSNR, fmpicker, checkPonsets, wadaticheck
|
getSNR, fmpicker, checkPonsets, wadaticheck
|
||||||
from pylot.core.util.dataprocessing import restitute_data
|
|
||||||
from pylot.core.util.utils import getPatternLine
|
from pylot.core.util.utils import getPatternLine
|
||||||
from pylot.core.io.data import Data
|
from pylot.core.io.data import Data
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user