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

[seiscomp, scanloc] Install, add .gitignore

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-09 15:07:02 +02:00
commit 20f5301bb1
2848 changed files with 1315858 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

457
share/man/man1/scalert.1 Normal file
View File

@ -0,0 +1,457 @@
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SCALERT" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
.SH NAME
scalert \- SeisComP Documentation
.sp
\fBReal time alert template.\fP
.SH DESCRIPTION
.sp
This module executes custom scripts upon arrival of objects or updates.
It provides as template for custom modification and is not a replacement for \fI\%scvoice\fP\&.
.sp
There are four possible trigger mechanisms for calling scripts:
.INDENT 0.0
.IP \(bu 2
Event creation/update,
.IP \(bu 2
Amplitude creation,
.IP \(bu 2
Origin creation (with status = preliminary),
.IP \(bu 2
Pick creation with filter for phase hint.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
People started modifying \fI\%scvoice\fP to send emails or
other alert messages. Then, the name \fIscvoice\fP is then just wrong.
If you want to customize \fI\%scvoice\fP, use scalert instead.
.UNINDENT
.UNINDENT
.SH MODULE CONFIGURATION
.nf
\fBetc/defaults/global.cfg\fP
\fBetc/defaults/scalert.cfg\fP
\fBetc/global.cfg\fP
\fBetc/scalert.cfg\fP
\fB~/.seiscomp/global.cfg\fP
\fB~/.seiscomp/scalert.cfg\fP
.fi
.sp
.sp
scalert inherits \fI\%global options\fP\&.
.INDENT 0.0
.TP
.B firstNew
Default: \fBfalse\fP
.sp
Type: \fIboolean\fP
.sp
Treat an event as new event when it is seen the first time.
.UNINDENT
.INDENT 0.0
.TP
.B agencyIDs
Type: \fIlist:string\fP
.sp
List of agency IDs to consider picks and origins. The agency ID
is extracted from the pick or the preferred origin of the event
and compared with the configured IDs.
.sp
unset (=): use agencyID defined in global, default
.sp
empty list (=\(dq\(dq): all agencies are allowed
.UNINDENT
.INDENT 0.0
.TP
.B authors
Type: \fIlist:string\fP
.sp
List of authors to consider picks and origins. The author
is extracted from the pick or the preferred origin of the event
and compared with the configured authors.
empty list (=\(dq\(dq): all authors are allowed
.UNINDENT
.INDENT 0.0
.TP
.B poi.message
Type: \fIstring\fP
.sp
The default message string for the event\-script is
\(dqearthquake, [HOURS] hours [MINS] minutes ago, [DESC],
magnitude [MAG], depth [DEP] kilometers\(dq whereas [DESC]
is the string given in the event.description attribute. This
string can be overwritten using one of the following options.
There are three placeholders that can be used: @region@,
@dist@ and @poi@.
Example: \(dq@region@, @dist@ kilometers from @poi@
away\(dq.
.UNINDENT
.INDENT 0.0
.TP
.B poi.maxDist
Default: \fB20\fP
.sp
Type: \fIdouble\fP
.sp
Unit: \fIdeg\fP
.sp
When using the nearest point of interest (city) as part of
the message string, specify the maximum distance in degrees
from the event. Any point of interest farther away will be
ignored.
.UNINDENT
.INDENT 0.0
.TP
.B poi.minPopulation
Default: \fB50000\fP
.sp
Type: \fIdouble\fP
.sp
Minimum population for a city to become a point of interest.
.UNINDENT
.INDENT 0.0
.TP
.B scripts.pick
Type: \fIstring\fP
.sp
The script to be called when a pick
arrives. Network\-, station code, pick publicID are passed
as parameters $1, $2, $3.
.UNINDENT
.INDENT 0.0
.TP
.B scripts.amplitude
Type: \fIstring\fP
.sp
The script to be called when an amplitude
arrives. Network\-, station code, amplitude and amplitude
public ID are passed as parameters $1, $2, $3, $4.
.UNINDENT
.INDENT 0.0
.TP
.B scripts.alert
Type: \fIstring\fP
.sp
The script to be called when a preliminary
origin arrives. Latitude and longitude are passed as
parameters $1 and $2.
.UNINDENT
.INDENT 0.0
.TP
.B scripts.event
Type: \fIstring\fP
.sp
The script to be called when an event has been
declared. The message string, a flag (1=new event,
0=update event), the EventID, the arrival count and the
magnitude (optional when set) are passed as parameters
$1, $2, $3, $4 and $5.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBconstraints.*\fP
\fIConstraints for executing scripts\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B constraints.phaseHints
Default: \fBP,S\fP
.sp
Type: \fIlist::string\fP
.sp
Start the pick script only when the phaseHint of the
received pick has one of the value(s).
.UNINDENT
.INDENT 0.0
.TP
.B constraints.phaseStreams
Type: \fIlist::string\fP
.sp
Start the pick script only when the stream (NET.STA.LOC.CHA)
of the received pick belongs to the list of stream IDs. If empty,
all picks are accepted, otherwise only the ones whose stream ID
matches one of the entry of this comma separated list. Each entry
must follow the NET.STA.LOC.CHA format, but the special
characters ? * | ( ) are also accepeted.
E.g. \(dqCH.*,GR.STA??.*,*.*.*.HH?,*.*.*.??(Z|1)\(dq
.UNINDENT
.INDENT 0.0
.TP
.B constraints.phaseNumber
Default: \fB1\fP
.sp
Type: \fIint\fP
.sp
Start the pick script only when a minimum number of phases
\(aqphaseNumber\(aq is received within \(aqphaseInterval\(aq.
.UNINDENT
.INDENT 0.0
.TP
.B constraints.phaseInterval
Default: \fB1\fP
.sp
Type: \fIint\fP
.sp
Unit: \fIs\fP
.sp
Start the pick script only when a minimum number of phases
\(aqphaseNumber\(aq is received within \(aqphaseInterval\(aq.
.UNINDENT
.SH COMMAND-LINE OPTIONS
.sp
\fBscalert [options]\fP
.SS Generic
.INDENT 0.0
.TP
.B \-h, \-\-help
Show help message.
.UNINDENT
.INDENT 0.0
.TP
.B \-V, \-\-version
Show version information.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-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. Example:
scautopick \-> scautopick2.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-plugins arg
Load given plugins.
.UNINDENT
.INDENT 0.0
.TP
.B \-D, \-\-daemon
Run as daemon. This means the application will fork itself
and doesn\(aqt need to be started with &.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-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).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-shutdown\-master\-module arg
Set 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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-shutdown\-master\-username arg
Set the name of the master\-username of the messaging
used for auto\-shutdown. If \(dqshutdown\-master\-module\(dq is
given as well, this parameter is ignored.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-first\-new
Overrides configuration parameter \fI\%firstNew\fP\&.
.UNINDENT
.SS Verbosity
.INDENT 0.0
.TP
.B \-\-verbosity arg
Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
4:debug.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-v
Increase verbosity level (may be repeated, eg. \-vv).
.UNINDENT
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Quiet mode: no logging output.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-component arg
Limit the logging to a certain component. This option can
be given more than once.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-syslog
Use syslog logging backend. The output usually goes to
/var/lib/messages.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-lockfile arg
Path to lock file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-console arg
Send log output to stdout.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-debug
Execute in debug mode.
Equivalent to \-\-verbosity=4 \-\-console=1 .
.UNINDENT
.INDENT 0.0
.TP
.B \-\-log\-file arg
Use alternative log file.
.UNINDENT
.SS Messaging
.INDENT 0.0
.TP
.B \-u, \-\-user arg
Overrides configuration parameter \fI\%connection.username\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-H, \-\-host arg
Overrides configuration parameter \fI\%connection.server\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-t, \-\-timeout arg
Overrides configuration parameter \fI\%connection.timeout\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-g, \-\-primary\-group arg
Overrides configuration parameter \fI\%connection.primaryGroup\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-S, \-\-subscribe\-group arg
A group to subscribe to.
This option can be given more than once.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-content\-type arg
Overrides configuration parameter \fI\%connection.contentType\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-start\-stop\-msg arg
Set sending of a start and a stop message.
.UNINDENT
.SS Database
.INDENT 0.0
.TP
.B \-\-db\-driver\-list
List all supported database drivers.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-database arg
The database connection string, format:
\fI\%service://user:pwd@host/database\fP\&.
\(dqservice\(dq is the name of the database driver which
can be queried with \(dq\-\-db\-driver\-list\(dq.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-config\-module arg
The config module to use.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-inventory\-db arg
Load the inventory from the given database or file, format:
[\fI\%service://]location\fP .
.UNINDENT
.INDENT 0.0
.TP
.B \-\-db\-disable
Do not use the database at all
.UNINDENT
.SS Alert
.INDENT 0.0
.TP
.B \-\-amp\-type arg
Specify the amplitude type to listen to.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-amp\-script arg
Overrides configuration parameter \fI\%scripts.amplitude\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-alert\-script arg
Overrides configuration parameter \fI\%scripts.alert\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-event\-script arg
Overrides configuration parameter \fI\%scripts.event\fP\&.
.UNINDENT
.SS Cities
.INDENT 0.0
.TP
.B \-\-max\-dist arg
Overrides configuration parameter \fI\%poi.maxDist\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-min\-population arg
Overrides configuration parameter \fI\%poi.minPopulation\fP\&.
.UNINDENT
.SS Debug
.INDENT 0.0
.TP
.B \-E, \-\-eventid arg
Specify event ID that is used for testing. After running the
alert scripts scvoice will exit.
.UNINDENT
.SH AUTHOR
gempa GmbH, GFZ Potsdam
.SH COPYRIGHT
gempa GmbH, GFZ Potsdam
.\" Generated by docutils manpage writer.
.