Command reference

squirrel catalog

Query and list catalog events.

squirrel catalog

usage: squirrel catalog [--help] [--loglevel LEVEL] [--progress DEST]
                        [--add PATH [PATH ...]] [--include REGEX]
                        [--exclude REGEX] [--optimistic] [--format FORMAT]
                        [--add-only KINDS] [--persistent NAME] [--dataset FILE]
                        [--upgrade-storage] [--kinds KINDS] [--tmin TIME]
                        [--tmax TIME] [--magnitude-min FLOAT]
                        [--magnitude-max FLOAT] [--depth-min FLOAT]
                        [--depth-max FLOAT] [--style {table,summary,yaml}]

Update earthquake catalog information and output summary information about matching events to the terminal. It reads event information from catalog files (see --add) or from configured data sources (see --dataset). If the data sources include online catalogs, the local information is updated for the given time span. If no time span is specified, the latest events available are queried and shown. The available information can be filtered by time, magnitude and event depth.

Examples: squirrel catalog -d :events-gcmt-m6 – show latest events in the Global-CMT catalog. squirrel catalog -d : – shortcut to see list of preconfigured datasets. squirrel catalog --add events.yaml --tmin 2024 --tmax 2024-02 – show all events defined in the file events.yaml which occurred in January 2024.

Options:

--magnitude-min FLOAT

Minimum magnitude for event filter.

--magnitude-max FLOAT

Maximum magnitude for event filter.

--depth-min FLOAT

Minimum depth for event filter [km].

--depth-max FLOAT

Maximum depth for event filter [km].

--style {table,summary,yaml}

Set style of presentation. Choices: table, summary, yaml

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.

--upgrade-storage

Upgrade storage layout of cached data to latest version.

Data query options:

--kinds KINDS

Content kinds to query. KINDS is a comma-separated list of content kinds. Choices: waveform, station, channel, response, event, waveform_promise. By default, all content kinds are queried.

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

🐿️