Commands

gvt provides a command line interface to provide common tasks, listed below.

gvt

Glitch Validation Toolkit

Usage:

 [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

fetch

Fetch events of a given type and write them to disk.

Usage:

 fetch [OPTIONS] EVENT_TYPE:{gspy|injections|omicron|snax} [START] [END]

Options:

  EVENT_TYPE:{gspy|injections|omicron|snax}
                                  The type of event to get.  [required]
  [START]                         [default: The GPS start time.]
  [END]                           [default: The GPS end time.]
  --channel TEXT                  The channel to grab events from.  [required]
  --column TEXT                   If specified, the list of columns to query
                                  from.
  --filter TEXT                   If specified, conditions in which to filter
                                  events.
  --filter-times TEXT             Keep only times corresponding to this data
                                  quality flag.
  --directory PATH                If specified, the base directory where
                                  events are located. Only relevant for snax
                                  events.
  -o, --output PATH               Write output to file. If not specified,
                                  writes a file to the current working
                                  directory with the T050017 naming
                                  convention: {detector}-{event_type.upper()}-
                                  {start}-{end}.h5

plot

Generate combined omega scan / event plots from a set of source events.

Usage:

 plot [OPTIONS] TIMES...

Options:

  -s, --source PATH               source events to plot for given times
                                  [required]
  --channel TEXT                  The channel to grab events from.  [required]
  TIMES...                        Times to generate plots for.  [required]
  --duration, --event-duration FLOAT
                                  The duration in seconds to plot around
                                  events.  [default: 8.0]
  -o, --output PATH               Write output to this directory.  [default:
                                  /builds/patrick.godwin/gvt]

validate

Validate a set of events against a reference.

Usage:

 validate [OPTIONS]

Options:

  -t, --target PATH               The target events to validate against.
                                  [required]
  -r, --reference PATH            The reference events for validation.
                                  [required]
  --coincidence-window FLOAT      The maximum time spacing to consider an
                                  event to be in coincidence.  [default: 0.25]
  --threshold, --snr-threshold FLOAT
                                  The SNR threshold, used when validating
                                  against injections.  [default: 5.5]
  --duration, --event-duration FLOAT
                                  The duration in seconds to plot around
                                  events.  [default: 8.0]
  -n, --limit INTEGER             The maximum number of missed events to
                                  follow up.  [default: 10]
  --filter TEXT                   If specified, conditions in which to filter
                                  target events.
  -o, --output PATH               Write output to this directory.  [default:
                                  /builds/patrick.godwin/gvt]