258 lines
		
	
	
		
			6.7 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
			
		
		
	
	
			258 lines
		
	
	
		
			6.7 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
.\" 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 "MSRTSIMUL" "1" "Oct 14, 2025" "6.9.1" "SeisComP"
 | 
						|
.SH NAME
 | 
						|
msrtsimul \- SeisComP Documentation
 | 
						|
.sp
 | 
						|
\fBMiniSEED real time playback and simulation\fP
 | 
						|
.SH DESCRIPTION
 | 
						|
.sp
 | 
						|
msrtsimul simulates a real\-time data acquisition by injecting miniSEED data from a
 | 
						|
file into the seedlink buffer via the mseedfifo plugin for seedlink. It can be
 | 
						|
used for simulating real\-time conditions in playbacks for whole\-system
 | 
						|
demonstrations, user training, etc.
 | 
						|
.sp
 | 
						|
The data is played back as if they were recorded at current time. Therefore,
 | 
						|
creation times and the actual data times including pick times, event times etc.
 | 
						|
will be \fBobscured\fP\&. \fI\%Historic playbacks\fP allow
 | 
						|
keeping the actual data times.
 | 
						|
.sp
 | 
						|
\fBHINT:\fP
 | 
						|
.INDENT 0.0
 | 
						|
.INDENT 3.5
 | 
						|
.INDENT 0.0
 | 
						|
