https://github.com/gwkokab/gwkokab

An open-source JAX-based gravitational-wave population inference toolkit for parametric models ✴️
https://github.com/gwkokab/gwkokab

astrophysics gravitational-waves jax neutron-star

Last synced: 8 days ago
JSON representation

An open-source JAX-based gravitational-wave population inference toolkit for parametric models ✴️

• Host: GitHub
• URL: https://github.com/gwkokab/gwkokab
• Owner: gwkokab
• License: apache-2.0
• Created: 2023-12-24T21:55:35.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-24T19:48:44.000Z (3 months ago)
• Last Synced: 2024-10-25T04:42:45.058Z (3 months ago)
• Topics: astrophysics, gravitational-waves, jax, neutron-star
• Language: Python
• Homepage: https://gwkokab.readthedocs.io
• Size: 25 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.bib

Awesome Lists containing this project

• awesome-normalizing-flows - GWKokab

README

        












A JAX-based gravitational-wave population inference toolkit for parametric models



[**Installation**](https://gwkokab.readthedocs.io/en/latest/installation.html) |

[**Documentation**](https://gwkokab.readthedocs.io/) |

[**Examples/Tutorials**](https://gwkokab.readthedocs.io/en/latest/examples.html) |

[**FAQs**](https://gwkokab.readthedocs.io/en/latest/FAQs.html) |

[**Citing GWKokab**](#citing-gwkokab)

![GitHub License](https://img.shields.io/github/license/gwkokab/gwkokab)

[![Documentation Status](https://readthedocs.org/projects/gwkokab/badge/?version=latest)](https://gwkokab.readthedocs.io/en/latest/?badge=latest)

[![CI](https://github.com/gwkokab/gwkokab/actions/workflows/ci.yml/badge.svg)](https://github.com/gwkokab/gwkokab/actions/workflows/ci.yml)

GWKokab is a JAX-based gravitational-wave population inference toolkit. It is designed to be a high-performance, flexible, easy-to-use library for sampling from a wide range of gravitational-wave population models. It is built on top of JAX, a high-performance numerical computing library, and is designed to be easily integrated into existing JAX workflows.

If you would like to contribute, please see the [contributing guidelines](https://gwkokab.readthedocs.io/en/latest/dev_docs/contributing.html).

> [!WARNING]

> Our documentation is generally maintained, but tutorials are currently outdated. While the main documentation is largely current, some inconsistencies may exist. We greatly value community feedback – if you encounter any discrepancies, please submit an issue report to help us improve the documentation quality for all users.

## Citing GWKokab

If you use GWKokab in your research, please cite the following paper:

```bibtex

@software{gwkokab2024github,

    author = {Meesum Qazalbash, Muhammad Zeeshan, Richard O'Shaughnessy},

    title = {{GWKokab}: A JAX-based gravitational-wave population inference toolkit for parametric models},

    url = {https://github.com/gwkokab/gwkokab},

    version = {0.0.1},

    year = {2024}

}

```