.. highlight:: rst
.. _screloc:
#######
screloc
#######
**Automatic relocator.**
Description
===========
Funded by `SED/ETH Zurich `_, developed by
`gempa GmbH `_. This plugin is available from SeisComP3
version Release Potsdam 2010 and later.
screloc is an automatic relocator that receives origins from realtime
locators such as scautoloc and relocates them with a configurable locator.
To run screloc along with all processing modules add it to the list of
clients in the seiscomp configuration frontend.
screloc does not yet listen to event information and does not skip origins for
that a more recent one exists. Instead any incoming automatic origin is
processed.
The following example configuration show how to setup screloc for
:ref:`NonLinLoc `:
.. code-block:: sh
plugins = ${plugins}, locnll
# Define the locator algorithm to use
reloc.locator = NonLinLoc
########################################################
################ NonLinLoc configuration################
########################################################
NLLROOT = ${HOME}/nll/data
NonLinLoc.outputPath = ${NLLROOT}/output/
# Define the default control file if no profile specific
# control file is defined.
NonLinLoc.controlFile = ${NLLROOT}/NLL.default.conf
# Set the default pick error in seconds passed to NonLinLoc
# if no SC3 pick uncertainty is available.
NonLinLoc.defaultPickError = 0.1
# Define the available NonLinLoc location profiles. The order
# implicitly defines the priority for overlapping regions
#NonLinLoc.profiles = swiss_3d, swiss_1d, global
NonLinLoc.profiles = swiss_3d, global
# The earthModelID is copied to earthModelID attribute of the
# resulting origin
NonLinLoc.profile.swiss_1d.earthModelID = "swiss regional 1D"
# Specify the velocity model table path as used by NonLinLoc
NonLinLoc.profile.swiss_1d.tablePath = ${NLLROOT}/time_1d_regio/regio
# Specify the region valid for this profile
NonLinLoc.profile.swiss_1d.region = 41.2, 3.8, 50.1, 16.8
# The NonLinLoc default control file to use for this profile
NonLinLoc.profile.swiss_1d.controlFile = ${NLLROOT}/NLL.swiss_1d.conf
# Configure the swiss_3d profile
NonLinLoc.profile.swiss_3d.earthModelID = "swiss regional 3D"
NonLinLoc.profile.swiss_3d.tablePath = ${NLLROOT}/time_3d/ch
NonLinLoc.profile.swiss_3d.region = 45.15, 5.7, 48.3, 11.0
NonLinLoc.profile.swiss_3d.controlFile = ${NLLROOT}/NLL.swiss_3d.conf
# And the global profile
NonLinLoc.profile.global.earthModelID = iaspei91
NonLinLoc.profile.global.tablePath = ${NLLROOT}/iasp91/iasp91
NonLinLoc.profile.global.controlFile = ${NLLROOT}/NLL.global.conf
Configuration
=============
| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/screloc.cfg`
| :file:`etc/global.cfg`
| :file:`etc/screloc.cfg`
| :file:`~/.seiscomp3/global.cfg`
| :file:`~/.seiscomp3/screloc.cfg`
screloc inherits :ref:`global options`.
.. confval:: reloc.locator
Type: *string*
Defines the locator to be used such as NonLinLoc.
Command-line
============
.. program:: screloc
Generic
-------
.. option:: -h, --help
show help message.
.. option:: -V, --version
show version information
.. option:: --config-file arg
Use alternative configuration file. When this option is used
the loading of all stages is disabled. Only the given configuration
file is parsed and used. To use another name for the configuration
create a symbolic link of the application or copy it, eg scautopick \-> scautopick2.
.. option:: --plugins arg
Load given plugins.
.. option:: -D, --daemon
Run as daemon. This means the application will fork itself and
doesn't need to be started with \&.
.. option:: --auto-shutdown arg
Enable\/disable self\-shutdown because a master module shutdown. This only
works when messaging is enabled and the master module sends a shutdown
message \(enabled with \-\-start\-stop\-msg for the master module\).
.. option:: --shutdown-master-module arg
Sets the name of the master\-module used for auto\-shutdown. This
is the application name of the module actually started. If symlinks
are used then it is the name of the symlinked application.
.. option:: --shutdown-master-username arg
Sets the name of the master\-username of the messaging used for
auto\-shutdown. If \"shutdown\-master\-module\" is given as well this
parameter is ignored.
Verbosity
---------
.. option:: --verbosity arg
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
.. option:: -v, --v
Increase verbosity level \(may be repeated, eg. \-vv\)
.. option:: -q, --quiet
Quiet mode: no logging output
.. option:: --component arg
Limits the logging to a certain component. This option can be given more than once.
.. option:: -s, --syslog
Use syslog logging back end. The output usually goes to \/var\/lib\/messages.
.. option:: -l, --lockfile arg
Path to lock file.
.. option:: --console arg
Send log output to stdout.
.. option:: --debug
Debug mode: \-\-verbosity\=4 \-\-console
.. option:: --log-file arg
Use alternative log file.
Messaging
---------
.. option:: -u, --user arg
Overrides configuration parameter :confval:`connection.username`.
.. option:: -H, --host arg
Overrides configuration parameter :confval:`connection.server`.
.. option:: -t, --timeout arg
Overrides configuration parameter :confval:`connection.timeout`.
.. option:: -g, --primary-group arg
Overrides configuration parameter :confval:`connection.primaryGroup`.
.. option:: -S, --subscribe-group arg
A group to subscribe to. This option can be given more than once.
.. option:: --encoding arg
Overrides configuration parameter :confval:`connection.encoding`.
.. option:: --start-stop-msg arg
Sets sending of a start\- and a stop message.
Database
--------
.. option:: --db-driver-list
List all supported database drivers.
.. option:: -d, --database arg
The database connection string, format: service:\/\/user:pwd\@host\/database.
\"service\" is the name of the database driver which can be
queried with \"\-\-db\-driver\-list\".
.. option:: --config-module arg
The configmodule to use.
.. option:: --inventory-db arg
Load the inventory database from a given XML file.
.. option:: --db-disable
Do not use the database at all
Mode
----
.. option:: --test
test mode, do not send any message
Input
-----
.. option:: -O, --origin-id arg
reprocess the origin and send a message unless test mode is activated
.. option:: --locator arg
the locator type to use