Skip to content

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

License

Notifications You must be signed in to change notification settings

gwkokab/gwkokab

Repository files navigation

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

Installation | Documentation | Examples/Tutorials | FAQs | Citing GWKokab ✴️

GitHub License Documentation Status CI

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.

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:

@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}
}