[seiscomp, scanloc] Install, add .gitignore

2025-10-09 15:07:02 +02:00
commit 20f5301bb1
2848 changed files with 1315858 additions and 0 deletions
--- a/share/man/man1/sh2proc.1
+++ b/share/man/man1/sh2proc.1
@ -0,0 +1,494 @@
+.\" 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 "SH2PROC" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
+.SH NAME
+sh2proc \- SeisComP Documentation
+.sp
+\fBConvert SeismicHandler event files to SCML.\fP
+.SH DESCRIPTION
+.sp
+sh2proc converts \fI\%Seismic Handler\fP event data to
+SeisComP XML format. Data is read from input file or \fIstdin\fP if no input file is
+specified.  The result is available on \fIstdout\fP\&.
+.SH CODE MAPPING
+.sp
+Since Seismic Handler only specifies station and component codes, a mapping to
+SeisComP network, location and channel codes is necessary. The script assumes
+that the same station code is not used in different networks. In case an
+ambiguous id is found a warning is printed and the first network code is used.
+The channel and stream code is extracted from the dectecStream and detecLocid
+configured in the global bindings. In case no configuration module is available
+the first location and stream is used.
+.SH EVENT PARAMETERS
+.INDENT 0.0
+.IP \(bu 2
+Event types given in Seismic Handler files are mapped to SeisComP event types:
+.TS
+center;
+|l|l|.
+_
+T{
+Seismic Handler
+T}	T{
+SeisComP
+T}
+_
+T{
+teleseismic quake
+T}	T{
+earthquake
+T}
+_
+T{
+regional quake
+T}	T{
+earthquake
+T}
+_
+T{
+local quake
+T}	T{
+earthquake
+T}
+_
+T{
+quarry blast
+T}	T{
+quarry blast
+T}
+_
+T{
+nuclear explosion
+T}	T{
+nuclear explosion
+T}
+_
+T{
+mining event
+T}	T{
+mining explosion
+T}
+_
+.TE
+.IP \(bu 2
+The EventID given in Seismic Handler files is mapped as a comment to the event.
+.UNINDENT
+.SH MAGNITUDES
+.INDENT 0.0
+.IP \(bu 2
+Magnitude types given in Seismic Handler files are mapped to SeisComP magnitudes:
+.TS
+center;
+|l|l|.
+_
+T{
+Seismic Handler
+T}	T{
+SeisComP
+T}
+_
+T{
+m
+T}	T{
+M
+T}
+_
+T{
+ml
+T}	T{
+ML
+T}
+_
+T{
+mb
+T}	T{
+mb
+T}
+_
+T{
+ms
+T}	T{
+Ms(BB)
+T}
+_
+T{
+mw
+T}	T{
+Mw
+T}
+_
+T{
+bb
+T}	T{
+mB
+T}
+_
+.TE
+.IP \(bu 2
+ML magnitudes in Seismic Handler files have no corresponding measured amplitudes.
+Therefore the ML station magnitudes are converted without referencing the amplitude.
+.IP \(bu 2
+Seismic Handler uses the phase name \(dqL\(dq for referring to surface waves without
+further specification. The phase name is kept unchanged.
+.UNINDENT
+.SH DISTANCE CALCULATIONS
+.sp
+In Seismic Handler files distances can be given in units of km or degree but in
+SeisComP only degree is used. Both representations are considered for conversion.
+In case of double posting preference is given to the Seismic Handler values given in km
+due to their higher precision.
+.SH BEAM PARAMETERS
+.sp
+Seismic Handler files provide the phase picks with theoretical, measured and corrected
+slowness and (back) azimuth but the pick in SeisComP knows only one value.
+During conversion highest preference is given to corrected values.
+The theoretical values are ignored.
+.SH LIMITATIONS
+.sp
+The following parameters from Seismic Handler files are not considered:
+.INDENT 0.0
+.IP \(bu 2
+Phase Flag
+.IP \(bu 2
+Location Input Params
+.IP \(bu 2
+Reference Location Name
+.IP \(bu 2
+Quality Number
+.IP \(bu 2
+Ampl&Period Source
+.IP \(bu 2
+Location Quality
+.IP \(bu 2
+Reference Latitude
+.IP \(bu 2
+Reference Longitude
+.IP \(bu 2
+Amplitude Time
+.UNINDENT
+.SH FURTHER PROCESSING IN SEISCOMP
+.sp
+The created XML files can be used in multiple ways, e.g.:
+.INDENT 0.0
+.IP 1. 3
+By other modules in an XML\-base playback
+.IP 2. 3
+Inject into the messaging system by \fI\%scdispatch\fP
+.IP 3. 3
+Integrate into the database by \fI\%scdb\fP
+.UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.IP 1. 3
+Convert the Seismic Handler file \fIshm.evt\fP and writes SCML into the file
+\fIsc.xml\fP\&. The database connection to read inventory and configuration
+information is fetched from the default messaging connection.
+.INDENT 3.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+sh2proc shm.evt > sc.xml
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.IP 2. 3
+Read Seismic Handler data from \fIstdin\fP\&. Inventory and configuration information
+is provided through files.
+.INDENT 3.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+cat shm.evt | sh2proc \-\-inventory\-db=inventory.xml \-\-config\-db=config.xml > sc.xml
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH SHM.EVT FILE FORMAT
+.sp
+The list of parameters supported by sh2proc may be incomplete.
+Read the original \fI\%format and parameter description\fP
+of the SeismicHandler .evt files for providing correct input files.
+.sp
+Example of a SeismicHandler \fIshm.evt\fP file with supported parameters:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+Event ID               : 1170102002
+Station code           : VITZ
+Onset time             : 2\-JAN\-2017_12:25:40.415
+Onset type             : emergent
+Phase name             : Pg
+Event Type             : mining event
+Applied filter         : SHM_BP_1HZ_25HZ_3
+Component              : Z
+Quality number         : 2
+Pick Type              : manual
+Weight                 : 4
+Theo. Azimuth (deg)    :   27.29
+Theo. Backazimuth (deg):  207.36
+Distance (deg)         :  0.122
+Distance (km)          : 13.572
+Magnitude ml           : 1.0
+Phase Flags            : L
+\-\-\- End of Phase \-\-\-
+
+
+Event ID               : 1170102002
+Station code           : WESF
+Onset time             : 2\-JAN\-2017_12:25:53.714
+Onset type             : emergent
+Phase name             : Pg
+Event Type             : mining event
+Applied filter         : SHM_BP_1HZ_25HZ_3
+Component              : Z
+Quality number         : 2
+Pick Type              : manual
+Weight                 : 4
+Theo. Azimuth (deg)    :  106.98
+Theo. Backazimuth (deg):  287.91
+Distance (deg)         :  0.807
+Distance (km)          : 89.708
+Magnitude ml           : 1.8
+Mean Magnitude ml      : 1.1
+Latitude               : +50.779
+Longitude              :  +10.003
+Depth (km)             :   0.0
+Depth type             : (g) estimated
+Origin time            :  2\-JAN\-2017_12:25:38.273
+Region Table           : GEO_REG
+Region ID              : 5326
+Source region          : Tann, E of Fulda
+Velocity Model         : deu
+Location Input Params  : 20
+Reference Location Name: CENTRE
+\-\-\- End of Phase \-\-\-
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH MODULE CONFIGURATION
+.nf
+\fBetc/defaults/global.cfg\fP
+\fBetc/defaults/sh2proc.cfg\fP
+\fBetc/global.cfg\fP
+\fBetc/sh2proc.cfg\fP
+\fB~/.seiscomp/global.cfg\fP
+\fB~/.seiscomp/sh2proc.cfg\fP
+.fi
+.sp
+.sp
+sh2proc inherits \fI\%global options\fP\&.
+.SH COMMAND-LINE OPTIONS
+.sp
+\fBsh2proc [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
+.SH AUTHOR
+gempa GmbH, GFZ Potsdam
+.SH COPYRIGHT
+gempa GmbH, GFZ Potsdam
+.\" Generated by docutils manpage writer.
+.