Command reference

squirrel dataset create

Create dataset configuration file based on given data collection options (--add, --include, …) given on the command line. The resulting YAML file can be used with the --dataset option.

squirrel dataset create

usage: squirrel dataset create [--help] [--loglevel LEVEL] [--progress DEST]
                               [--threads-loading INT] [--out PATH]
                               [--add PATH [PATH ...]] [--include REGEX]
                               [--exclude REGEX] [--format FORMAT]
                               [--add-only KINDS]

Options:

--out PATH, -o PATH

Write output YAML document to PATH.

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.

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

---

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

🐿️