Metadata-Version: 2.2
Name: gwpopulation
Version: 1.2.0
Summary: Unified population inference
Home-page: https://github.com/ColmTalbot/gwpopulation
Author: Colm Talbot
Author-email: talbotcolm@gmail.com
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy>=1.16
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: tqdm
Requires-Dist: bilby>=2.2.0
Requires-Dist: cached_interpolate>=0.3.0
Requires-Dist: wcosmo>=0.3.0
Provides-Extra: cupy
Requires-Dist: cupy; extra == "cupy"
Provides-Extra: jax
Requires-Dist: jax; extra == "jax"
Requires-Dist: jaxlib; extra == "jax"
Provides-Extra: pages
Requires-Dist: ipython_genutils; extra == "pages"
Requires-Dist: ipywidgets; extra == "pages"
Requires-Dist: jinja2; extra == "pages"
Requires-Dist: myst-parser; extra == "pages"
Requires-Dist: nbsphinx; extra == "pages"
Requires-Dist: numpydoc; extra == "pages"
Requires-Dist: pandoc; extra == "pages"
Requires-Dist: pydata-sphinx-theme; extra == "pages"
Requires-Dist: pygments; extra == "pages"
Requires-Dist: sphinx; extra == "pages"
Requires-Dist: sphinx_rtd_theme; extra == "pages"
Requires-Dist: sphinx-autoapi; extra == "pages"
Requires-Dist: sphinx-copybutton; extra == "pages"
Requires-Dist: sphinx-design; extra == "pages"
Provides-Extra: test
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pre-commit; extra == "test"
Requires-Dist: jupyter; extra == "test"
Requires-Dist: nbconvert; extra == "test"
Requires-Dist: astropy; extra == "test"
Requires-Dist: jax; extra == "test"
Requires-Dist: numpyro; extra == "test"
Requires-Dist: scipy<1.14; extra == "test"

<h1 align="center">
<img src="https://raw.githubusercontent.com/ColmTalbot/gwpopulation/main/docs/_static/logo-long.svg">
</h1>

------------------------------------------------------------------------------

[![Python package](https://github.com/ColmTalbot/gwpopulation/actions/workflows/python-package.yml/badge.svg)](https://github.com/ColmTalbot/gwpopulation/actions/workflows/python-package.yml)
[![codecov](https://codecov.io/gh/ColmTalbot/gwpopulation/branch/master/graph/badge.svg?token=4K4V0HRDMI)](https://codecov.io/gh/ColmTalbot/gwpopulation)
[![Versions](https://img.shields.io/pypi/pyversions/gwpopulation.svg)](https://pypi.org/project/gwpopulation/)
![Conda Downloads](https://img.shields.io/conda/d/conda-forge/gwpopulation)

Flexible, extensible, hardware-agnostic gravitational-wave population inference.

- [Documentation](https://ColmTalbot.github.io/gwpopulation)
- [Source Repository](https://github.com/ColmTalbot/GWPopulation)
- [Issues](https://github.com/ColmTalbot/GWPopulation/issues)
- [Contributing](https://colmtalbot.github.io/gwpopulation/contributing/index.html)

It provides:

- Simple use of GPU-acceleration via [JAX](https://jax.readthedocs.io/en/latest/) and [cupy](https://cupy.dev/).
- Implementations of widely used likelihood compatible with [Bilby](https://docs.ligo.org/lscsoft/bilby).
- A standard format for defining new population models.
- A collection of standard population models.

If you're using this on high-performance computing clusters, you may be interested in the associated pipeline code [gwpopulation_pipe](https://docs.ligo.org/RatesAndPopulations/gwpopulation_pipe/).

#### Attribution

------------------------------------------------------------------------------

Please cite [Talbot _et al._ (2019)](https://doi.org/10.1103/PhysRevD.100.043030) if you use `GWPopulation` in your research.

```bibtex
@ARTICLE{2019PhRvD.100d3030T,
  author = {{Talbot}, Colm and {Smith}, Rory and {Thrane}, Eric and {Poole}, Gregory B.},
  title = "{Parallelized inference for gravitational-wave astronomy}",
  journal = {\prd},
  year = 2019,
  month = aug,
  volume = {100},
  number = {4},
  eid = {043030},
  pages = {043030},
  doi = {10.1103/PhysRevD.100.043030},
  archivePrefix = {arXiv},
  eprint = {1904.02863},
  primaryClass = {astro-ph.IM},
}
```

Additionally, please consider citing the original references for the implemented models which should be include in docstrings.
