Metadata-Version: 2.3
Name: jaxqualin
Version: 0.0.5
Summary: A package for extracting quasinormal modes from time domain data
Project-URL: Homepage, https://github.com/mhycheung/Jaxqualin
Project-URL: Bug Tracker, https://github.com/mhycheung/Jaxqualin/issues
Author-email: Mark Ho-Yeuk Cheung <hcheung5@jhu.edu>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: <3.12,>=3.8
Requires-Dist: adjusttext==0.8
Requires-Dist: jax<=0.4.20,>0.3.23
Requires-Dist: jaxfit==0.0.3
Requires-Dist: jaxlib<=0.4.20,>0.3.23
Requires-Dist: matplotlib>3.6.1
Requires-Dist: numpy>1.23
Requires-Dist: pandas>1.5.1
Requires-Dist: pykerr==0.1.0
Requires-Dist: qnm==0.4.3
Requires-Dist: scipy<1.13.0,>1.9.3
Requires-Dist: sxs>2022.4.5
Requires-Dist: tqdm>4.61.1
Provides-Extra: pycbc
Requires-Dist: pycbc>2.0.6; extra == 'pycbc'
Description-Content-Type: text/markdown

<h1 align="center">
    <img src="docs/jaxqualin_logo.png" alt="jaxqualin" width="500">
</h1>

<h4 align="center"> A python package for extracting quasinormal modes from black-hole ringdown simulations.</h4>

<p align="center">
    <a href = "https://arxiv.org/abs/2310.04489"><img src="https://img.shields.io/badge/arXiv-2310.04489-b31b1b.svg"></a>
    <a href="https://badge.fury.io/py/jaxqualin"><img src="https://badge.fury.io/py/jaxqualin.svg"></a>
    <a href="https://github.com/mhycheung/jaxqualin/actions/workflows/pytest.yml"><img src="https://github.com/mhycheung/jaxqualin/actions/workflows/pytest.yml/badge.svg"></a>
    <a href="https://github.com/mhycheung/jaxqualin/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
    <a href="https://mhycheung.github.io/jaxqualin/"><img src="https://badgen.net/badge/Read/the doc/blue" alt="doc"/></a>
    <a href="https://pypi.org/project/jaxqualin/"><img src="https://img.shields.io/pypi/pyversions/jaxqualin"></a>
</p>

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#installation">Installation</a> •
  <a href="#usage">Usage</a> •
  <a href="#paper-results">Paper Results</a> •
  <a href="#coming-soon">Coming Soon</a> •
  <a href="#how-to-cite">How to Cite</a> •
  <a href="#license">License</a> 
</p>

## Key Features

* Fit a ringdown waveform with quasinormal modes (QNMs) of fixed or free frequencies
* Nonlinear least-squares fitting with automatic differentiation via <a href="https://github.com/Dipolar-Quantum-Gases/jaxfit">JaxFit</a>
* Agnostic identification of QNMs within the waveform
* Saving and reusing results with `pickle`
* Easy visualization of results
* Call hyperfit polynomials to approximate QNM amplitudes in the ringdown of binary black hole (BBH) mergers

## Installation

```shell
pip install jaxqualin
```

## Usage

Basic usage examples can be found under the Examples tab on the <a href="https://mhycheung.github.io/jaxqualin/">package homepage</a>.

> **Note**
> We did not extensively test and do not recommend running `jaxqualin` on a GPU

## Paper Results

Interactive plots of the methods paper results can be found under the Results tab on the <a href="https://mhycheung.github.io/jaxqualin/">package homepage</a>.

## Coming Soon

* Full API
* Support for real (Schwarzshild) ringdown waveforms
* Fitting for the mass and spin of the remnant 

## How to Cite
Please cite the methods paper if you used our package to produce results in your publication.
Here is the BibTeX entry:
```
@misc{cheung2023extracting,
      title={Extracting linear and nonlinear quasinormal
      modes from black hole merger simulations}, 
      author={Mark Ho-Yeuk Cheung and Emanuele Berti and 
      Vishal Baibhav and Roberto Cotesta},
      year={2023},
      eprint={2310.04489},
      archivePrefix={arXiv},
      primaryClass={gr-qc}
}
```

## License

MIT

---

> GitHub [@mhycheung](https://github.com/mhycheung)