gracedb-sdk Documentation

gracedb-sdk is a REST API client for the LIGO/Virgo Gravitational-Wave Candidate Event Database (GraceDB). It uses the powerful httpx package for reliable and high-throughput HTTP connection pooling.

Quick Start

Install with pip:

pip install gracedb-sdk

API

class gracedb_sdk.AsyncClient(url='https://gracedb.ligo.org/api/', *args, **kwargs)[source]

Bases: AsyncAPI

Like gracedb_sdk.Client, but uses async/await.

class gracedb_sdk.Client(url='https://gracedb.ligo.org/api/', *args, **kwargs)[source]

Bases: API

GraceDB client client.

Parameters:

  • url (str) – GraceDB Client URL.

  • token (str) – Filename for SciTokens bearer token.

  • username (str) – Username for basic auth.

  • password (str) – Password for basic auth.

  • force_noauth (bool, default=False) – If true, then do not use any authentication at all.

  • fail_if_noauth (bool, default=False) – If true, then raise an exception if authentication credentials are not provided.

  • auth_reload (bool, default=False) – If true, then automatically reload the authentication before it expires.

  • auth_reload_timeout (int, default=300) – Reload the authentication this many seconds before it expires.

Notes

When a new Client instance is created, the following sources of authentication are tried, in order:

  1. If the force_noauth keyword argument is true, then perform no authentication at all.

  2. If the token keyword argument is provided, then use SciTokens bearer token authentication.

  3. If the username and password keyword arguments are provided, then use basic auth.

  4. Look for a SciTokens bearer token in:

    1. the environment variable BEARER_TOKEN_FILE

    2. the file $XDG_RUNTIME_DIR/bt_uUID, where UID is your numeric user ID, if the file exists and is readable

  5. Read the netrc file [1] located at ~/.netrc, or at the path stored in the environment variable NETRC, and look for a username and password matching the hostname in the URL.

  6. If the fail_if_noauth keyword argument is true, and no authentication source was found, then raise a ValueError.

The following methods are supported for the client itself:

  • client.user_info()

The following methods are supported for events:

  • client.events.get()

  • client.events.search(query=query, sort=sort)

  • client.events.create(filename=filename, filecontents=filecontents, group=group, pipeline=pipeline, search=search, labels=labels, offline=offline)

  • client.events.update(event_id, filename=filename, filecontents=filecontents)

  • client.events[event_id].get()

  • client.events[event_id].files.get()

  • client.events[event_id].files[filename].get()

  • client.events[event_id].labels.get()

  • client.events[event_id].labels.create(label)

  • client.events[event_id].labels.delete(label)

  • client.events[event_id].logs.get()

  • client.events[event_id].logs.create(comment=comment, filename=filename, filecontents=filecontents, tags=tags, label=label)

  • client.events[event_id].logs[N].tags.create(tag)

  • client.events[event_id].logs[N].tags.delete(tag)

  • client.events[event_id].voevents.get()

  • client.events[event_id].voevents.create(voevent_type={}, internal=internal, open_alert=open_alert, hardware_inj=hardware_inj, skymap_type=skymap_type, skymap_filename=skymap_filename, ProbHasNS=ProbHasNS, ProbHasRemnant=ProbHasRemnant, BNS=BNS, NSBH=NSBH, BBH=BBH, Terrestrial=Terrestrial, MassGap=MassGap, coinc_comment=coinc_comment)

Analogous methods are supported for superevents:

  • client.superevents.get()

  • client.superevents.search(query=query, sort=sort)

  • client.superevents.create(t_start=t_start, t_0=t_0, t_end=t_end, preferred_event=preferred_event, events=events, labels=labels)

  • client.superevents.update(superevent_id, t_start=t_start, t_0=t_0, t_end=t_end, preferred_event=preferred_event)

  • client.superevents[superevent_id].add(event_id)

  • client.superevents[superevent_id].remove(event_id)

  • client.superevents[superevent_id].is_exposed()

  • client.superevents[superevent_id].expose()

  • client.superevents[superevent_id].unexpose()

  • client.superevents[superevent_id].signoff('ADV'|'H1'|'L1'|'V1', 'OK'|'NO', comment)

  • client.superevents[superevent_id].get()

  • client.superevents[superevent_id].files.get()

  • client.superevents[superevent_id].files[filename].get()

  • client.superevents[superevent_id].labels.get()

  • client.superevents[superevent_id].labels.create(label)

  • client.superevents[superevent_id].labels.delete(label)

  • client.superevents[superevent_id].logs.get()

  • client.superevents[superevent_id].logs.create(comment=comment, filename=filename, filecontents=filecontents, tags=tags, label=label)

  • client.superevents[superevent_id].logs[N].tags.create(tag)

  • client.superevents[superevent_id].logs[N].tags.delete(tag)

  • client.superevents[superevent_id].pipeline_preferred_events.get()

  • client.superevents[superevent_id].pipeline_preferred_events.add(event_id)

  • client.superevents[superevent_id].pipeline_preferred_events.remove(event_id)

  • client.superevents[superevent_id].voevents.get()

  • client.superevents[superevent_id].voevents.create(voevent_type={}, internal=internal, open_alert=open_alert, hardware_inj=hardware_inj, skymap_type=skymap_type, skymap_filename=skymap_filename, ProbHasNS=ProbHasNS, ProbHasRemnant=ProbHasRemnant, BNS=BNS, NSBH=NSBH, BBH=BBH, Terrestrial=Terrestrial, MassGap=MassGap, coinc_comment=coinc_comment)

References