You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
357 lines
8.9 KiB
Groff
357 lines
8.9 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "SCART" "1" "Jan 10, 2023" "5.3.0" "SeisComP"
|
|
.SH NAME
|
|
scart \- SeisComP Documentation
|
|
.
|
|
.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
|
|
..
|
|
.sp
|
|
\fBImport/export MiniSEED data to/from SDS archives.\fP
|
|
.SH DESCRIPTION
|
|
.sp
|
|
The archive tool scart reads and writes SDS archives and files
|
|
in miniSEED format and checks miniSEED archives or prints stream information.
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBDump mode:\fP Create miniSEED files (multiplexed), e.g. for playbacks, from
|
|
SDS structured data (e.g. created by slarchive) or from data passed
|
|
from another record source such as Arclink\&.
|
|
.IP \(bu 2
|
|
\fBDump mode:\fP Play back records directly out of an SDS structure.
|
|
.IP \(bu 2
|
|
\fBImport mode:\fP Import multiplexed miniSEED files into a local SDS waveform
|
|
archive.
|
|
.IP \(bu 2
|
|
\fBCheck mode:\fP Check an archive of miniSEED files for out\-of\-order records in
|
|
files.
|
|
.UNINDENT
|
|
.sp
|
|
\fBWARNING:\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
When creating SDS archives, scart simply appends the new records to
|
|
existing ones. Multiple imports of the same data result in duplication.
|
|
.IP \(bu 2
|
|
Out\-of\-order imports of waveforms into a SDS archive result in out\-of\-order
|
|
records which may not be processed. Clean your archive using scmssort\&.
|
|
.IP \(bu 2
|
|
The new input data for an SDS archive must be sorted by time. Otherwise,
|
|
the SDS archive may not be correctly readable. Combine scart with
|
|
scmssort for multiplexing and removal of duplicates.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fBHINT:\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
In dump mode output streams may be controlled by
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
Time window \- stream lists (\fB\-\-list\fP, dump mode) generated by
|
|
scevtstreams for particular events
|
|
.IP \(bu 2
|
|
NSLC lists (\fB\-\-nslc\fP) created, e.g., with scinv from
|
|
inventories.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH CONFIGURATION
|
|
.sp
|
|
scart can make use of global_recordstream
|
|
implementations which are provided by additional plugins.
|
|
For loading additional plugins, e.g. the \fIxyz\fP plugin create and configure \fBscart.cfg\fP:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
plugins = xyz
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.IP 1. 3
|
|
Extract data from the default SDS archive in \fB$SEISCOMP_ROOT/var/lib/archive\fP
|
|
or from a local SDS archive [SDS archive] into a miniSEED file \fBfile.mseed\fP
|
|
and sort by end time of the records:
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq > file.mseed
|
|
scart \-dsvE \-t \(aq[start\-time]~[end\-time]\(aq [SDS archive] > [file.mseed]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fBNOTE:\fP
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
Sorting data is computational expensive but required for waveform playbacks.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.IP 2. 3
|
|
Push miniSEED data from file \fBfile.mseed\fP into a local SDS
|
|
archive. Additionally, you may check if the records of the created files are
|
|
correctly ordered:
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
scart \-I [file.mseed] [SDS archive]
|
|
scart \-I [file.mseed] \-\-with\-filecheck [SDS archive]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.IP 3. 3
|
|
Collect data from an FDSNWS server using the global_recordstream
|
|
interface and write to a miniSEED file. The data streams and the time spans are
|
|
defined in a list file using the option \fBlist\fP\&. The list can be generated e.g.
|
|
by scevtstreams\&.
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
scart \-I fdsnws://[server]:80 \-\-list list.file \-\-stdout > file.mseed
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.IP 4. 3
|
|
Check all files of an SDS archive or other directory structure for
|
|
miniSEED files with out\-of\-order records:
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
scart \-\-check [archive]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.IP 5. 3
|
|
Print stream information from miniSEED files in archives or from
|
|
RecordStream without actually writing miniSEED data:
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
scart \-I [miniSEED file] \-\-print\-streams
|
|
scart \-d \-t [time span] [SDS archive] \-\-print\-streams
|
|
scart \-\-check [archive] \-\-print\-streams
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
The output looks like this:
|
|
.INDENT 3.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
# streamID start end records samples samplingRate
|
|
GE.RGN..BHZ 2022\-12\-08T15:34:41.895Z 2022\-12\-08T15:52:19.145Z 58 21145 20.0
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
where the header and the text body are printed to stdout.
|
|
.UNINDENT
|
|
.SH COMMAND-LINE OPTIONS
|
|
.sp
|
|
\fBscart [options] {archive\-dir}\fP
|
|
.sp
|
|
The last option has to be the archive directory when dump mode is enabled.
|
|
When no archive directory is explicitly given,
|
|
$SEISCOMP_ROOT/var/lib/archive or the current directory
|
|
is used depending on whether $SEISCOMP_ROOT has been set or not.
|
|
The default operation mode is import. That means that a multiplexed
|
|
MiniSEED file or another record source such as ArcLink is used to import
|
|
records into a SDS structure.
|
|
.SS Verbosity
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-v, \-\-verbose
|
|
Verbose mode.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Display a help message.
|
|
.UNINDENT
|
|
.SS Mode
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-check
|
|
Check mode. Check all files
|
|
in the given directory for erroneous miniSEED records.
|
|
All sub\-directories are included.
|
|
If no directory is given, the default SDS archive is scanned.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-d, \-\-dump
|
|
Set export (dump) mode. Records are retrieved from an archive and
|
|
written to standard output.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-I
|
|
Import mode: Specify the recordstream URL when in import mode.
|
|
When using another recordstream than a file (like ArcLink) a stream
|
|
list file is required. Default: \fI\%file://\fP\- (stdin).
|
|
.UNINDENT
|
|
.SS Output
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-c channels
|
|
Specify the channel filter for the dumped streams as regular
|
|
expression. Default: (B|S|M|H)(L|H)(Z|N|E). To dump only
|
|
BHZ, BHN and BHE streams use BH(Z|N|E).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-E
|
|
Sort records according to their end time. Default: start time.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-files count
|
|
Specify the number of file handles to cache. Default: 100.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-l, \-\-list file
|
|
Uses a stream list file instead of defined networks and channels
|
|
(\-n and \-c are ignored). The list can be generated from events
|
|
by scevetstreams. One line per stream.
|
|
Line format: starttime;endtime;streamID.
|
|
The time format is the same as described in option \(aq\-t\(aq.
|
|
.sp
|
|
Example:
|
|
.sp
|
|
2019\-07\-17 02:00:00;2019\-07\-17 02:10:00;GR.CLL..BH?
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-nslc file
|
|
Uses a stream list file instead of defined networks and
|
|
channels (\-n and \-c are ignored). In dump mode only. The
|
|
time window must be provided separately. Wild cards may be
|
|
used. The list can be generated from bindings by scdumpcfg
|
|
or from inventory by scinv. Use one line per stream. Line
|
|
format: NET.STA.LOC.CHA.
|
|
.sp
|
|
Example:
|
|
.sp
|
|
GR.CLL..BH?
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-m, \-\-modify
|
|
Modify the record time for real time playback when in export mode.
|
|
The first record time is NOW. The relative time of successive records
|
|
to the first one are kept.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-n networks
|
|
List of network codes to dump (comma separated). Default: *.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-s, \-\-sort
|
|
Sort records by [start\-]time. To sort records by their endtime use \-E.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-speed
|
|
Specify the speed to dump the records. A value of 0 means no delay
|
|
otherwise speed is a multiplier of the real time difference between
|
|
the records. When feeding the records directly into the replay pipe
|
|
a value of 1 (real time) is recommended.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-stdout
|
|
Write to stdout if import mode is used instead of creating a
|
|
SDS archive.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-print\-streams
|
|
Print stream information only and exit. Works in import, dump
|
|
and check mode. Output: NET.STA.LOC.CHA StartTime EndTime.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-test
|
|
Test only, no record output. This switch is useful
|
|
for debugging.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-t timeWindow
|
|
Specify the time window (as one properly quoted string) to dump
|
|
records for. Times are UTC and separated by a tilde "~".
|
|
To dump one hour of waveform data between 2008/01/01 00:00:00 and
|
|
2008/01/01 01:00:00 use
|
|
<\-t "2008\-01\-01 00:00:00~2008\-01\-01 01:00:00">.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-with\-filecheck
|
|
Check all accessed files after import. Unsorted or
|
|
unreadable files are reported to stderr.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-with\-filename
|
|
Print all accessed files to stdout after import.
|
|
.UNINDENT
|
|
.SH AUTHOR
|
|
gempa GmbH, GFZ Potsdam
|
|
.SH COPYRIGHT
|
|
gempa GmbH, GFZ Potsdam
|
|
.\" Generated by docutils manpage writer.
|
|
.
|