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.

Metadata

Release files for mlgw-bns 1.0.0

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.0
File Size Uploaded Provenance Actions
mlgw_bns-1.0.0.tar.gz 50.0 MB Without provenance Details for mlgw_bns-1.0.0.tar.gz

Built distribution (wheel)

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

Total release size: 99.3 MB

Release files / mlgw_bns-1.0.0.tar.gz

Download URL mlgw_bns-1.0.0.tar.gz
Size 50.0 MB
Tags Source
SHA-256 checksum
How to use checksums
606ab589cae4ff65b1a7af6d2204c0bd68d7770997d012e5d2c9802ea728096c
BLAKE2b-256 checksum
How to use checksums
079451e35e7183dc9d9f74c4650793b38168556c6d7e65116653ae3ef4553fc6
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.0-py3-none-any.whl

Download URL mlgw_bns-1.0.0-py3-none-any.whl
Size 49.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
383da2c873d47a740cee43d4a63250dfb9bafa365870827790c05d5b9be993fe
BLAKE2b-256 checksum
How to use checksums
02c7886623e2f583b810b079db94e23b752aa48db402c2d6917aeebcef9f8aaf
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}

Security for mlgw-bns 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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