This python script wraps-up PhaseNet for use as a picker within an Earthworm installation. For manual validation of the results, we recommend to use SeisComP or SeisComP3 software to build a catalog of the events with magnitudes.
Retailleau, L., Saurel, J.-M., Zhu, W., Satriano, C., Beroza, G. C, Issartel, S., Boissier, P., OVPF Team and OVSM Team (2022). A wrapper to use a machine-learning-based algorithm for earthquake monitoring, Seismological Research Letter, XX, 1-9, 10.1785/0220210279.
_
PhaseWorm can access data from 4 differents data sources, using ObsPy clients:
- SeedLink
- FDSN webservice
- Earthworm WaveServerV
- SDS disk file archive
Picks can be written as Earthworm TYPE_PICK_SCNL messages files or simply written to the standard output.
PhaseWorm can run in an infinite loop in an almost real-time manner and can also process (replay) old data.
PhaseNet identifies P and S arrivals and PhaseWorm binds them to, respectively, vertical and horizontal channels.
The PhaseWorm code has been developed with Python 3.8, ObsPy 1.2.2 and Earthworm v7.10. The PhaseNet included version uses TensorFlow 2.
Note that TensorFlow 2 is currently not compatible with Python 3.9.
Download PhaseWorm by cloning the repository into your local installation directory.
git clone https://github.com/jmsaurel/phaseworm.git
A python environment with proper libraries and modules is necessary to run PhaseWorm and the underlying PhaseNet.
conda create --name phaseworm python=3.8
conda activate phaseworm
conda install tensorflow=2.3
conda install matplotlib scipy numpy
conda install obspy -c conda-forge
pip install virtualenv
virtualenv .phaseworm
source .phaseworm/bin/activate
You can install PhaseWorm using pip from the main directory:
pip install .
Or, in "developer mode":
pip install -e .
PhaseWorm is designed to output TYPE_PICK_SCNL Earthworm messages files that will be read by the file2ew module and injected into a RingBuffer.
Because PhaseNet is designed to use overlapping time sequences, it is recommended to use a pkfilter module to remove duplicated picks.
PhaseWorm pick file should be looked for regularly by the file2ew module to be injected in the correct RingBuffer. We recommend a scan every 0.5 second and no logging extensive logging. Pick files are written by PhaseWorm with the file extension .pick.
Because pick files are written, and then a hard symlink made to the file2ew deposit directory, it's recommended to not activate the SaveDataFiles option.
The SuffixType option should be configure with the InsitutionID used in the Earthworm setup.
CheckPeriod 0.5 # sleep this many seconds between looks
OpenTries 2 # How many times we'll try to open a file
OpenWait 100 # Milliseconds to wait between open tries
SaveDataFiles 0 # 0 = remove files after processing
LogOutgoingMsg 0
SuffixType .pick TYPE_PICK_SCNL INST_xxx
PhaseNet picks predictions are equally accurate when working on overlapping data windows. We recommend a value of 0.05 seconds for PickTolerance.
When working with 30s timewindows, a pick could be detected only on the next overlapping time window. We then allow 60s OlderPickLimit to be checked.
PickTolerance 0.05
OlderPickLimit 60
Binder_ew module should be setup as usual, according to the local area settings. However, to take full advantage of the P and S phase identifications from PhaseNet, two parameters should be activated:
- no_S_on_Z (only PhaseNet P readings are sent on vertical channels)
- no_P_on_Horiz (only PhaseNet S readings are sent on horizontal channels)
Since S phases are sent to horizontal channel, binder_ew shouldn't be allowed to initiate the stack on horizontal channels.
Currently, PhaseNet doesn't output any amplitude pick measurements. It's then recommended not to use the S to P amplitude ratio setting.
# stack_horizontals
# s_to_p_amp_ratio 2.0
no_S_on_Z
no_P_on_Horiz
Because PhaseNet picks S readings, it's important to activate them in eqassemble module.
ReportS 1
By default, PhaseWorm will use the configuration from the config.cfg file.
phaseworm
Alternative configuration file can be passed on the command line.
phaseworm --config-file /my/path/to/my_config.cfg
The configuration file is divided into 3 different sections.
This section defines variables linked to the Earthworm setup that will be used
to process the pick messages (module_id, inst_id, message_id).
This section also defines the directory in which TYPE_PICK_SCNL messages
will be written to.
This section defines PhaseNet related variables. Currently there is only one available variable: the neural network training file to use. The recommended default is to use the file shipped with PhaseNet and included in this bundle.
If you have trained PhaseNet on your own data, you might want to use your training file.
The general section contains various variables to set-up PhaseWorm:
- data source
- time window lenght to process
- network.stations to look for
- channels priority list to look for each station
- replay or real-time mode
- whether to activate or not the TYPE_PICK_SCNL message writing.
Two configuration examples are shipped: config_replay.cfg and config_rt.cfg.
The file config_replay.cfg contains a configuration for replay use.
PhaseWorm reads data from FDSN webservice, starting from xxx until xxx.
The file config_rt.cfg contains a configuration for near real-time use.
PhaseWorm reads data from an Earthworm WaveServerV (recommended) or SeedLink.
PhaseWorm write picks in the TYPE_PICK_SCNL directory.
PhaseNet code was simplified on purpose by Weiqiang Zhu.
Data preprocessing was designed and implemented by Lise Retailleau.
Overall wrapping was done by Jean-Marie Saurel.
Claudio Satriano provided extensive code review.
Testing was performed on Mayotte seismo-volcano crisis for the Réseau de surveillance volcanologique et sismologique de Mayotte: REVOSIMA.