Skip to main content

jaxqualin

A python package for extracting quasinormal modes from black-hole ringdown simulations.

doc

Key Features • Installation • Usage • Paper Results • How to Cite • License

Key Features

  • Fit ringdown waveforms with quasinormal modes (QNMs) using fixed frequencies, free frequencies, or mixed setups
  • JAX-accelerated nonlinear least-squares fitting with variable projection (VARPRO) and Optimistix-based optimization
  • Flexible QNM model fitting for remnant-parameter inference (M, a) and custom parametric models
  • Custom mode and model framework for user-defined mode content beyond standard Kerr QNMs
  • Agnostic mode identification and stability-based mode selection across varying fit start times
  • Save/reuse fit outputs with pickle, and visualize amplitudes/phases with built-in plotting tools
  • Call hyperfit polynomials to approximate QNM amplitudes in the ringdown of binary black hole (BBH) mergers

Installation

pip install jaxqualin

Usage

Basic usage examples can be found under the Examples tab on the package homepage.

Paper Results

Interactive plots of the methods paper results can be found under the Results tab on the package homepage.

How to Cite

Please cite the methods paper if you used our package to produce results in your publication. Here is the BibTeX entry:

@article{Cheung:2023vki,
    author = "Cheung, Mark Ho-Yeuk and Berti, Emanuele and Baibhav, Vishal and Cotesta, Roberto",
    title = "{Extracting linear and nonlinear quasinormal modes from black hole merger simulations}",
    eprint = "2310.04489",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    doi = "10.1103/PhysRevD.109.044069",
    journal = "Phys. Rev. D",
    volume = "109",
    number = "4",
    pages = "044069",
    year = "2024",
    note = "[Erratum: Phys.Rev.D 110, 049902 (2024), Erratum: Phys.Rev.D 112, 049901 (2025)]"
}

License

MIT


GitHub @mhycheung

Metadata

Release files for jaxqualin 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 jaxqualin 1.0.0
File Size Uploaded Provenance
jaxqualin-1.0.0.tar.gz 18.5 MB Without provenance Details

Built distribution (wheel)

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

Total release size: 18.5 MB

Release files / jaxqualin-1.0.0.tar.gz

Download URL jaxqualin-1.0.0.tar.gz
Size 18.5 MB
Tags Source
SHA-256 checksum
How to use checksums
d2217802781caf8b8324f7e76dcc8ace572c36e980369ed0c31f72dd7cb06b93
BLAKE2b-256 checksum
How to use checksums
4f9544930897e121458ccecbbcb6b27e872c4c136661c6378d12eda11d124d57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / jaxqualin-1.0.0-py3-none-any.whl

Download URL jaxqualin-1.0.0-py3-none-any.whl
Size 62.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
115034c5147c24fdd1bbf5f07b0fa83effb987d7c48d4af5b2c543a93043b8f4
BLAKE2b-256 checksum
How to use checksums
492ed16f1d6b9135d52efcd9a62ec0eaa7d78f69e567295335d8a54c87b415c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for jaxqualin 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