Skip to main content

A package for extracting quasinormal modes from time domain data

Project description

jaxqualin

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

doc

Key FeaturesInstallationUsagePaper ResultsHow to CiteLicense

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

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

jaxqualin-1.0.0.tar.gz (18.5 MB view details)

Uploaded Source

Built Distribution

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

jaxqualin-1.0.0-py3-none-any.whl (62.5 kB view details)

Uploaded Python 3

File details

Details for the file jaxqualin-1.0.0.tar.gz.

File metadata

  • Download URL: jaxqualin-1.0.0.tar.gz
  • Upload date:
  • Size: 18.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jaxqualin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 d2217802781caf8b8324f7e76dcc8ace572c36e980369ed0c31f72dd7cb06b93
MD5 d49e3c10dfd9479f5763d18f74d6b181
BLAKE2b-256 4f9544930897e121458ccecbbcb6b27e872c4c136661c6378d12eda11d124d57

See more details on using hashes here.

File details

Details for the file jaxqualin-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: jaxqualin-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 62.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jaxqualin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 115034c5147c24fdd1bbf5f07b0fa83effb987d7c48d4af5b2c543a93043b8f4
MD5 1aafd2689828d030c558bb430bdb78c1
BLAKE2b-256 492ed16f1d6b9135d52efcd9a62ec0eaa7d78f69e567295335d8a54c87b415c5

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