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

534
share/man/man1/scdispatch.1 Normal file
View File

@ -0,0 +1,534 @@
.\" 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 "SCDISPATCH" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
.SH NAME
scdispatch \- SeisComP Documentation
.sp
\fBRead objects (event, origin, etc) from a SCML file and sends the objects
to the messaging system.\fP
.SH DESCRIPTION
.sp
scdispatch reads an \fI\%SCML\fP file and creates notifier objects for them that
are sent to the \fI\%messaging\fP and the corresponding
messaging groups (see \fB\-\-routingtable\fP). In contrast to \fI\%scdb\fP
which writes SCML files directly into the \fI\%database\fP
scdispatch uses the messaging bus. If \fI\%scmaster\fP is configured with the
database plugin, messages will end up in the database as well.
.SS Modes
.sp
scdispatch can work in two modes applying different
\fI\%operations\fP:
.INDENT 0.0
.IP \(bu 2
\fIWithout database check:\fP One of the \fI\%operations\fP
\fIadd\fP, \fIupdate\fP or \fIremove\fP is selected along with the option \fB\-O\fP\&. In
that case all objects in the \fI\%SCML\fP are encapsulated in a notifier with
that specific operation and sent to the messaging. No check is performed if
the object is already in the database or not.
.IP \(bu 2
\fIWith database check:\fP The option \fB\-O\fP is not given or the
option is used along with one of the \fI\%operations\fP
\fImerge\fP or \fImerge\-without\-remove\fP\&. scdispatch first tries to load the corresponding
objects from the database and calculates differences. It will then create the
corresponding notifiers with operations \fIadd\fP, \fIupdate\fP or \fIremove\fP and sends
them to the messaging. That mode is quite close to a sync operation with the
exception that top level objects (such as origin or event) that are not part
of the input SCML are left untouched in the database. It can be used to
synchronize event information from one system with another.
.UNINDENT
.SS Operations
.sp
Different operations can be chosen along with the option \fB\-O\fP\&.
If \fB\-O\fP is not given, \fImerge\fP is assumed by default.
.INDENT 0.0
.IP \(bu 2
\fIAdd\fP: All objects are sent trying to be added to the database. If they
already exist in the database, they will be rejected and not spread through
the messaging. Modules connected to the messaging will not receive rejected
objects.
.IP \(bu 2
\fIRemove\fP: All sent objects with all their attributes and child objects are
removed from the database. Modules connected to the messaging will not receive
any sent object.
.IP \(bu 2
\fIUpdate\fP: All objects are sent trying to be updated to the database along with
all of their child objects and attributes. Sent objects not existing in the
database will be ignored and not received by any module connected to the
messaging. Child objects and attributes existing in the database but not
included in the sent object will be removed as well.
.IP \(bu 2
\fIMerge\fP (default): Applies \fIAdd\fP and \fIUpdate\fP and requires a database
connection.
.IP \(bu 2
\fIMerge\-without\-remove\fP: Applies \fIAdd\fP and \fIUpdate\fP and requires a database
connection. However, no objects are removed from the database.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
All \fISeisComP\fP objects along are listed and described along with their child
objects and attributes in the \fI\%API documentation\fP\&.
.UNINDENT
.UNINDENT
.SS Examples
.INDENT 0.0
.IP 1. 3
Send different objects from a \fI\%SCML\fP file for merging (adding or
updating). The option \fB\-O\fP can be ommitted because the default
behavior is to merge:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O merge
scdispatch \-i test.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Send all objects by ignoring events. When \fI\%scevent\fP receives origins it
will create new events or associate the origins to existing ones. The ignored
events may be already existing with different IDs. Hence, event duplication
is avoided by ignoring them.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-e
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Send new objects to be added:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O add
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Send an update of objects:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O update
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 5. 3
Send objects to be removed:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O remove
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 6. 3
Compare new objects with the database content and send the difference (optionally without removing objects):
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O merge
scdispatch \-i test.xml \-O merge\-without\-remove
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 7. 3
Offline mode: all operations can be performed without the messaging system using xml files:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O operation \-\-create\-notifier > notifier.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
then:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdb \-i notifier.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 8. 3
Subsets of SCML Objects
.sp
It can be useful to import a subset of QuakeML objects, e.g. Origins from other
agencies and then allow \fI\%scevent\fP to associate them to existing
events (and possibly prefer them based on the rules in scevent) or create new
events for the origins. If the event objects from a SCML file are not required
to be sent to the messaging then either they should be removed (e.g. using XSLT)
and all the remaining objects in the file added:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O add
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or the \fBevent objects\fP can be left out of the routing table, e.g.
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scdispatch \-i test.xml \-O add \e
\-\-routingtable Pick:PICK, \e
Amplitude:AMPLITUDE, \e
Origin:LOCATION,StationMagnitude:MAGNITUDE, \e
Magnitude:MAGNITUDE
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBHINT:\fP
.INDENT 3.0
.INDENT 3.5
The option \fB\-\-no\-event\fP is a wrapper for removing Event:EVENT from
the routing table. With this option no event objects will be sent which may
be useful if just the origins with magnitudes, amplitudes, arrivals, picks, etc.
shall be integrated, e.g. after XML\-based playbacks.
.UNINDENT
.UNINDENT
.IP 9. 3
Testing
.sp
For testing it is useful to watch the results of dispatch with \fI\%scolv\fP or
\fI\%scxmldump\fP\&. It is also useful to clean the database and logs to remove
objects from persistent storage to allow repeated reloading of a file.
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
The following will clear all events from the database and any other
other object persistence. Modify the mysql command to suit your db setup.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mysql \-u root \-\-password=\(aqmy$q1\(aq \-e \(dqDROP DATABASE IF EXISTS seiscomp; \e
CREATE DATABASE seiscomp CHARACTER SET utf8 COLLATE utf8_bin; \e
GRANT ALL ON seiscomp.* TO \(aqsysop\(aq@\(aqlocalhost\(aq IDENTIFIED BY \(aqsysop\(aq; \e
USE seiscomp;source seiscomp/trunk/share/db/mysql.sql;\(dq
seiscomp start
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH MODULE CONFIGURATION
.nf
\fBetc/defaults/global.cfg\fP
\fBetc/defaults/scdispatch.cfg\fP
\fBetc/global.cfg\fP
\fBetc/scdispatch.cfg\fP
\fB~/.seiscomp/global.cfg\fP
\fB~/.seiscomp/scdispatch.cfg\fP
.fi
.sp
.sp
scdispatch inherits \fI\%global options\fP\&.
.SH COMMAND-LINE OPTIONS
.sp
\fBscdispatch [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
.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 Dispatch
.INDENT 0.0
.TP
.B \-e, \-\-no\-events
Do not send any event object which are ignored when reading
event parameters.
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-input arg
File from which the content is dispatched to the messaging.
.UNINDENT
.INDENT 0.0
.TP
.B \-O, \-\-operation arg
Merge and merge\-without\-remove require a database
connection. Both will read the object corresponding to the
sent object from the database and calculate the differences.
Merge\-without\-remove behaves like merge with the exception
that remove operations will be filtered out and no objects
in the database will be removed.
.sp
If add, update or remove is specified, then all objects in
XML are sent with the given operation regardless of their
existence in the database.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-print\-objects
Print names of routable objects.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-print\-routingtable
Print routing table.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-routingtable arg
Specify routing table as comma separated list of object:group
pairs, e.g. \(dqOrigin:LOCATION,Event:EVENT\(dq. When an
object should be routed to a group and no table entry for
that particular class type is available, all parent objects
are checked for valid routing entries and the first found is
used. E.g. if only \(dqOrigin:LOCATION\(dq is specified
but the input file contains also Arrivals which are child
objects of Origin then the routing entry of Origin is used
because of the parent\-child relationship between Origin and
Arrival.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-test
Test mode. Does not send any object.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-create\-notifier
Do not send any object. All notifiers will be written to
standard output in XML format.
.UNINDENT
.SH AUTHOR
gempa GmbH, GFZ Potsdam
.SH COPYRIGHT
gempa GmbH, GFZ Potsdam
.\" Generated by docutils manpage writer.
.