Command reference

squirrel response

Print instrument response information.

squirrel response

usage: squirrel response [--help] [--loglevel LEVEL] [--progress DEST]
                         [--add PATH [PATH ...]] [--include REGEX]
                         [--exclude REGEX] [--optimistic] [--format FORMAT]
                         [--add-only KINDS] [--persistent NAME]
                         [--dataset FILE] [--codes CODES] [--tmin TIME]
                         [--tmax TIME] [--time TIME]
                         [--level {response,stages}] [--problems] [--plot]
                         [--fmin FMIN] [--fmax FMAX] [--normalize]
                         [--save OUT_PATH] [--dpi DPI] [--stages START:STOP]
                         [--input-quantity QUANTITY] [--show-breakpoints]
                         [--index-labels]

Options:

--level {response,stages}

Set level of detail to be printed. Choices: response, stages

--problems

Print attached warnings and error messages.

--plot

Create Bode plot showing the responses.

--fmin FMIN

Minimum frequency [Hz], default: 0.01

--fmax FMAX

Maximum frequency [Hz], default: 100

--normalize

Normalize response to be 1 on flat part.

--save OUT_PATH

Save figure to file.

--dpi DPI

DPI setting for pixel image output, default: 100

--stages START:STOP

Show response of selected stages. Indexing is Python style: count starts at zero, negative values count from the end.

--input-quantity QUANTITY

Show converted response for given input quantity. choices: displacement, velocity, acceleration

--show-breakpoints

Show breakpoints of pole-zero responses.

--index-labels

Label graphs only by index and print details to terminal to save space when many labels would be shown. Aggregate identical responses under a common index.

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, spickle, 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:

--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.

--time TIME

Time instant to query. Format: YYYY-MM-DD HH:MM:SS.FFF, truncation allowed.