Command reference
squirrel mseed clockdrift¶
Analyse clock drift and possibly resample recordings.
- squirrel mseed clockdrift¶
usage: squirrel mseed clockdrift [--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]
[--kinds KINDS] [--codes CODES]
[--codes-exclude CODES] [--tmin TIME]
[--tmax TIME] [--time TIME]
[--out-path TEMPLATE] [--out-sds-path PATH]
[--out-storage-path PATH]
[--out-storage-scheme SCHEME]
[--out-format FORMAT]
[--out-mseed-record-length INT]
[--out-mseed-steim INT] [--force] [--append]
[--merge]
Options:
- --force
Force overwriting of existing files.
- --append
Append to existing files. This only works for mseed files. Checks are performed to ensure that appended traces have no overlap with already existing traces.
- --merge
Merge with existing data in files. This only works for mseed files.
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, -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 subdirectory2011in 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_Storesubdirectory.
- --optimistic, -o
Disable checking file modification times for faster startup.
- --format, -f FORMAT
Assume input files are of given
FORMAT. Choices:datacube,hdf5_optodas,mseed,pyrocko_events,pyrocko_stations,rug,sac,spickle,sqlite-ELK1,stationxml,tdms_idas,virtual,yaff,yaml. Default:detect.
- --add-only KINDS
Restrict meta-data scanning to given content kinds.
KINDSis a comma-separated list of content kinds. Choices:waveform,station,channel,response,event,carpet,waveform_promise. By default, all content kinds are indexed.
- --persistent, -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
Nsamples. Default: 100000
- --dataset, -d FILE
Add files, directories and remote sources from dataset description file. This option can be repeated to add multiple datasets. Run
squirrel templateto 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.
KINDSis a comma-separated list of content kinds. Choices:waveform,station,channel,response,event,carpet,waveform_promise. By default, all content kinds are queried.
- --codes CODES
Code patterns to query (
STA,NET.STA,NET.STA.LOC,NET.STA.LOC.CHA, orNET.STA.LOC.CHA.EXTRA). The pattern may contain wildcards*(zero or more arbitrary characters),?(single arbitrary character), and[CHARS](any character out ofCHARS). 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.
- --time TIME
Time instant to query. Format:
YYYY-MM-DD HH:MM:SS.FFF, truncation allowed.
Storage options:
- --out-path TEMPLATE
Set output path to
TEMPLATE. Available placeholders are%n: network,%s: station,%l: location,%c: channel,%b: begin time,%e: end time,%j: julian day of year. The following additional placeholders use the current processing window’s begin and end times rather than trace begin and end times (to suppress producing many small files for gappy traces),%(wmin_year)s,%(wmin_month)s,%(wmin_day)s,%(wmin)s,%(wmin_jday)s,%(wmax_year)s,%(wmax_month)s,%(wmax_day)s,%(wmax)s,%(wmax_jday)s. Example:--out-path 'data/%s/trace-%s-%c.mseed'
- --out-sds-path PATH
Set output path to create an SDS archive (https://www.seiscomp.de/seiscomp3/doc/applications/slarchive/SDS.html), rooted at PATH. Implies
--tinc 3600if not specified otherwise. Equivalent to--out-storage-path PATH --out-storage-scheme sds. Example:--out-sds-path data/sds
- --out-storage-path PATH
Create storage directory under PATH. The storage scheme can be set with
--out-storage-scheme.
- --out-storage-scheme SCHEME
Set storage scheme to produce when using
--out-storage-path. Choices:default,rug-store-10,rug-store-100,rug-store-1000,sds
- --out-format FORMAT
Set output file format. Choices: mseed [default], sac, text, yaff, gse2
- --out-mseed-record-length INT
Set the Mini-SEED record length in bytes. Choices:
256,512,1024,2048,4096,8192,16384,32768,65536,131072,262144,524288. Default is 4096 bytes, which is commonly used for archiving, unless the selected storage scheme specifies a different default.
- --out-mseed-steim INT
Set the Mini-SEED STEIM compression. Choices:
1or2. Default is STEIM-2 unless the selected storage scheme specifies a different default. Note: STEIM-2 is limited to 30 bit dynamic range.
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
🐿️