Metadata-Version: 2.4
Name: pypolychord-bilby
Version: 0.1.0
Summary: Plugin for using pypolychord with bilby.
Author: Bilby Developers
Maintainer-email: Colm Talbot <colm.talbot@ligo.org>, "Michael J. Williams" <michael.williams@ligo.org>
License: MIT
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bilby>=2.3.0
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# pypolychord-bilby

`pypolychord` plugin for `bilby`.

This plugin provides the `pypolychord` sampler in `bilby`.

## Installation

First, install `PolyChordLite` and `pypolychord` following the instructions in
the `PolyChordLite`
[documentation](https://github.com/PolyChord/PolyChordLite?tab=readme-ov-file#python-quickstart).

Once `pypolychord` is installed, install the plugin from PyPI:

```bash
pip install pypolychord-bilby
```

or from conda-forge

```
conda install conda-forge:pypolychord-bilby
```

## Usage

Once `pypolychord-bilby` is installed, the sampler can be used directly in
`bilby` via the `run_sampler` function:

```python
import bilby

likelihood = ...
priors = ...

bilby.run_sampler(
    sampler="pypolychord",
    likelihood=likelihood,
    priors=priors,
    nlive=1000,
    ...
)
```

### Usage with `bilby_pipe`

This plugin has not been tested with `bilby_pipe`.
