SCRUG-NA/2025
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[installation] Change to nightly

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

183
share/man/man1/scautoloc.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SCAUTOLOC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
.TH "SCAUTOLOC" "1" "Oct 29, 2025" "7.0.0" "SeisComP"
.SH NAME
scautoloc \- SeisComP Documentation
.sp
@ -46,8 +46,8 @@ but can also be provided by other means.
.sp
scautoloc normally runs as a \fI\%daemon\fP
continuously reading picks and amplitudes and processing them in real time. An
\fI\%offline mode\fP is available as well, e.g., for
playbacks on demand.
\fI\%offline mode and non\-real\-time processing\fP
are available as well, e.g., for playbacks on demand.
.SH LOCATION PROCEDURE
.sp
The procedure of scautoloc to identify and locate seismic events basically
@ -370,10 +370,11 @@ receives picks and amplitudes from there, but no results are sent back to
the server. Log files are written as usual. This mode can be used to test
new parameter settings before implementation in the real\-time system. It also
provides a simple way to log picks from a real\-time system to the pick log.
.SH DAEMON MODE
.SH REAL-TIME PROESSING
.SS Daemon Mode
.sp
For running scautoloc continuously in the background as a daemon it must be
enabled and started:
For running scautoloc continuously in real time and in the background as a
daemon it must be enabled and started:
.INDENT 0.0
.INDENT 3.5
.sp
@ -385,20 +386,68 @@ seiscomp start scautoloc
.fi
.UNINDENT
.UNINDENT
.SH OFFLINE MODE
.SS On\-demand proessing
.sp
scautoloc normally runs as a daemon in the background, continuously reading
picks and amplitudes and processing them in real time. However, scautoloc
may also be operated in offline mode. This is useful for debugging. Offline
mode is activated by adding the command\-line parameter \fB\-\-ep\fP or
\fB\-\-offline\fP\&. When operated in offline mode,
You may execute scautoloc on the command\-line on demand giving the
possibility to use specific command\-line options.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
scautoloc \-\-debug
.ft P
.fi
.UNINDENT
.UNINDENT
.SH NON-REAL TIME PROCESSING
.sp
scautoloc normally runs in real time as a daemon in the background, continuously
receiving and processing picks and amplitudes from messaging in real time.
However, scautoloc may also be operated in non\-real\-time/offline mode. This is
useful for fast playbacks or debugging and tuning. Non\-real\-time processing is
activated by adding the command\-line parameter \fB\-\-ep\fP and, for
offline mode, \fB\-\-offline\fP\&. Then,
scautoloc will not connect to the messaging. Instead, it reads picks from a
\fI\%SCML\fP file provided with \fB\-\-ep\fP or from standard input in the pick file
format. The station coordinates are read from the inventory in the database or
from the file either defined in \fI\%autoloc.stationLocations\fP or
\-\e\-station\-locations .
\fI\%SCML\fP file provided with \fB\-\-ep\fP or from standard input in the
\fIpick file format\fP\&. The station coordinates are read from the inventory in the
database or from the file either defined in \fI\%autoloc.stationLocations\fP
or \fB\-\-station\-locations\fP\&.
.sp
Example for entries in a pick file
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When picks are created in real time, they are generally not in order of pick
time but in the order of creation time because of data latencies. Therefore,
processing of picks created in real time may result in differences to
playbacks of picks created in non\-real\-time playbacks.
.UNINDENT
.UNINDENT
.SS Non\-real\-time playback from XML
.sp
Non\-real\-time playback may be based on picks and amplitudes (snr and mb) in an
\fI\%SCML\fP file. The database must be specified explicitly since it cannot be
received from the messaging. All picks, amplitudes and resulting origins are
output to stdout in SCML which can be redirected to an unformatted or formatted
file, \fBorigins.xml\fP\&.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
scautoloc \-d [database] \-\-ep picks.xml \-f > origins.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Offline mode
.sp
Offline mode works with \fB\-\-offline\fP and picks are to be provided in the
\fIpick file format\fP:
.INDENT 0.0
.INDENT 3.5
.sp
@ -425,15 +474,14 @@ Example for entries in a pick file
where [id] is a placeholder for the real pick id which has been omitted in this
example.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
In the above example some of the picks are not in right order of
time because of data latencies. In offline mode scautoloc will not connect to
the database, in consequence the station coordinates cannot be read from the
database and thus have to be supplied via a file. The station coordinates file
has a simple format with one line per entry, consisting of 5 columns: network
code, station code, latitude, longitude, elevation (in meters). Example:
In offline mode scautoloc will not connect to the database. In consequence
station coordinates cannot be read from the database and must be supplied via
a station coordinates file. This file has a simple format with one line per
station, consisting of 5 columns:
network code, station code, latitude, longitude, elevation (in meters).
Sensor locations are not treated separately.
.sp
Example of a station coordinates file:
.INDENT 0.0
.INDENT 3.5
.sp
@ -451,11 +499,9 @@ GE CISI \-7.5557 107.8153 0.0
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The location of this file is specified in \fI\%autoloc.stationLocations\fP or on the
command line using \-\e\-station\-locations
The name of this file is configured in \fI\%autoloc.stationLocations\fP or
passed on the command line using \fB\-\-station\-locations\fP\&.
.SH SCAUTOPICK AND SCAUTOLOC INTERACTION
.sp
The two main programs in the automatic event detection and location processing
@ -463,7 +509,7 @@ chain, \fI\%scautopick\fP and \fBscautoloc\fP, only work together if the
information needed by scautoloc can be supplied by \fI\%scautopick\fP and received
by \fBscautoloc\fP through the message group defined by
\fBconnection.subscription\fP or through \fI\%SCML\fP (\fB\-\-ep\fP,
\fB\-i\fP). This document explains current
\fB\-\-input\fP). This document explains current
implicit dependencies between these two utilities and is meant as a guide
especially for those who plan to modify or replace one or both of these
utilities by own developments.
@ -634,7 +680,7 @@ Time to keep picks in the buffer with respect to pick time, not creation time.
.B buffer.originKeep
Default: \fB86400\fP
.sp
Type: \fIinteger\fP
Type: \fIint\fP
.sp
Unit: \fIs\fP
.sp
@ -645,7 +691,7 @@ Time to keep origins in buffer.
.B buffer.cleanupInterval
Default: \fB3600\fP
.sp
Type: \fIinteger\fP
Type: \fIint\fP
.sp
Unit: \fIs\fP
.sp
@ -686,7 +732,7 @@ Maximum travel\-time residual (unweighted) for a pick at a station to be used.
.B autoloc.minPhaseCount
Default: \fB6\fP
.sp
Type: \fIinteger\fP
Type: \fIint\fP
.sp
Minimum number of phases for reporting origins.
.UNINDENT
@ -731,7 +777,7 @@ Maximum epicntral distance to stations for accepting picks.
.B autoloc.minStaCountIgnorePKP
Default: \fB15\fP
.sp
Type: \fIinteger\fP
Type: \fIint\fP
.sp
If the station count for stations at < 105 degrees distance
exceeds this number, no picks at > 105 degrees will be
@ -765,7 +811,7 @@ amplitude object. If it is empty, the pick SNR is 10.
.B autoloc.grid
Default: \fB@DATADIR@/scautoloc/grid.conf\fP
.sp
Type: \fIpath\fP
Type: \fIfile\fP
.sp
Location of the grid file for nucleating origins.
.UNINDENT
@ -774,14 +820,14 @@ Location of the grid file for nucleating origins.
.B autoloc.stationConfig
Default: \fB@DATADIR@/scautoloc/station.conf\fP
.sp
Type: \fIpath\fP
Type: \fIfile\fP
.sp
Location of the station configuration file for nucleating origins.
.UNINDENT
.INDENT 0.0
.TP
.B autoloc.stationLocations
Type: \fIpath\fP
Type: \fIfile\fP
.sp
The station file to be used when in offline mode.
If no file is given the database is used. An example is given
@ -883,7 +929,7 @@ Activate for writing pick log files to \(dqpickLog\(dq.
.B autoloc.pickLog
Default: \fB@LOGDIR@/autoloc\-picklog\fP
.sp
Type: \fIstring\fP
Type: \fIfile\fP
.sp
Location of pick log file containing information about received
picks. Activate \(dqpickLogEnable\(dq for writing the files.
@ -936,7 +982,7 @@ BOTH minAmplitude and minSNR need to be exceeded!
.B autoloc.xxl.minPhaseCount
Default: \fB4\fP
.sp
Type: \fIinteger\fP
Type: \fIint\fP
.sp
Minimum number of XXL picks for forming an origin.
Must be >= 4.
@ -1102,10 +1148,14 @@ This option can be given more than once.
.TP
.B \-\-content\-type arg
Overrides configuration parameter \fI\%connection.contentType\fP\&.
.sp
Default: \fBbinary\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-start\-stop\-msg arg
Default: \fB0\fP
.sp
Set sending of a start and a stop message.
.UNINDENT
.SS Database
@ -1172,9 +1222,9 @@ Flush origins immediately without delay.
.TP
.B \-\-ep file
Name of input XML file (SCML) with all picks and origins for
offline processing. The database connection is not received
from messaging and must be provided. Results are sent in XML
to stdout.
offline processing. Use \(aq\-\(aq to read from stdin. The
database connection is not received from messaging and must
be provided. Results are sent in XML to stdout.
.UNINDENT
.SS Settings
.INDENT 0.0
@ -1209,106 +1259,153 @@ even when disabled by configuration.
.INDENT 0.0
.TP
.B \-\-default\-depth arg
Default: \fB10\fP
.sp
Default depth for comparison with the depth after locating.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-sgap arg
Default: \fB360\fP
.sp
Maximum secondary azimuthal gap for an origin to be reported.
The secondary gap is the maximum of the sum of 2 station gaps.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-rms arg
Default: \fB3.5\fP
.sp
Maximum travel\-time RMS for a location to be reported.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-residual arg
Default: \fB3\fP
.sp
Maximum travel\-time residual (unweighted) for a pick at a
station to be used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-station\-distance arg
Default: \fB5\fP
.sp
Maximum distance of stations to be used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-nucleation\-distance\-default arg
Default: \fB180\fP
.sp
Default maximum distance of stations to be used for nucleating new origins.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-pick\-affinity arg
Default: \fB0.05\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-phase\-count arg
Default: \fB4\fP
.sp
Minimum number of picks for an origin to be reported.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-score arg
Default: \fB8\fP
.sp
Minimum score for an origin to be reported.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-pick\-snr arg
Default: \fB3\fP
.sp
Minimum SNR for a pick to be processed.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-threshold\-xxl arg
Default: \fB10000000\fP
.sp
An amplitude exceeding this threshold will flag the pick as XXL.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-phase\-count\-xxl arg
Default: \fB4\fP
.sp
Minimum number of picks for an XXL origin to be reported.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-distance\-xxl arg
Default: \fB15\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-sta\-count\-ignore\-pkp arg
Default: \fB15\fP
.sp
Minimum station count for which we ignore PKP phases.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-score\-bypass\-nucleator arg
Default: \fB40\fP
.sp
Minimum score at which the nucleator is bypassed.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keep\-events\-timespan arg
Default: \fB86400\fP
.sp
The timespan to keep historical events.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-cleanup\-interval arg
Default: \fB3600\fP
.sp
The object cleanup interval in seconds.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-max\-age arg
Default: \fB3784320000\fP
.sp
During cleanup all pick objects older than maxAge (in seconds)
are removed (maxAge == 0 disables cleanup).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-wakeup\-interval arg
Default: \fB5\fP
.sp
Unit: \fIs\fP
.sp
The interval in seconds to check pending operations.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-dynamic\-pick\-threshold\-interval arg
Default: \fB60\fP
.sp
The interval in seconds in which to check for extraordinarily
high pick activity, resulting in a dynamically increased
pick threshold.
.UNINDENT
.SS Output
.INDENT 0.0
.TP
.B \-f, \-\-formatted
Use formatted XML output along with \(aq\-\-ep\(aq. Otherwise XML
is unformatted.
.UNINDENT
.SH AUTHOR
gempa GmbH, GFZ Potsdam
.SH COPYRIGHT