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):
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 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mlgw_bns-2.0.1.tar.gz | 3.3 MB | Without provenance | Details for mlgw_bns-2.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mlgw_bns-2.0.1-py3-none-any.whl | Python 3 | none | any | Details for mlgw_bns-2.0.1-py3-none-any.whl |
Total release size: 6.0 MB
Release files / mlgw_bns-2.0.1.tar.gz
| Download URL | mlgw_bns-2.0.1.tar.gz |
|---|---|
| Size | 3.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
81bcd2b691824cb80aa71952a2b5da68c76ab6b7387a892748cab42ee4d90f64
|
|
BLAKE2b-256 checksum How to use checksums |
20fa5948b3866a6bff410a1151edd7642fc44d97457913a406008cd81914b8e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / mlgw_bns-2.0.1-py3-none-any.whl
| Download URL | mlgw_bns-2.0.1-py3-none-any.whl |
|---|---|
| Size | 2.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5ec3cc80b20e57bd2068f5f482818c5bf7323cce90bdfdcfd265e405477a1095
|
|
BLAKE2b-256 checksum How to use checksums |
cf4ff5e5030e356a17cbd2efde2698668ae5c695bd18042df9e60f63bacc5aa0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for mlgw-bns 2.0.1
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.