Command reference

squirrel jackseis-classic

Squirrel’s adaption of classic Jackseis.

squirrel jackseis-classic

usage: squirrel jackseis-classic [--help] [--loglevel LEVEL] [--progress DEST]
                                 [--pattern REGEX] [--quiet] [--debug]
                                 [--tmin TMIN] [--tmax TMAX] [--tinc TINC]
                                 [--sample-snap {shift,interpolate}]
                                 [--downsample RATE] [--output TEMPLATE]
                                 [--output-dir TEMPLATE]
                                 [--output-format {mseed,sac,text,yaff,gse2}]
                                 [--force] [--no-snap]
                                 [--traversal {station-by-station,channel-by-channel,chronological}]
                                 [--rename-network /PATTERN/REPLACEMENT/]
                                 [--rename-station /PATTERN/REPLACEMENT/]
                                 [--rename-location /PATTERN/REPLACEMENT/]
                                 [--rename-channel /PATTERN/REPLACEMENT/]
                                 [--output-data-type DTYPE]
                                 [--output-record-length RECORD_LENGTH]
                                 [--output-steim STEIM_COMPRESSION]
                                 [--output-quantity {acceleration,velocity,displacement}]
                                 [--restitution-frequency-band FMIN,FMAX]
                                 [--nthreads NTHREADS] [--add PATH [PATH ...]]
                                 [--include REGEX] [--exclude REGEX]
                                 [--optimistic] [--format FORMAT]
                                 [--add-only KINDS] [--persistent NAME]
                                 [--dataset FILE]

Optional arguments:

--pattern REGEX

only include files whose paths match REGEX

--quiet

disable output of progress information

--debug

print debugging information to stderr

--tmin TMIN

start time as “YYYY-mm-dd HH:MM:SS[.xxx]”

--tmax TMAX

end time as “YYYY-mm-dd HH:MM:SS[.xxx]”

--tinc TINC

set time length of output files [s] or “auto” to automatically choose an appropriate time increment or “huge” to allow to use a lot of system memory to merge input traces into huge output files.

--sample-snap {shift,interpolate}

shift/interpolate traces so that samples are at even multiples of sampling rate. Choices: shift, interpolate

--downsample RATE

downsample to RATE [Hz]

--output 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, %(wmax_year)s, %(wmax_month)s, %(wmax_day)s, %(wmax)s. Example: –output=’data/%s/trace-%s-%c.mseed’

--output-dir TEMPLATE

set output directory to TEMPLATE (see –output for details) and automatically choose filenames. Produces files like TEMPLATE/NET-STA-LOC-CHA_BEGINTIME.FORMAT

--output-format {mseed,sac,text,yaff,gse2}

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

--force

force overwriting of existing files

--no-snap

do not start output files at even multiples of file length

--traversal {station-by-station,channel-by-channel,chronological}

set traversal order for traces processing. Choices are ‘station-by-station’ [default], ‘channel-by-channel’, and ‘chronological’. Chronological traversal uses more processing memory but makes it possible to join multiple stations into single output files

--rename-network /PATTERN/REPLACEMENT/

update network code, can be given more than once

--rename-station /PATTERN/REPLACEMENT/

update station code, can be given more than once

--rename-location /PATTERN/REPLACEMENT/

update location code, can be given more than once

--rename-channel /PATTERN/REPLACEMENT/

update channel code, can be given more than once

--output-data-type DTYPE

set data type. Choices: same [default], int32, int64, float32, float64. The output file format must support the given type.

--output-record-length RECORD_LENGTH

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.

--output-steim STEIM_COMPRESSION

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.

--output-quantity {acceleration,velocity,displacement}

deconvolve instrument transfer function. Choices: acceleration, velocity, displacement

--restitution-frequency-band FMIN,FMAX

frequency band for instrument deconvolution as FMIN,FMAX in Hz. Default: “0.001,100.0”

--nthreads NTHREADS

number of threads for processing, this can speed-up CPU bound tasks (Python 3.5+ only)

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.