Command reference

squirrel benchmark

Perform benchmark tests.

squirrel benchmark

usage: squirrel benchmark [--help] [--loglevel LEVEL] [--progress DEST]
                          [--threads-loading INT] [--add PATH [PATH ...]]
                          [--include REGEX] [--exclude REGEX] [--optimistic]
                          [--format FORMAT] [--add-only KINDS]
                          [--persistent NAME] [--samples-block N]
                          [--dataset FILE] [--upgrade-storage] [--codes CODES]
                          [--codes-exclude CODES] [--tmin TIME] [--tmax TIME]
                          [--tinc DURATION]
                          BENCHMARK

The following benchmarks are available:

None

None

chopper-waveforms

Test performance of waveform data reading in typical continuous waveform processing schemes. Use --dataset or --add to select input data and --tinc to set a processing time-window duration. Query options --codes, --tmin and --tmax can be used to restrict the reading to a specific subset of the available data.

mseed-files-parse

Test speed of the mseed waveform decoding which is performed in the libmseed functions without the overhead of Squirrel’s database querying. This test sequentially reads all files in the set-up data selection. Any query options are ignored in this test.

mseed-files-disk-io

Test speed of raw disk io without the overhead of decoding the mseed data. This test sequentially reads all files in the set-up data selection. Any query options are ignored in this test. Note: the io speed is reported under traces, even though no traces are decoded in this test.

Positional arguments:

BENCHMARK

Benchmark to perform. Choices: chopper-waveforms, mseed-files-parse, mseed-files-disk-io.

Options:

--tinc DURATION

Set processing time interval for chopper benchmark [s].

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.

--threads-loading INT

Set number of threads used in file content loading/decoding. Default: 1

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

--samples-block N

When downloading data, use blocks with approximately N samples. Default: 100000

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

--upgrade-storage

Upgrade storage layout of cached data to latest version.

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.

--codes-exclude CODES

Code patterns to exclude. See --codes.

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

---

Manual: https://pyrocko.org/docs/current/apps/squirrel

Tutorial: https://pyrocko.org/docs/current/apps/squirrel/tutorial.html

Examples: https://pyrocko.org/docs/current/apps/squirrel/manual.html#examples

🐿️