Running wscan
on the command line¶
As described on the home page, the main interface to the gravityspy algorithm is the command-line executable wscan
.
Basic instructions¶
Basic instructions on running wscan
can be gained by looking at the --help
menu:
$ wscan --help
Using Theano backend.
WARNING (theano.configdefaults): install mkl with `conda install mkl-service`: No module named 'mkl'
usage: wscan [-h] [-V] --channel-name CHANNEL_NAME --event-time EVENT_TIME
[--gravityspy-id] [--id ID] [--frametype FRAMETYPE]
[--plot-directory PLOT_DIRECTORY] --path-to-cnn-model
PATH_TO_CNN_MODEL --path-to-semantic-file PATH_TO_SEMANTIC_FILE
--project-info-pickle PROJECT_INFO_PICKLE [--hdf5] [--sql]
[--verbose]
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
--channel-name CHANNEL_NAME
What channel to find the data in
--event-time EVENT_TIME
Trigger time of the glitch
--gravityspy-id Is this image being generated for the GravitySpy
project, if so you must assign a gravityspy_id string
to label the images instead of GPS time
--id ID The gravityspy_id string to be supplied with
--gravityspy_id
--frametype FRAMETYPE
Frame type to find data for
--plot-directory PLOT_DIRECTORY
Outdir for images
--path-to-cnn-model PATH_TO_CNN_MODEL
Path to name of cnn model
--path-to-semantic-file PATH_TO_SEMANTIC_FILE
Path to name of similarity model
--project-info-pickle PROJECT_INFO_PICKLE
This pickle file holds informationabout what workflows
a image with whatconfidence label should go into
--hdf5 Store triggers in local hdf5 table format
--sql Store triggers in a remote sql DB
--verbose Run in Verbose Mode
Detailed instructions¶
A few of the command-line options require special formatting, use the reference below for more detailed info.