Reference#

shigawire Package#

Classes#

Settings([_case_sensitive, ...])

Application configuration.

Class Inheritance Diagram#

Inheritance diagram of shigawire.Settings

shigawire.models Module#

Data models for Kafka topics and SQL tables.

Classes#

Event()

Same as EventData, but includes a unique ID.

EventData()

Metadata for a gravitational-wave candidate detected by a search pipeline.

EventMap()

One-to-many mapping between Superevent and Event records.

EventXml()

Storage for the original XML file uploaded by a search pipeline.

Superevent()

A collection of events clustered together in time.

SupereventFits()

Sky map FITS file for a Superevent record.

Class Inheritance Diagram#

Inheritance diagram of shigawire.models.Event, shigawire.models.EventData, shigawire.models.EventMap, shigawire.models.EventXml, shigawire.models.Superevent, shigawire.models.SupereventFits

shigawire.pathway Module#

Functions#

main([settings])

Main entrypoint for Pathway pipeline.

shigawire.webapp Module#

REST API for Shigawire