Skip to main content

pocomc plugin for bilby

Project description

DOI PyPI

pocomc-bilby

pocomc plugin for bilby.

This package provides a plugin for using pocomc with bilby via the sampler plugins interface. pocomc is Sequential Monte Carlo sampler that implements a specific flavour of SMC called Persistent Sampling. For more details, see the pocomc documentation.

Installation

Note: since pocomc depends on torch we recommend installing it first using the instructions on the PyTorch website.

pocomc-bilby is can be installed via pip:

pip install pococmc-bilby

Note: this plugin only supports pocomc>=1.2.6.

Usage

Once installed, pocomc can be used as you would any other sampler in bilby:

import bilby

# Define likelihood & priors as normal
priors = ...
likelihood = ...

bilby.run_sampler(
    sampler="pocomc",
    ...
)

pocomc has two different types of settings, those specified when initializing the sampler and those specified when calling the run method. When using pocomc via bilby both types of settings can be passed to run_sampler and these will automatically be passed to the correct method.

For details about the various settings, see the pocomc documentation.

This plugin is also compatible with bilby_pipe, including support for checkpointing.

Attribution & Citation

If you use pocomc-bilby in your own work please cite the DOI for this package, corresponding paper (to be added) and the citations for pocomc, see Attribution & Citation in the pocomc documentation

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

pocomc_bilby-0.2.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

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

pocomc_bilby-0.2.1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file pocomc_bilby-0.2.1.tar.gz.

File metadata

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

File hashes

Hashes for pocomc_bilby-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7ce7335188918532eac29be67d8c48ceb29cd67ea0629cdea903eb3ab9e311bf
MD5 8992b6de737cdfced839696fab1dbf5d
BLAKE2b-256 07b08dafcea60d9df8a38fd629f1120836cf7acaf3080a8edbc4b8239096b59a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pocomc_bilby-0.2.1.tar.gz:

Publisher: publish.yml on mj-will/pocomc-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 pocomc_bilby-0.2.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pocomc_bilby-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d5d5c570b2fa8f45ba89fed0cd0a5a325cd4970473d35b9d388394481eece64b
MD5 a4272fb38e779fa00c157582f8b0228b
BLAKE2b-256 fb0a211ab4f9c8d697cee6cf457592274e3629692a13e0d5306a7b0d2c94fca9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pocomc_bilby-0.2.1-py3-none-any.whl:

Publisher: publish.yml on mj-will/pocomc-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