Metadata-Version: 2.4
Name: gw_remnant
Version: 0.3.0
Summary: Python package to extract remnant black hole properties from gravitational waveforms
Home-page: https://github.com/tousifislam/gw_remnant
Author: Scott Field, Gaurav Khanna
Author-email: Tousif Islam <tousifislam24@gmail.com>
Maintainer: Tousif Islam
Maintainer-email: Tousif Islam <tousifislam24@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/tousifislam/gw_remnant
Project-URL: Bug Reports, https://github.com/tousifislam/gw_remnant/issues
Project-URL: Source, https://github.com/tousifislam/gw_remnant
Project-URL: Documentation, https://tousifislam.github.io/gw_remnant/
Keywords: gravitational waves,black holes,numerical relativity,remnant properties
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.20.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: matplotlib>=3.3.0
Requires-Dist: gwtools
Provides-Extra: surrogates
Requires-Dist: gwsurrogate; extra == "surrogates"
Requires-Dist: surfinBH; extra == "surrogates"
Provides-Extra: lal
Requires-Dist: lal; extra == "lal"
Requires-Dist: lalsimulation; extra == "lal"
Provides-Extra: all
Requires-Dist: gwsurrogate; extra == "all"
Requires-Dist: surfinBH; extra == "all"
Requires-Dist: lal; extra == "all"
Requires-Dist: lalsimulation; extra == "all"
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: ipython; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.24; extra == "docs"
Requires-Dist: nbsphinx>=0.9; extra == "docs"
Requires-Dist: pandoc; extra == "docs"
Requires-Dist: ipykernel; extra == "docs"
Dynamic: home-page
Dynamic: license-file
Dynamic: maintainer
Dynamic: requires-python

# gw_remnant

[![Documentation](https://img.shields.io/badge/docs-online-blue)](https://tousifislam.github.io/gw_remnant/)
[![PyPI](https://img.shields.io/pypi/v/gw-remnant)](https://pypi.org/project/gw-remnant/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

During binary-black-hole (BBH) mergers, energy and momenta are carried away from the binary system as gravitational radiation. Access to the radiated energy and momenta allows us to accurately predict the properties of the remnant black hole.

`gw_remnant` is an easy-to-use Python package to efficiently extract the remnant mass, remnant spin, peak luminosity and the final kick imparted on the remnant black hole directly from the gravitational radiation.

**Documentation:** https://tousifislam.github.io/gw_remnant/

## Installation

Install from PyPI:
```bash
pip install gw_remnant
```

Install with optional dependencies for waveform surrogates:
```bash
pip install gw_remnant[surrogates]
```

Install from source (development):
```bash
git clone https://github.com/tousifislam/gw_remnant.git
cd gw_remnant
pip install -e .[dev]
```

### Requirements

- Python >= 3.8
- numpy >= 1.20.0
- scipy >= 1.7.0
- matplotlib >= 3.3.0
- gwtools
- lal, lalsimulation (optional, for kick velocity in km/s)

## Quick Start

```python
import numpy as np
from gw_remnant.gw_remnant_calculator import GWRemnantCalculator

# Provide time array and waveform modes (e.g. from a surrogate model)
# time: 1D array in geometric units (M)
# hdict: dictionary of complex waveform modes, e.g. {(2,2): h22(t), ...}
calc = GWRemnantCalculator(time, hdict, qinput=2.0,
                           spin1_input=[0, 0, 0.5])

# Print summary
calc.print_remnants()

# Access individual properties
props = calc.get_remnant_properties()
print(f"Remnant mass: {props['remnant_mass']:.6f} M")
print(f"Remnant spin: {props['remnant_spin']:.6f}")

# Plot diagnostics (optionally save to file)
calc.plot_mass_energy(save_path='mass_energy.png')
```

See the [Quick Start guide](https://tousifislam.github.io/gw_remnant/quickstart.html) for more details.

## Supported Waveform Models

The package includes built-in waveform generators for `NRHybSur3dq8`, `BHPTNRSur1dq1e4`, and `BHPTNRSur2dq1e3`. It can also accept waveforms generated by any other method — see [Providing Waveform Data](https://tousifislam.github.io/gw_remnant/user_guide/waveform_input.html).

## Tutorials

Example notebooks are provided in the [`tutorials/`](tutorials/) directory:

- [Example with custom waveforms](tutorials/example_with_customized_waveform.ipynb) — no surrogate installation required
- [Example with default waveforms](tutorials/example_with_default_waveforms.ipynb) — uses BHPTNRSur1dq1e4 and NRHybSur3dq8

These are also rendered in the [online documentation](https://tousifislam.github.io/gw_remnant/tutorials/index.html).

## Repository Structure
```
gw_remnant/
├── gw_remnant/                        # Main package directory
│   ├── __init__.py                    # Package initialization
│   ├── gw_remnant_calculator.py       # Main calculator class
│   ├── gw_waveform_generator.py       # Waveform generation utilities
│   │
│   ├── gw_utils/                      # Utility functions
│   │   ├── __init__.py
│   │   ├── waveform_generator.py      # Waveform generation helpers
│   │   └── gw_plotter.py              # Plotting utilities
│   │
│   └── remnant_calculators/           # Remnant property calculators
│       ├── __init__.py
│       ├── remnant_mass_calculator.py
│       ├── remnant_spin_calculator.py
│       ├── kick_velocity_calculator.py
│       ├── peak_luminosity_calculator.py
│       └── initial_energy_momenta.py
│
├── docs/                              # Sphinx documentation source
├── tutorials/                         # Example notebooks and tutorials
├── tests/                             # Unit tests
├── pyproject.toml                     # Packaging configuration
├── README.md                          # This file
├── LICENSE                            # License information
└── .gitignore                         # Git ignore rules
```

## BHPTNRremnant

`gw_remnant` has been used in developing an NR-tuned perturbation-based remnant model that provides faithful estimates of the remnant properties for binaries with mass ratios ranging from `q=3` to `q=1000`.

## Citation

If you make use of any module from the Toolkit in your research please acknowledge using:

> This work makes use of the Black Hole Perturbation Toolkit.

If you make use of the `gw_remnant` package or `BHPTNRremnant` surrogate models please cite the following paper:

```bibtex
@article{Islam:2022laz,
    author = "Islam, Tousif and Field, Scott E. and Khanna, Gaurav.",
    title = "{Remnant black hole properties from numerical-relativity-informed perturbation theory and implications for waveform modelling}",
    eprint = "https://arxiv.org/abs/2301.07215",
    archivePrefix = "arXiv",
    primaryClass = "gr-qc",
    month = "1",
    year = "2023"
}
```
