gw-eccentricity 1.0.3

Defining eccentricity for gravitational wave astronomy.

Defining eccentricity for gravitational wave astronomy

About

gw_eccentricity provides methods to measure eccentricity and mean anomaly from gravitational waveforms.

These methods are described in the following paper:

• [1] Md Arif Shaikh, Vijay Varma, Harald Pfeiffer, Antoni Ramos-Buades and Maarten van de Meent, "Defining eccentricity for gravitational wave astronomy", (2023). arXiv:2302.11257

Please see Credits below for citing this work. This package lives on GitHub, is compatible with python3, and is tested every week. You can see the current build status of the main branch at the top of this page.

Installation

PyPI

gw_eccentricity is available through PyPI:

pip install gw_eccentricity

Conda

gw_eccentricity can be installed using conda also:

conda install -c conda-forge gw_eccentricity

From source

git clone [e-mail]:vijayvarma392/gw_eccentricity.git
cd gw_eccentricity
python setup.py install

If you do not have root permissions, replace the last step with python setup.py install --user

Dependencies

All of these can be installed through pip or conda.

• numpy
• scipy
• h5py
• lalsuite

Usage

See the example notebook here for a demo.

Making contributions

See this README for instructions on how to make contributions to this package.

Please report bugs by raising an issue on our GitHub repository.

Credits

The main contributors to this code are Md Arif Shaikh, Vijay Varma, and Harald Pfeiffer. You can find the full list of contributors here.

If you find this package useful in your work, please cite reference [1] and this package. You can use the following bibtex keys:

@article{Shaikh:2023ypz,
    author = "Shaikh, Md Arif and Varma, Vijay and Pfeiffer, Harald P. and Ramos-Buades, Antoni and van de Meent, Maarten",
    title = "{Defining eccentricity for gravitational wave astronomy}",
    eprint = "2302.11257",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    month = "2",
    year = "2023",
    Note = "{\href{https://pypi.org/project/gw_eccentricity}{pypi.org/project/gw\_eccentricity}}",
}

---

Image at the top shows an eccentric gravitational wave signal (SXS:BBH:2558) from arXiv:2209.03390.