Skip to main content

Interface and plugin for using nessai in bilby

Project description

nessai-bilby

Interface and plugin for using nessai in bilby.

This plugin provides two samplers that can be used in bilby:

  • nessai: the standard nested sampler from nessai
  • inessai: the importance nested sampler from nessai

It also provides a means to use bilby likelihoods and priors directly in nessai, see using bilby likelihoods in nessai

Installation

The package can be installed using pip

pip install nessai-bilby

or conda

conda install conda-forge::nessai-bilby

However, we recommend following installing PyTorch manually to ensure the correct device support.

Note: this plugin requires "bilby>=2.3.0".

Usage

In bilby

One nessai-bilby is installed, both samplers can be used directly in bilby via the run_sampler function. See the bilby documentation for more details on how to run different samplers.

Using bilby likelihoods in nessai

nessai-bilby also provides two model classes that allow bilby likelihood and priors to be used directly with nessai:

  • nessai_bilby.model.BilbyModel:
  • nessai_bilby.model.BilbyModelLikelihoodConstraint:

Either model can be used by creating an instance of the model and running nessai as usual:

from nessai.flowsampler import FlowSampler
from nessai_bilby.model import BilbyModel

likelihood = ...    # bilby likelihood object
priors = ... # bilby PriorDict

model = BilbyModel(
    priors=priors,
    likelihood=likelihood,
    use_ratio=True    # Whether to use the log-likelihood ratio
)

fs = FlowSampler(
    model,
    ...,
)

fs.run()

Citing

If you use nessai-bilby, please cite the nessai and bilby code bases and the corresponding papers.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nessai_bilby-0.2.2.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nessai_bilby-0.2.2-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file nessai_bilby-0.2.2.tar.gz.

File metadata

  • Download URL: nessai_bilby-0.2.2.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nessai_bilby-0.2.2.tar.gz
Algorithm Hash digest
SHA256 223baa9183efe300e50d585e879e3afa6bc1a64f23261564f37c73e7bfaf0f03
MD5 6e23ff12e3293da0f104d2e88e16ad5a
BLAKE2b-256 a27393c6046156899a2cebab7c0ce9ce6633bdcd2ef03f4f697b42d2dfa4ae70

See more details on using hashes here.

Provenance

The following attestation bundles were made for nessai_bilby-0.2.2.tar.gz:

Publisher: publish.yml on bilby-dev/nessai-bilby

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nessai_bilby-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: nessai_bilby-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nessai_bilby-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3b12df63c6548e2b0c3fe434bc82c41a1f03e17637eb2cdc660a061be31ac969
MD5 3d1c94eb97adaa36712802c496c3aaf6
BLAKE2b-256 a8099d1eaa2689eb1b414919795d667e712acad32115fe02e8d5a91ec3ec5ed6

See more details on using hashes here.

Provenance

The following attestation bundles were made for nessai_bilby-0.2.2-py3-none-any.whl:

Publisher: publish.yml on bilby-dev/nessai-bilby

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page