<h1> <img src="https://raw.githubusercontent.com/vijayvarma392/gw_eccentricity/main/data/hreal.png"></h1>
<h3 align="center"> Defining eccentricity for gravitational wave astronomy </h4>
<div align="center">
[](https://github.com/vijayvarma392/gw_eccentricity)
[](https://pypi.org/project/gw_eccentricity)
[](https://anaconda.org/conda-forge/gw_eccentricity)
[](https://github.com/vijayvarma392/gw_eccentricity/blob/main/LICENSE)
[](https://github.com/vijayvarma392/gw_eccentricity/actions/workflows/test.yml)
[](https://gw-eccentricity.readthedocs.io/en/latest/?badge=latest)
</div>
# About
**gw_eccentricity** provides methods to measure eccentricity and mean anomaly
from gravitational waveforms.
These methods are described in the following paper: <br/>
- [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](https://arxiv.org/abs/2302.11257)
Please see [Credits](#credits) below for citing this work.
This package lives on [GitHub](https://github.com/vijayvarma392/gw_eccentricity), 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](https://pypi.org/project/gw_eccentricity/):
```shell
pip install gw_eccentricity
```
## Conda
**gw_eccentricity** can be installed using `conda` also:
```shell
conda install -c conda-forge gw_eccentricity
```
## From source
```shell
git clone git@github.com: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](https://docs.scipy.org/doc/numpy/user/install.html)
* [scipy](https://www.scipy.org/install.html)
* [h5py](http://docs.h5py.org/en/latest/build.html)
* [lalsuite](https://pypi.org/project/lalsuite)
# Usage
See the example notebook [here](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/gw_eccentricity_demo.ipynb) for a demo.
# Making contributions
See this
[README](https://github.com/vijayvarma392/gw_eccentricity/blob/main/README_developers.md)
for instructions on how to make contributions to this package.
Please report bugs by raising an issue on our
[GitHub](https://github.com/vijayvarma392/gw_eccentricity) repository.
# Credits
The main contributors to this code are [Md Arif Shaikh](https://md-arif-shaikh.github.io/), [Vijay
Varma](https://vijayvarma.com), and [Harald Pfeiffer](https://www.aei.mpg.de/person/54205/2784). You can find the full list of contributors
[here](https://github.com/vijayvarma392/gw_eccentricity/graphs/contributors).
If you find this package useful in your work, please cite reference [1] and
this package. You can use the following bibtex keys:
```BibTeX
@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](https://arxiv.org/abs/2209.03390).
Raw data
{
"_id": null,
"home_page": "https://github.com/vijayvarma392/gw_eccentricity",
"name": "gw-eccentricity",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "black-holes gravitational-waves",
"author": "Md Arif Shaikh, Vijay Varma, Harald Pfeiffer",
"author_email": "arifshaikh.astro@gmail.com, vijay.varma392@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8c/f3/8a0f248376dc6fa247c1103577175339d0fb4d051207cb8cde22d6852d1a/gw_eccentricity-1.0.4.tar.gz",
"platform": null,
"description": "<h1> <img src=\"https://raw.githubusercontent.com/vijayvarma392/gw_eccentricity/main/data/hreal.png\"></h1>\n\n<h3 align=\"center\"> Defining eccentricity for gravitational wave astronomy </h4>\n\n<div align=\"center\">\n\n[](https://github.com/vijayvarma392/gw_eccentricity)\n[](https://pypi.org/project/gw_eccentricity)\n[](https://anaconda.org/conda-forge/gw_eccentricity)\n[](https://github.com/vijayvarma392/gw_eccentricity/blob/main/LICENSE)\n[](https://github.com/vijayvarma392/gw_eccentricity/actions/workflows/test.yml)\n[](https://gw-eccentricity.readthedocs.io/en/latest/?badge=latest)\n\n</div>\n\n# About\n\n**gw_eccentricity** provides methods to measure eccentricity and mean anomaly\nfrom gravitational waveforms.\n\nThese methods are described in the following paper: <br/>\n- [1] Md Arif Shaikh, Vijay Varma, Harald Pfeiffer, Antoni Ramos-Buades and Maarten van de Meent,\n\"Defining eccentricity for gravitational wave astronomy\", (2023). [arXiv:2302.11257](https://arxiv.org/abs/2302.11257)\n\nPlease see [Credits](#credits) below for citing this work.\nThis package lives on [GitHub](https://github.com/vijayvarma392/gw_eccentricity), is compatible with\n`python3`, and is tested every week. You can see the current build status of\nthe main branch at the top of this page.\n\n\n# Installation\n\n## PyPI\n**gw_eccentricity** is available through [PyPI](https://pypi.org/project/gw_eccentricity/):\n\n```shell\npip install gw_eccentricity\n```\n\n## Conda\n**gw_eccentricity** can be installed using `conda` also:\n```shell\nconda install -c conda-forge gw_eccentricity\n```\n\n## From source\n\n```shell\ngit clone git@github.com:vijayvarma392/gw_eccentricity.git\ncd gw_eccentricity\npython setup.py install\n```\n\nIf you do not have root permissions, replace the last step with\n`python setup.py install --user`\n\n## Dependencies\n\nAll of these can be installed through pip or conda.\n* [numpy](https://docs.scipy.org/doc/numpy/user/install.html)\n* [scipy](https://www.scipy.org/install.html)\n* [h5py](http://docs.h5py.org/en/latest/build.html)\n* [lalsuite](https://pypi.org/project/lalsuite)\n\n# Usage\nSee the example notebook [here](https://github.com/vijayvarma392/gw_eccentricity/blob/main/examples/gw_eccentricity_demo.ipynb) for a demo.\n\n# Making contributions\nSee this\n[README](https://github.com/vijayvarma392/gw_eccentricity/blob/main/README_developers.md)\nfor instructions on how to make contributions to this package.\n\nPlease report bugs by raising an issue on our\n[GitHub](https://github.com/vijayvarma392/gw_eccentricity) repository.\n\n# Credits\nThe main contributors to this code are [Md Arif Shaikh](https://md-arif-shaikh.github.io/), [Vijay\nVarma](https://vijayvarma.com), and [Harald Pfeiffer](https://www.aei.mpg.de/person/54205/2784). You can find the full list of contributors\n[here](https://github.com/vijayvarma392/gw_eccentricity/graphs/contributors).\n\nIf you find this package useful in your work, please cite reference [1] and\nthis package. You can use the following bibtex keys:\n```BibTeX\n@article{Shaikh:2023ypz,\n author = \"Shaikh, Md Arif and Varma, Vijay and Pfeiffer, Harald P. and Ramos-Buades, Antoni and van de Meent, Maarten\",\n title = \"{Defining eccentricity for gravitational wave astronomy}\",\n eprint = \"2302.11257\",\n archivePrefix = \"arXiv\",\n primaryClass = \"gr-qc\",\n month = \"2\",\n year = \"2023\",\n Note = \"{\\href{https://pypi.org/project/gw_eccentricity}{pypi.org/project/gw\\_eccentricity}}\",\n}\n```\n\n---\nImage at the top shows an eccentric gravitational wave signal (SXS:BBH:2558) from [arXiv:2209.03390](https://arxiv.org/abs/2209.03390).\n",
"bugtrack_url": null,
"license": "",
"summary": "Defining eccentricity for gravitational wave astronomy.",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/vijayvarma392/gw_eccentricity"
},
"split_keywords": [
"black-holes",
"gravitational-waves"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92e85a1a465b5c231d9d90b8644ab062709d014a382211b218afe8d6d7e21946",
"md5": "9f538ed0b0ada861fc6426cd0ede05d9",
"sha256": "4a9c3e67d035f233e6281b3088ec060e70aaf45fb8407ca429ca34d18ff6333b"
},
"downloads": -1,
"filename": "gw_eccentricity-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f538ed0b0ada861fc6426cd0ede05d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 84620,
"upload_time": "2023-10-23T04:41:18",
"upload_time_iso_8601": "2023-10-23T04:41:18.226376Z",
"url": "https://files.pythonhosted.org/packages/92/e8/5a1a465b5c231d9d90b8644ab062709d014a382211b218afe8d6d7e21946/gw_eccentricity-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cf38a0f248376dc6fa247c1103577175339d0fb4d051207cb8cde22d6852d1a",
"md5": "d2be6facb0646b54001d4f196704efe1",
"sha256": "61ca038be8b0a4bb98bdd86d0930d4d8e862b1d7232baa26990c684fbed0095c"
},
"downloads": -1,
"filename": "gw_eccentricity-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "d2be6facb0646b54001d4f196704efe1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 85469,
"upload_time": "2023-10-23T04:41:19",
"upload_time_iso_8601": "2023-10-23T04:41:19.977737Z",
"url": "https://files.pythonhosted.org/packages/8c/f3/8a0f248376dc6fa247c1103577175339d0fb4d051207cb8cde22d6852d1a/gw_eccentricity-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-23 04:41:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vijayvarma392",
"github_project": "gw_eccentricity",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gw-eccentricity"
}
JSON
