Command line¶
The qseek command runs and manages searches. Every command has a --help.
usage: qseek [-h] [--verbose] [--version]
{config,search,continue,snuffler,explore,feature-extraction,modules,export,clear-cache,dump-schemas}
...
qseek - The wholesome earthquake detector 🚀
options:
-h, --help show this help message and exit
--verbose, -v increase verbosity of the log messages, repeat to
increase. Default level is INFO
--version show version and exit
commands:
Available commands to run qseek. Get command help with `qseek <command>
--help`.
{config,search,continue,snuffler,explore,feature-extraction,modules,export,clear-cache,dump-schemas}
config print a new config
search start a search
continue continue an existing search
snuffler start the Pyrocko snuffler to inspect waveforms,
events and picks
explore start the web UI to explore the results of a search
feature-extraction extract features from an existing run
modules show available modules
export export detections to different output formats
clear-cache clear the cach directory
dump-schemas dump data models to json-schema (development)
qseek config¶
Print a configuration with all defaults.
usage: qseek config [-h]
Print a new default config configuration file.
options:
-h, --help show this help message and exit
qseek search¶
Start a search.
usage: qseek search [-h] [--force] [--no-backup] config
detect, localize and characterize earthquakes in a dataset
positional arguments:
config path to config file
options:
-h, --help show this help message and exit
--force backup old rundir and create a new
--no-backup override existing rundir without creating a backup
qseek continue¶
Continue a stopped search.
usage: qseek continue [-h] rundir
Continue a run from an existing rundir or JSON config file.
positional arguments:
rundir existing rundir or JSON config to continue
options:
-h, --help show this help message and exit
qseek snuffler¶
Inspect detections, picks and waveforms in Pyrocko Snuffler.
usage: qseek snuffler [-h] [--show-observed] [--show-modelled]
[--show-semblance]
rundir
Start the snuffler to inspect and validate the detections and waveforms for an
existing run
positional arguments:
rundir path of the existing rundir
options:
-h, --help show this help message and exit
--show-observed show observed picks
--show-modelled show modelled picks
--show-semblance show stacked semblance trace
qseek explore¶
Explore the results in the web UI.
usage: qseek explore [-h] [--reload] [--port PORT] uris [uris ...]
Start the web UI to explore the results of an existing run
positional arguments:
uris URIs to explore, can be local paths or SSH URIs (e.g.
ssh://user@host/path/to/rundir)
options:
-h, --help show this help message and exit
--reload enable auto-reload of the UI when source data changes, this is
not recommended for remote sources
--port PORT port to run the web UI on (default: 2213)
qseek feature-extraction¶
Calculate magnitudes and features of a run again.
usage: qseek feature-extraction [-h] [--recalculate] [--nparallel NPARALLEL]
rundir
Modify the search.json for re-evaluation of the event's features
positional arguments:
rundir path of existing run
options:
-h, --help show this help message and exit
--recalculate recalculate all magnitudes
--nparallel NPARALLEL
number of parallel tasks for feature extraction
qseek modules¶
List the available modules, including plugin modules.
usage: qseek modules [-h] [name]
Show all available modules
positional arguments:
name Name of the module to print JSON config for.
options:
-h, --help show this help message and exit
qseek export¶
Export detections to other formats.
usage: qseek export [-h] [--force] format [rundir] [export_dir]
Export detections to different output formats. Get an overview with `qseek
export list`
positional arguments:
format Name of export module, or `list` to list available modules
rundir path to existing qseek rundir
export_dir path to export directory
options:
-h, --help show this help message and exit
--force overwrite existing output directory
qseek clear-cache¶
Clear the cache directory.
usage: qseek clear-cache [-h]
Clear all data in the cache directory
options:
-h, --help show this help message and exit
qseek dump-schemas¶
Write the JSON schemas of the data models (for development).