Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
intro.rst 1.69 KiB

Basic usage

The GWDataFind service allows users to query for the location of Gravitational-Wave data files containing data associated with gravitational-wave detectors.

This package provides a number of functions to make requests to a GWDataFind server with authorization credential handling.

Top-level API

The :mod:`gwdatafind` top-level module provides a number of convenience functions to perform single queries without a persistent connection:

For example:

The above examples work well for 'one-shot' queries where only a single result is required. For repeated queries, or similar, that require multiple connections to the same GWDataFind host, see :doc:`session`.

Command-line interface

GWDataFind also provides a command-line interface accessible via module execution (python -m gwdatafind) or the gw_data_find entry point script. See :doc:`commandline`.