gw_data_find¶
GWDataFind queries can be made using the command-line interface
accessible via module execution (python -m gwdatafind) or
the gw_data_find entry point script:
usage: gw_data_find [-h] [-v] [-V] [[-p | -w | -y | -a | -f FILE | -T]]
[-o OBS] [-t TYPE] [-s GPS] [-e GPS] [-x EXT] -r HOST [-P]
[-A {ldr,v1}] [[-l | -W | -n]] [-m MATCH] [-u URL_TYPE]
[-g] [-O PATH]
Optional arguments¶
- -v, --verbose
Increase verbosity (give once for
INFO, twice forDEBUG).Default:
0- -V, --version
show version number and exit
Query types¶
Select one of the following, if none are selected a query for frame URLS will be performed
- -p, --ping
ping the DataFind server
Default:
False- -w, --show-observatories
list available observatories
Default:
False- -y, --show-types
list available file types
Default:
False- -a, --show-times
list available segments
Default:
False- -f, --filename
resolve URL(s) for a particular file name
- -T, --latest
resolve URL(s) for the most recent file of the specified type
Default:
False
Data options¶
Parameters for your query. Which options are required depends on the query type
- -o, --observatory
observatory(ies) that generated frame file; use –show-observatories to see what is available.
- -t, --type
type of frame file, use –show-types to see what is available.
- -s, --gps-start-time
start of GPS time search
- -e, --gps-end-time
end of GPS time search
- -x, --extension
file extension for which to search
Default:
'gwf'
Connection options¶
Authentication and connection options.
- -r, --server
hostname and optional port of server to query
- -P, --no-proxy
attempt to authenticate without a grid proxy
Default:
False- -A, --api
Possible choices: ldr, v1
API version to use
Default:
'v1'
Output options¶
Parameters for parsing and writing output.
- -l, --lal-cache
format output for use as a LAL cache file
Default:
False- -W, --frame-cache
[DEPRECATED] format output for use as a frame cache file
Default:
False- -n, --names-only
display only the basename of each file
Default:
False- -m, --match
return only results that match a regular expression
- -u, --url-type
return only URLs with a particular scheme or head such as “file” or “gsiftp”
Default:
'file'- -g, --gaps
check the returned list of URLs or paths to see if the files cover the requested interval; a return value of zero (0) indicates the interval is covered, a value of one (1) indicates at least one gap exists and the interval is not , covered and a value of (2) indicates that the entire interval is not covered; missing gaps are printed to stderr
Default:
False- -O, --output-file
path to output file, defaults to stdout