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

418
share/man/man1/scbulletin.1 Normal file
View File

@ -0,0 +1,418 @@
.\" 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 "SCBULLETIN" "1" "Sep 22, 2025" "6.9.0" "SeisComP"
.SH NAME
scbulletin \- SeisComP Documentation
.sp
\fBCreate bulletins from SCML.\fP
.SH DESCRIPTION
.sp
scbulletin transforms the parameters of events or origins either to various formats.
Currently supported output formats are:
.INDENT 0.0
.IP \(bu 2
autoloc1,
.IP \(bu 2
autoloc3,
.IP \(bu 2
fdsnws,
.IP \(bu 2
kml.
.UNINDENT
.SH INPUT MODES
.sp
Two modes of parameter input are possible:
.INDENT 0.0
.IP 1. 3
Dump mode: Fetch all necessary information from database directly. Either
choose one or more event or origin IDs. The database connection must be given
with \fB\-o\fP\&.
.IP 2. 3
Input mode: Provide all event and origin information in XML (\fI\%SCML\fP)
format from file or stdin. You may filter further by event or origin ID.
.UNINDENT
.sp
If event IDs are given, the preferred origin will be derived and used for printing
information.
.sp
\fBHINT:\fP
.INDENT 0.0
.INDENT 3.5
Events and origins are referred to by their public IDs. They can be provided
by \fI\%scevtls\fP and \fI\%scorgls\fP, respectively, from graphical tools like
\fI\%scolv\fP or by database queries supported by \fI\%scquery\fP\&. XML files
can be generated by \fI\%scxmldump\fP or from other formats by \fI\%sccnv\fP\&.
.UNINDENT
.UNINDENT
.SH OUTPUT MODES
.sp
The generated content is written to stdout or, with option \fB\-o\fP to a
file. Different output formats are available by command\-line options:
.INDENT 0.0
.IP \(bu 2
\fB\-1\fP for \fBautoloc1\fP: Print one bulletin per event.
.IP \(bu 2
\fB\-3\fP for \fBautoloc3\fP: Print one bulletin per event.
.IP \(bu 2
\fB\-3 \-x\fP for \fBextended autoloc3\fP\&.
.IP \(bu 2
\fB\-4\fP or \fB\-\-fdsnws\fP for FDSNWS event text: Print one line per event. Useful
for generating event catalogs. This option offers an alternative to generating
event catalogs by \fI\%fdsnws\-event\fP\&.
.IP \(bu 2
\fB\-5\fP or \fB\-\-kml\fP for KML/GIS file format. The output can be viewed, e.g.,
in \fIGoogle Earth\fP\&.
.UNINDENT
.sp
By default, the output precision of times or coordinates is optimized for events
at teleseismic or regional distances. Use the option \fB\-e\fP for
\fBenhanced\fP output at higher precision: All times and distances are in units
of milliseconds and meters, respectively.
.SH EXAMPLES
.INDENT 0.0
.IP 1. 3
Create a bulletin from one or multiple event(s) in database
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scbulletin \-d mysql://sysop:sysop@localhost/seiscomp \-E gfz2012abcd
scbulletin \-d mysql://sysop:sysop@localhost/seiscomp \-E gfz2012abcd,gfz2022abcd
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Convert XML file to bulletin
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scbulletin \-i gfz2012abcd.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
cat gfz2012abcd.xml | scbulletin
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scbulletin < gfz2012abcd.xml
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Convert XML file to bulletin but filter by event ID(s)
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
scbulletin \-i gfz2012abcd.xml \-E gempa2022abcd
scbulletin \-i gfz2012abcd.xml \-E gempa2022abcd,gfz2022abcd
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When considering a single event XML file containing many events, the
bulletins of all events will be generated unless \fB\-\-first\-only\fP is used.
.UNINDENT
.UNINDENT
.SH MODULE CONFIGURATION
.nf
\fBetc/defaults/global.cfg\fP
\fBetc/defaults/scbulletin.cfg\fP
\fBetc/global.cfg\fP
\fBetc/scbulletin.cfg\fP
\fB~/.seiscomp/global.cfg\fP
\fB~/.seiscomp/scbulletin.cfg\fP
.fi
.sp
.sp
scbulletin inherits \fI\%global options\fP\&.
.SH COMMAND-LINE OPTIONS
.sp
\fBscbulletin [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 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 Input
.INDENT 0.0
.TP
.B \-f, \-\-format arg
Input format to use (xml [default], zxml (zipped xml), binary).
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-input arg
The input file. Default is stdin.
.UNINDENT
.SS Dump
.INDENT 0.0
.TP
.B \-E, \-\-event arg
ID of event(s) that is read from database and transformed into
a bulletin. Separate multiple IDs by comma.\(dq
.UNINDENT
.INDENT 0.0
.TP
.B \-O, \-\-origin arg
ID of origin(s) that is read from database and transformed into
a bulletin. Separate multiple IDs by comma.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-event\-agency\-id
Use the agency ID of the event instead of the preferred origin.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-first\-only
Convert only the first event/origin to bulletin. Otherwise
all events or origins will be converted to single bulletins
which will be concatenated.
.UNINDENT
.INDENT 0.0
.TP
.B \-p, \-\-polarities
Dump onset polarities.
.UNINDENT
.INDENT 0.0
.TP
.B \-w, \-\-weight arg
Weight threshold for printed and counted picks.
.UNINDENT
.INDENT 0.0
.TP
.B \-x, \-\-extra
Use a specially detailed autoloc3 format. This options works only
in combination with the autoloc3\-flag.
.UNINDENT
.SS Output
.INDENT 0.0
.TP
.B \-1, \-\-autoloc1
Format: Use autoloc1 format for output. This is default.
.UNINDENT
.INDENT 0.0
.TP
.B \-3, \-\-autoloc3
Format: Use autoloc3 format for output.
.UNINDENT
.INDENT 0.0
.TP
.B \-4, \-\-fdsnws
Format: FDSNWS event text, e.g., for generating catalogs.
.UNINDENT
.INDENT 0.0
.TP
.B \-5, \-\-kml
Format: KML. GIS file format.
.UNINDENT
.INDENT 0.0
.TP
.B \-e, \-\-enhanced
Enhanced output with higher precision. Times: milliseconds,
distances: meter. Use for bulletins of local earthquakes.
.UNINDENT
.INDENT 0.0
.TP
.B \-k, \-\-dist\-in\-km
Print distances in km instead of degree.
.UNINDENT
.INDENT 0.0
.TP
.B \-o, \-\-output
Name of output file. If not given, all event parameters are
printed to stdout.
.UNINDENT
.INDENT 0.0
.TP
.B \-x, \-\-extra
Use a specially detailed autoloc3 format. This options works
only in combination with the autoloc3\-flag.
.UNINDENT
.SH AUTHOR
gempa GmbH, GFZ Potsdam
.SH COPYRIGHT
gempa GmbH, GFZ Potsdam
.\" Generated by docutils manpage writer.
.