Skip to main content

CI Pipeline for mlgw_bns Documentation Status PyPI version Code style: black Coverage Status Downloads

Machine Learning for Gravitational Waves from Binary Neutron Star mergers

This package's purpose is to speed up the generation of template gravitational waveforms for binary neutron star mergers by training a machine learning model on a dataset of waveforms generated with some physically-motivated surrogate.

It is able to reconstruct them with mismatches lower than 1/10000, with as little as 1000 training waveforms; the accuracy then steadily improves as more training waveforms are used.

Currently, the only model used for training is TEOBResumS, but it is planned to introduce the possibility to use others.

The model shipped with the package covers the $(2,2)$, $(2,1)$, $(3,1)$, $(3,2)$, $(3,3)$, $(4,3)$ and $(4,4)$ spherical-harmonic modes. Below are the per-mode and full-waveform mismatch distributions against the underlying TEOBResumS waveforms: with the residual time shift and reference phase optimized (top), and with only the surrogate's own predicted alignment applied (bottom):

mismatches

The documentation can be found here.

Installation

To install the package, use

pip install mlgw-bns

For more details see the documentation.

Changelog

Changes across versions are documented in the CHANGELOG.

Reference

The reference paper is Tissino, Carullo, Breschi, Gamba, Schmidt & Bernuzzi, "Combining effective-one-body accuracy and reduced-order-quadrature speed for binary neutron star merger parameter estimation with machine learning", published in Physical Review D 107, 084037 (2023), doi:10.1103/PhysRevD.107.084037.

Release files for mlgw_bns 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mlgw_bns 1.0.1
File Size Uploaded
mlgw_bns-1.0.1.tar.gz 50.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for mlgw_bns 1.0.1
File Interpreter ABI Platform
mlgw_bns-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 99.3 MB

Release files / mlgw_bns-1.0.1.tar.gz

Download URL mlgw_bns-1.0.1.tar.gz
Size 50.0 MB
Tags Source
SHA-256 checksum
How to use checksums
b7b5dd4caac7624287aa24f9a3f257d6e210cbc370326f642a5c37cb2a9b5586
BLAKE2b-256 checksum
How to use checksums
4bf02991929b7bb92208b9d4bdb1c43b8be415d1d7e1b15292bff30a2a908f0b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / mlgw_bns-1.0.1-py3-none-any.whl

Download URL mlgw_bns-1.0.1-py3-none-any.whl
Size 49.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f41c6d766fa268673483bd1bb625647155e034d49b8f40523fdbf20f621bbac9
BLAKE2b-256 checksum
How to use checksums
a91e1d9acd489d3ef08bc1c1155cb957eba94013b9907ea3252e8db0eee4cb00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page