qltool

Module to retrieve data from QuakeLink servers.

Description

qltool is an application to retrieve event data from a quakelink server. It is part of the QuakeLink suite/software package.

By command-line options qltool can filter event objects and use logical object criteria. Please read the command-line help for the options:

qltool -h

Examples

  • Query a specifc event, output: XML, stdout

    qltool -E gempa2018abcd
    
  • Query all events, output: line based file

    qltool -Sy /tmp/events.txt
    

Module Configuration

etc/defaults/global.cfg
etc/defaults/qltool.cfg
etc/global.cfg
etc/qltool.cfg
~/.seiscomp/global.cfg
~/.seiscomp/qltool.cfg

qltool inherits global options.

Note

Modules/plugins may require a license file. The default path to license files is @DATADIR@/licenses/ which can be overridden by global configuration of the parameter gempa.licensePath. Example:

gempa.licensePath = @CONFIGDIR@/licenses

Command-Line Options

qltool [options]

Connection settings

-H, --host

Host (QuakeLink server) to connect to.

-h, --help

Produce help message.

-s, --ssl

Use secure socket layer (SSL).

--ssl-no-hostname

Do not verify the server’s hostname.

--ssl-no-cert

Do not verify the server certificate chain. Implicitly disables the hostname check.

-c, --credentials arg

Username:password for authentication separated by colon. If password is not given, it is asked for on tty.

--ping

Request and validate server identifier.

--alive

Request sever to send alive message every 30s, useful for long running select updated queries to prevent connection termination by routers.

Single-event query

-E, --event

Event ID to download.

-r, --rev

Revision of event.

-R, --all-rev

Request all revisions of event. The output format is fixed to summary.

Multi-event query

-S, --select

Search events by key event parameters.

--updated

Keep connection open and wait for event updates.

--archvied

Request archived events, only required in combination with --updated.

--from arg

Begin time. Format: %Y,%m,%d[,%H,%M,%S,%f]

--to time

End time. Format: %Y,%m,%d[,%H,%M,%S,%f]

--filter arg

SQL like where, order, limit and offset filter:

[WHERE clause] [ORDER BY OTIME ASC|DESC] [LIMIT %n [OFFSET %n]]

clause := condition[ AND|OR [(]clause[)]]

condition := MAG|DEPTH|LAT|LON|PHASES op {float} |

UPDATED|OTIME op time |

AGENCY|STATUS|TYPE|REGION|MAG_T op ‘string’ |

MAG|DEPTH|LAT|LON|PHASES|OTIME|UPDATED IS [NOT] NULL

op :==|!=|>|>=|<|<=|eq|gt|ge|lt|ge

time := %Y,%m,%d[,%H,%M,%S,%f]

--processor arg

Event processor script called with file path after XML output file was created.

Event content

-P, --with-picks

Export all associated picks.

-A, --with-amplitudes

Export all associated amplitudes.

-M, --with-magnitudes

Export all station magnitudes.

-F, --with-stamts

Export moment tensor station contributions and phase settings.

-a, --ignore-arrivals

Do not export origin arrivals.

-p, --preferred-only

When exporting events only the preferred origin and the preferred magnitude will be dumped.

Event format

-f, --formatted

Output formatted XML.

-n, --native

Request native format which is the unmodified data pushed to the QuakeLink server. The parameters P, A, M, F, a, p, f are ignored in this mode.

-z, --gzip

Request for gzip compressed data, not supported in summary format.

-y, --summary

Request summary format which is a line based and semicolon separated representation of the key event parameters.

-v, --version arg

The specific format version to request, currently only supported by summary format.