Command reference

squirrel check

Check dataset consistency.

squirrel check

usage: squirrel check [--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]
                      [--ignore TYPE,...] [--verbose] [--out-format FMT]

A report listing potential dataset/metadata problems for a given data collection is printed to standard output. The following problems are detected:

None

None

[p1]: Waveform duplicates. [p2]: Overlaps in channel/response epochs. [p3]: No waveforms available for a channel/response listed in metadata. [p4]: Channel/response information missing for an available waveform. [p5]: Multiple channel/response entries matching an available waveform. [p6]: Sampling rate of waveform does not match rate listed in metadata. [p7]: Waveform incompletely covered by channel/response epochs.

Options:

--ignore TYPE,...

Problem types to be ignored. Choices: p1, p2, p3, p4, p5, p6, p7.

--verbose, -v

Verbose mode for textual output. Multiple -v options increase the verbosity. The maximum is 2. At level 1, ok indicators are printed for entries with no problem. At level 2, availability information is shown for each entry.

--out-format FMT

Specifies how output is presented. Choices: text, yaml. Default: text.

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.