GWDataFind¶
Installation¶
$ python -m pip install gwdatafind
Supported python versions: 2.7, 3.4+.
$ conda install -c conda-forge gwdatafind
Supported python versions: 2.7, 3.5+.
$ apt-get install python3-gwdatafind
Supported python versions: 2.7, 3.4 (Jessie), 3.5 (Stretch), 3.6 (Buster), click here for instructions on how to add the required debian repositories.
$ yum install python-gwdatafind
Supported python versions: 2.7, click here for instructions on how to add the required yum repositories.
$ port install py37-gwdatafind
Supported python versions: 2.7, 3.6+.
Package overview¶
The client library for the LIGO Data Replicator (LDR) service.
The DataFind service allows users to query for the location of Gravitational-Wave Frame (GWF) files containing data from the current gravitational-wave detectors.
This package provides the HTTPConnection
and
HTTPSConnection
class objects, for connecting to an LDR server
in open and authenticated access modes respectively.
The authenticated HTTPSConnection
requires users have a valid X509
certificate that is registered with the server in question.
Quick-start¶
A high-level connect()
function is provided that will automatically
select the correct protocol based on the host given, and will attempt to
access any required X509 credentials.
Functions¶
connect ([host, port]) |
Open a new connection to a Datafind server |
find_latest (*args, **kwargs) |
Query for the most recent file of a given type. |
find_observatories (*args, **kwargs) |
Query the LDR host for observatories. |
find_times (*args, **kwargs) |
Query the LDR for times for which files are avaliable. |
find_types (*args, **kwargs) |
Query the LDR host for frame types. |
find_url (*args, **kwargs) |
Query the LDR host for a single filename. |
find_urls (*args, **kwargs) |
Find all files of the given type in the [start, end) GPS interval. |
ping (*args, **kwargs) |
Ping the LDR host to test for life. |
Classes¶
HTTPConnection ([host, port, timeout, …]) |
Connect to a GWDataFind host using HTTP. |
HTTPSConnection ([host, port]) |
Connect to a GWDataFind host using HTTPS. |