Metadata-Version: 2.1
Name: ligo.em-bright
Version: 1.2.0
Summary: Possibility and properties of Electromagnetically-bright sources of gravitational-wave events
License: MIT
Author: Deep Chatterjee
Author-email: deep.chatterjee@ligo.org
Requires-Python: >=3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: astropy (>=5.2.1)
Requires-Dist: h5py (>=3.7.0)
Requires-Dist: lalsuite (>=7.0,<8.0)
Requires-Dist: pandas (>=1.5.2)
Requires-Dist: scikit-learn (==1.2.1)
Description-Content-Type: text/markdown

# ligo.em_bright

This library provides the tools to compute the possibility of merging gravitational-wave binaries to have an electromagnetic counterpart or having a component in the lower mass-gap region. The data products are source properties
- `HasNS`: The mass of at least one of the compact binary coalescence is consistent with a neutron star.
- `HasRemnant`: A non-zero amount of remnant matter remained outside the final compact object (a necessary but not sufficient condition to produce certain kinds of electromagnetic emission such as a short GRB or a kilonova).
- `HasMassGap`: The mass of at least one of the compact binary coalescence is consistent with lower mass-gap region i.e. between 3-5 solar mass.

The `HasNS` and `HasRemnant` quantities depend on, and are marginalized over, several neutron star equations of state (EOS). The marginalization is done using data from [GW170817](https://www.gw-openscience.org/eventapi/html/GWTC-1-confident/GW170817/).

