gwcelery.tasks.gracedb module

Communication with GraceDB.

class gwcelery.tasks.gracedb.RetryableHTTPError(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

Exception class for server-side HTTP errors that we should retry.

gwcelery.tasks.gracedb.catch_retryable_http_errors(f)

Decorator to capture server-side errors that we should retry.

We retry HTTP status 502 (Bad Gateway), 503 (Service Unavailable), and 504 (Gateway Timeout).

gwcelery.tasks.gracedb.task(*args, **kwargs)

(task)gwcelery.tasks.gracedb.create_event(*args, **kwargs)

Create an event in GraceDB.

(task)gwcelery.tasks.gracedb.create_label(*args, **kwargs)

Create a label in GraceDB.

(task)gwcelery.tasks.gracedb.remove_label(*args, **kwargs)

Create a label in GraceDB.

(task)gwcelery.tasks.gracedb.create_signoff(*args, **kwargs)

Create a label in GraceDB.

(task)gwcelery.tasks.gracedb.create_tag(*args, **kwargs)

Create a tag in GraceDB.

(task)gwcelery.tasks.gracedb.create_voevent(*args, **kwargs)

Create a VOEvent.

Returns:The filename of the new VOEvent. Return type:str

(task)gwcelery.tasks.gracedb.download(*args, **kwargs)

Download a file from GraceDB.

(task)gwcelery.tasks.gracedb.expose(*args, **kwargs)

Expose an event to the public.

Notes

If expose_to_public is False, then this because a no-op.

(task)gwcelery.tasks.gracedb.get_events(*args, **kwargs)

Get events from GraceDB.

(task)gwcelery.tasks.gracedb.get_event(*args, **kwargs)

Retrieve an event from GraceDB.

(task)gwcelery.tasks.gracedb.get_search(*args, **kwargs)

Retrieve the search field of an event from GraceDB.

(task)gwcelery.tasks.gracedb.get_labels(*args, **kwargs)

Get all labels for an event in GraceDB.

(task)gwcelery.tasks.gracedb.get_log(*args, **kwargs)

Get all log messages for an event in GraceDB.

(task)gwcelery.tasks.gracedb.get_superevent(*args, **kwargs)

Retrieve a superevent from GraceDB.

(task)gwcelery.tasks.gracedb.replace_event(*args, **kwargs)

Get an event from GraceDB.

(task)gwcelery.tasks.gracedb.upload(*args, **kwargs)

Upload a file to GraceDB.

(task)gwcelery.tasks.gracedb.get_superevents(*args, **kwargs)

List matching superevents in gracedb.

Parameters:

• *args – arguments passed to GraceDb.superevents()
• **kwargs – keyword arguments passed to GraceDb.superevents()

Returns:

superevents – The list of the superevents.

Return type:

list

(task)gwcelery.tasks.gracedb.update_superevent(*args, **kwargs)

Update superevent information. Wrapper around updateSuperevent()

Parameters:

• superevent_id (str) – superevent uid
• t_start (float) – start of superevent time window, unchanged if None
• t_end (float) – end of superevent time window, unchanged if None
• t_0 (float) – superevent t_0, unchanged if None
• preferred_event (str) – uid of the preferred event, unchanged if None

(task)gwcelery.tasks.gracedb.create_superevent(*args, **kwargs)

Create new superevent in GraceDB with graceid

Parameters:

• graceid (str) – graceid with which superevent is created.
• t0 (float) – t_0 parameter of superevent
• t_start (float) – t_start parameter of superevent
• t_end (float) – t_end parameter of superevent
• category (str) – superevent category

(task)gwcelery.tasks.gracedb.add_event_to_superevent(*args, **kwargs)

Add an event to a superevent in GraceDB.