Skip to main content

Python package to extend the functionality of `bilby` to additionally sample over glitch realisations

Project description

bilby antiglitch

PyPI version

Coverage report Pipeline Status

This Python package extends the functionality in the bilby to additionally sample over glitch realisations

Installation

bilby_antiglitch is currently available via PyPI and can be installed with:

$ pip install bilby_antiglitch

Once bilby_antiglitch has been installed, a custom version of bilby_pipe needs to be installed with:

$ pip install 'bilby_pipe @ git+https://git.ligo.org/charlie.hoy/bilby_pipe.git@input_class'

This version needs to be installed because we are waiting for required code to be merged into the main bilby_pipe code base. Please see the following merge request for details:

* `bilby_pipe!583 <https://git.ligo.org/lscsoft/bilby_pipe/-/merge_requests/583>`_

For full installation instructions, see our documentation.

Usage in bilby_pipe

The functionality in bilby_antiglitch can be used with bilby_pipe as you would with any other frequency domain source model. It simply requires the following options to be specified in your configuration file:

analysis_executable_parser=bilby_antiglitch.bilby_pipe.create_parser
likelihood-type=GravitationalWaveTransientPlusGlitch
glitch-frequency-domain-source-model = bilby_antiglitch.source.antiglitch
detectors-glitch = ['L1']

If you wish to perform an injection with a specific glitch model, this can be done with the following option in your configuration file:

injection-glitch-frequency-domain-source-model = bilby_antiglitch.source.antiglitch

Citing

If you find bilby_antiglitch useful in your work please cite the following papers:

@article{Hoy:2026dkr,
    author = "Hoy, Charlie and Bondarescu, Ruxandra and Lundgren, Andrew and Nuttall, Laura K.",
    title = "{A parametric signal plus noise inference framework for short duration non-Gaussian noise transients}",
    eprint = "2606.31304",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    reportNumber = "LIGO-P2600325",
    month = "6",
    year = "2026"
}

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

bilby_antiglitch-0.1.0a1.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

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

bilby_antiglitch-0.1.0a1-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file bilby_antiglitch-0.1.0a1.tar.gz.

File metadata

  • Download URL: bilby_antiglitch-0.1.0a1.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for bilby_antiglitch-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 a30691ffe05d776c3f658c14c908d7a03e483427887059a88585de247f020e33
MD5 c80bd3fd6e60303218ab3d582fae2221
BLAKE2b-256 1e0a58ea03344fff767b26e9062fbbab0c8c7b14a8b5a33a0153bb558329b5b3

See more details on using hashes here.

File details

Details for the file bilby_antiglitch-0.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for bilby_antiglitch-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 7f3bfee2197bfd185776d3fd44e7229cc7fa5a188cc099c22c72f9b63f995672
MD5 e082cdbbd6f6657821fd83fd46557dee
BLAKE2b-256 53b7cd9e60667f0e19982f8ec0307f31ebf458386121c469c71aa23cea5a3b26

See more details on using hashes here.

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