Command reference

squirrel jackseis

Convert waveform archive data.

squirrel jackseis

usage: squirrel jackseis [--help] [--loglevel LEVEL] [--progress DEST]
                         [--add PATH [PATH ...]] [--include REGEX]
                         [--exclude REGEX] [--optimistic] [--format FORMAT]
                         [--add-only KINDS] [--persistent NAME]
                         [--dataset FILE] [--config NAME] [--force]
                         [--kinds KINDS] [--codes CODES] [--tmin TIME]
                         [--tmax TIME] [--tinc SECONDS] [--downsample RATE]
                         [--out-path TEMPLATE] [--out-sds-path PATH]
                         [--out-format FORMAT] [--out-data-type DTYPE]
                         [--out-mseed-record-length INT]
                         [--out-mseed-steim INT] [--out-meta-path PATH]
                         [--traversal GROUPING]

Optional arguments:

--config NAME

File containing jackseis.Converter settings.

--force

Force overwriting of existing files.

--tinc SECONDS

Set time length of output files [s].

--downsample RATE

Downsample to RATE [Hz].

--out-path TEMPLATE

Set output path to TEMPLATE. Available placeholders are %n: network, %s: station, %l: location, %c: channel, %b: begin time, %e: end time, %j: julian day of year. The following additional placeholders use the window begin and end times rather than trace begin and end times (to suppress producing many small files for gappy traces), %(wmin_year)s, %(wmin_month)s, %(wmin_day)s, %(wmin)s, %(wmin_jday)s, %(wmax_year)s, %(wmax_month)s, %(wmax_day)s, %(wmax)s, %(wmax_jday)s. Example: –output=’data/%s/trace-%s-%c.mseed’

--out-sds-path PATH

Set output path to create SDS (https://www.seiscomp.de/seiscomp3/doc/applications/slarchive/SDS.html), rooted at the given path. Implies –tinc=86400. Example: –output-sds-path=data/sds

--out-format FORMAT

Set output file format. Choices: mseed [default], sac, text, yaff, gse2

--out-data-type DTYPE

Set numerical data type. Choices: int32, int64, float32, float64. The output file format must support the given type. By default, the data type is kept unchanged.

--out-mseed-record-length INT

Set the mseed record length in bytes. Choices: 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288. Default is 4096 bytes, which is commonly used for archiving.

--out-mseed-steim INT

Set the mseed STEIM compression. Choices: 1 or 2. Default is STEIM-2, which can compress full range int32. Note: STEIM-2 is limited to 30 bit dynamic range.

--out-meta-path PATH

Set output path for station metadata (StationXML) export.

--traversal GROUPING

By default the outermost processing loop is over time. Add outer loop with given GROUPING. Choices: network, station, channel, sensor

General options:

--help, -h

Show this help message and exit.

--loglevel LEVEL

Set logger level. Choices: critical, error, warning, info, debug. Default: info.

--progress DEST

Set how progress status is reported. Choices: terminal, log, off. Default: terminal.

Data collection options:

--add PATH [PATH ...], -a PATH [PATH ...]

Add files and directories with waveforms, metadata and events. Content is indexed and added to the temporary (default) or persistent (see --persistent) data selection.

--include REGEX

Only include files whose paths match the regular expression REGEX. Examples: --include='\.MSEED$' would only match files ending with .MSEED. --include='\.BH[EN]\.' would match paths containing .BHE. or .BHN.. --include='/2011/' would match paths with a subdirectory 2011 in their path hierarchy.

--exclude REGEX

Only include files whose paths do not match the regular expression REGEX. Examples: --exclude='/\.DS_Store/' would exclude anything inside any .DS_Store subdirectory.

--optimistic, -o

Disable checking file modification times for faster startup.

--format FORMAT, -f FORMAT

Assume input files are of given FORMAT. Choices: datacube, mseed, pyrocko_events, pyrocko_stations, sac, stationxml, tdms_idas, virtual, yaml. Default: detect.

--add-only KINDS

Restrict meta-data scanning to given content kinds. KINDS is a comma-separated list of content kinds. Choices: waveform, station, channel, response, event, waveform_promise. By default, all content kinds are indexed.

--persistent NAME, -p NAME

Create/use persistent selection with given NAME. Persistent selections can be used to speed up startup of Squirrel-based applications.

--dataset FILE, -d FILE

Add files, directories and remote sources from dataset description file. This option can be repeated to add multiple datasets. Run squirrel template to obtain examples of dataset description files.

Data query options:

--kinds KINDS

Content kinds to query. KINDS is a comma-separated list of content kinds. Choices: waveform, station, channel, response, event, waveform_promise. By default, all content kinds are queried.

--codes CODES

Code patterns to query (STA, NET.STA, NET.STA.LOC, NET.STA.LOC.CHA, or NET.STA.LOC.CHA.EXTRA). The pattern may contain wildcards * (zero or more arbitrary characters), ? (single arbitrary character), and [CHARS] (any character out of CHARS). Multiple patterns can be given by separating them with commas.

--tmin TIME

Begin of time interval to query. Format: YYYY-MM-DD HH:MM:SS.FFF, truncation allowed.

--tmax TIME

End of time interval to query. Format: YYYY-MM-DD HH:MM:SS.FFF, truncation allowed.