aspire-bilby

Interface between aspire and bilby.

Installation

aspire-bilby is available via pypi:

pip install aspire-bilby

Usage in bilby

aspire can be used just like any other sampler in bilby and supports multiprocessing via the n_pool keyword argument.

bilby.run_sampler(
    sampler="aspire",
    n_samples=1000,
    n_final_samples=None,  # Optional, final number of samples to produce
    sample_kwargs=dict(
        sampler="smc"
    ),
    fit_kwargs=dict(
        n_epochs=100,
    ),
    n_pool=4,
)

Using a set of samples

from aspire.samples import Samples

initial_samples = Samples(...)  # Define initial samples

bilby.run_sampler(
    sampler="aspire",
    initial_samples=initial_samples,
    ...
)

Using a bilby result file

bilby.run_sampler(
    sampler="aspire",
    initial_result_file="<path to bilby result file>"
    ...,
)

Sampling from the prior

bilby.run_sampler(
    sampler="aspire",
    n_initial_samples=5000,  # Number of samples to draw from the prior, defaults to 10,000 if not specified
    ...,
)

Using bilby objects with aspire

aspire-bilby also provides functions for converting bilby likelihood and prior objects into

import bilby
from aspire import Aspire
from aspire_bilby.utils import samples_from_bilby_result, get_aspire_functions

likelihood = ...    # Define bilby likelihood
priors = ...        # Define bilby priors

result = bilby.core.utils.read_in_result(...)    # Read in bilby result

functions = get_aspire_functions(
    likelihood,
    priors,
    parameters=priors.non_fixed_keys,
)

initial_samples = samples_from_bilby_result(result)

aspire = Aspire(
    log_likelihood=functions.log_likelihood,
    log_prior=functions.log_prior,
    dims=len(initial_samples.parameters),
)

history = aspire.fit(initial_samples)

Usage in bilby_pipe

aspire can be used with bilby_pipe as you would any other sampler:

sampler = "aspire"
sampler_kwargs = {
    "initial_result_file": "path_to_file",
    "sample_kwargs": {...},
    "fit_kwargs": {...},
}

If using transfer files, you may also need to add the initial result file to the additional-transfer-paths.

Download files

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

Source Distribution

aspire_bilby-0.1.0.tar.gz (21.6 kB view details)

Uploaded Aug 3, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

aspire_bilby-0.1.0-py3-none-any.whl (12.2 kB view details)

Uploaded Aug 3, 2026 Python 3

File details

Details for the file aspire_bilby-0.1.0.tar.gz.

File metadata

Download URL: aspire_bilby-0.1.0.tar.gz
Upload date: Aug 3, 2026
Size: 21.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aspire_bilby-0.1.0.tar.gz
Algorithm	Hash digest
SHA256	`1f93413f94dab66bad71b7dfc585ca55fa066491a29ce09a1ee9dbc63abebd82`
MD5	`382beedb4c7fcfa5adeccf9a1d7f99f6`
BLAKE2b-256	`9c2f46f4938f6034c77b9c1ebaa99a79ee375a281c1a62f87b04f5199ffea2d8`

See more details on using hashes here.

Provenance

The following attestation bundles were made for aspire_bilby-0.1.0.tar.gz:

Publisher: publish.yml on mj-will/aspire-bilby

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: aspire_bilby-0.1.0.tar.gz
- Subject digest: 1f93413f94dab66bad71b7dfc585ca55fa066491a29ce09a1ee9dbc63abebd82
- Sigstore transparency entry: 2334886681
- Sigstore integration time: Aug 3, 2026
Source repository:
- Permalink: mj-will/aspire-bilby@51531785730d0514c2090c70495fd3eebe624a1d
- Branch / Tag: refs/tags/v0.1.0
- Owner: https://github.com/mj-will
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@51531785730d0514c2090c70495fd3eebe624a1d
- Trigger Event: release