.IP \(bu 2
 | 
						|
Playbacks on production systems are normally not recommended.
 | 
						|
.IP \(bu 2
 | 
						|
For real\-time playbacks, the data must be sorted by end time. This
 | 
						|
requirement may be violated. Use \fI\%scmssort\fP for sorting the data by
 | 
						|
(end) time.
 | 
						|
.IP \(bu 2
 | 
						|
Stop \fI\%slarchive\fP before running msrtsimul for avoiding that data with
 | 
						|
wrong times are archived.
 | 
						|
.IP \(bu 2
 | 
						|
Normally, \fI\%seedlink\fP assumes that the data is provided in records of
 | 
						|
512 bytes. msrtsimul issues a warning when detecting a record of other size.
 | 
						|
.IP \(bu 2
 | 
						|
Data available in other record sizes can be repacked to 512 bytes by
 | 
						|
external software such as \fBmsrepack\fP available with
 | 
						|
\fIlibmseed \- The miniSEED data format library\fP [\fI\%32\fP]\&.
 | 
						|
.IP \(bu 2
 | 
						|
Applications other than standard \fI\%seedlink\fP in \fISeisComP\fP or
 | 
						|
\fI\%seedlink\fP compiled specifically may accept other record sizes. For
 | 
						|
accepting these records use msrtsimul with \fB\-\-unlimited\fP\&.
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.SS Non\-default seedlink pipes
 | 
						|
.sp
 | 
						|
By default, msrtsimul writes the data into the mseedfifo pipe
 | 
						|
\fI$SEISCOMP_ROOT/var/run/seedlink/mseedfifo\fP\&.
 | 
						|
If the data is to be written into the pipe of a \fBseedlink\fP alias or
 | 
						|
into any other pipe, the pipe name must be adjusted. Use the option
 | 
						|
.INDENT 0.0
 | 
						|
.IP \(bu 2
 | 
						|
\fB\-\-seedlink\fP to replace \fIseedlink\fP by another name, e.g. a seedlink instance
 | 
						|
created as an alias, \fBseedlink\-test\fP\&. This would write into
 | 
						|
\fI$SEISCOMP_ROOT/var/run/seedlink\-test/mseedfifo\fP\&.
 | 
						|
.IP \(bu 2
 | 
						|
\fB\-\-stdout\fP to write to standard output and then redirect to any other location.
 | 
						|
.UNINDENT
 | 
						|
.SS Historic playbacks
 | 
						|
.sp
 | 
						|
You may use msrtsimul with the \fB\-m\fP \fIhistoric\fP option to maintain the
 | 
						|
time of the records,
 | 
						|
thus the times of picks, amplitudes, origins, etc. but not the creation times.
 | 
						|
Applying \fB\-m\fP \fIhistoric\fP will feed the data into the seedlink buffer at the time
 | 
						|
of the records. The time of the system is untouched. GUI, processing modules, logging,
 | 
						|
etc. will run with current system time. The historic mode allows to process waveforms
 | 
						|
with the stream inventory valid at the time when the data were recorded including
 | 
						|
streams closed at current time.
 | 
						|
.sp
 | 
						|
\fBWARNING:\fP
 | 
						|
.INDENT 0.0
 | 
						|
.INDENT 3.5
 | 
						|
When repeating historic playbacks, the waveforms are fed multiple times to the
 | 
						|
seedlink buffer and the resulting picks are also repeated with the same pick
 | 
						|
times. This may confuse the real\-time system. Therefore, seedlink and other modules
 | 
						|
creating or processing picks should be
 | 
						|
stopped, the seedlink buffer should be cleared and the processing
 | 
						|
modules should be restarted to clear the buffers before starting the
 | 
						|
historic playbacks. Make sure \fI\%scautopick\fP is configured or started with
 | 
						|
the \fB\-\-playback\fP option. Example:
 | 
						|
.INDENT 0.0
 | 
						|
.INDENT 3.5
 | 
						|
.sp
 | 
						|
.nf
 | 
						|
.ft C
 | 
						|
seiscomp stop
 | 
						|
rm \-rf $SEISCOMP_ROOT/var/lib/seedlink/buffer
 | 
						|
seiscomp start
 | 
						|
msrtsimul ...
 | 
						|
.ft P
 | 
						|
.fi
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.SS seedlink setup
 | 
						|
.sp
 | 
						|
For supporting msrtsimul activate the \fI\%msrtsimul\fP parameter in the
 | 
						|
seedlink module configuration (\fBseedlink.cfg\fP), update the configuration
 | 
						|
and restart seedlink before running msrtsimul:
 | 
						|
.INDENT 0.0
 | 
						|
.INDENT 3.5
 | 
						|
.sp
 | 
						|
.nf
 | 
						|
.ft C
 | 
						|
seiscomp update\-config seedlink
 | 
						|
seiscomp restart seedlink
 | 
						|
msrtsimul ...
 | 
						|
.ft P
 | 
						|
.fi
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.SS Examples
 | 
						|
.INDENT 0.0
 | 
						|
.IP 1. 3
 | 
						|
Playback miniSEED waveforms in real time with verbose output:
 | 
						|
.INDENT 3.0
 | 
						|
.INDENT 3.5
 | 
						|
.sp
 | 
						|
.nf
 | 
						|
.ft C
 | 
						|
$ msrtsimul \-v miniSEED\-file
 | 
						|
.ft P
 | 
						|
.fi
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.IP 2. 3
 | 
						|
Playback miniSEED waveforms in historic mode. This may require \fI\%scautopick\fP
 | 
						|
to be started with the option \fIplayback\fP:
 | 
						|
.INDENT 3.0
 | 
						|
.INDENT 3.5
 | 
						|
.sp
 | 
						|
.nf
 | 
						|
.ft C
 | 
						|
msrtsimul \-v \-m historic miniSEED\-file
 | 
						|
.ft P
 | 
						|
.fi
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.IP 3. 3
 | 
						|
Feed the data into the buffer of a specific seedlink instance, e.g. \fIseedlink\-test\fP:
 | 
						|
.INDENT 3.0
 | 
						|
.INDENT 3.5
 | 
						|
.sp
 | 
						|
.nf
 | 
						|
.ft C
 | 
						|
msrtsimul \-v \-\-seedlink seedlink\-test miniSEED\-file
 | 
						|
.ft P
 | 
						|
.fi
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.UNINDENT
 | 
						|
.SH MODULE CONFIGURATION
 | 
						|
.nf
 | 
						|
\fBetc/defaults/global.cfg\fP
 | 
						|
\fBetc/defaults/msrtsimul.cfg\fP
 | 
						|
\fBetc/global.cfg\fP
 | 
						|
\fBetc/msrtsimul.cfg\fP
 | 
						|
\fB~/.seiscomp/global.cfg\fP
 | 
						|
\fB~/.seiscomp/msrtsimul.cfg\fP
 | 
						|
.fi
 | 
						|
.sp
 | 
						|
.sp
 | 
						|
msrtsimul inherits \fI\%global options\fP\&.
 | 
						|
.SH COMMAND-LINE OPTIONS
 | 
						|
.sp
 | 
						|
\fBmsrtsimul [OPTION] miniSEED\-file\fP
 | 
						|
.SS Verbosity
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-h, \-\-help
 | 
						|
Display this help message.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-v, \-\-verbose
 | 
						|
Verbose mode.
 | 
						|
.UNINDENT
 | 
						|
.SS Playback
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-c, \-\-stdout
 | 
						|
Write on standard output. The output my be redirected to a
 | 
						|
specific mseedfifo path.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-d, \-\-delays
 | 
						|
Add artificial delays.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-j, \-\-jump float
 | 
						|
Minutes to skip at the beginning.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-m, \-\-mode string
 | 
						|
Playback mode: choose between \(aqrealtime\(aq and \(aqhistoric\(aq
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-\-seedlink string
 | 
						|
The seedlink module name. Useful if a seedlink alias or
 | 
						|
non\-standard names are used. Replaces \(aqseedlink\(aq
 | 
						|
in the standard mseedfifo path.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-s, \-\-speed float
 | 
						|
Speed factor. 1 is normal speed.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-\-test
 | 
						|
Test mode.
 | 
						|
.UNINDENT
 | 
						|
.INDENT 0.0
 | 
						|
.TP
 | 
						|
.B \-u, \-\-unlimited
 | 
						|
Allow miniSEED records which are not 512 bytes.
 | 
						|
.UNINDENT
 | 
						|
.SH AUTHOR
 | 
						|
gempa GmbH, GFZ Potsdam
 | 
						|
.SH COPYRIGHT
 | 
						|
gempa GmbH, GFZ Potsdam
 | 
						|
.\" Generated by docutils manpage writer.
 | 
						|
.
 |