Metadata-Version: 2.1
Name: phazap
Version: 0.3.2
Summary: Gravitational wave phase reconstruction for low-latency identification of strongly lensed signals
Author: Jose María Ezquiaga
Author-email: jose.ezquiaga@nbi.ku.dk
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bilby
Requires-Dist: bilby-pipe
Requires-Dist: pesummary
Requires-Dist: getdist
Requires-Dist: tqdm
Requires-Dist: configargparse

# phazap

![license](https://img.shields.io/github/license/ezquiaga/phazap)
[![GitHub release](https://img.shields.io/github/v/release/ezquiaga/phazap.svg)](https://github.com/ezquiaga/phazap/releases)
[![Documentation Status](https://readthedocs.org/projects/phazap/badge/?version=latest)](https://phazap.readthedocs.io/en/latest/?badge=latest)

Phazap is a package to efficiently post-process gravitational-wave (GW) parameter estimation data to obtain the phases and polarization state of the signal at a given detector and frequency. Details on the method are presented in [Ezquiaga, Hu, Lo (2023)](https://arxiv.org/abs/2308.06616). The key module is `phazap.py`.

This code is used for low-latency identification of strongly lensed gravitational waves via their phase consistency by measuring their distance in the detector phase space. The relevant module including the distance statistic is `tension_utils.py`.

Phazap builds on top of the IGWN conda enviroment https://computing.docs.ligo.org/conda/environments/igwn/ which include the standard GW packages such as LALSuite and bilby.

## Installation
There are two ways to install the package, either
### from pypi
```bash
$ pip install phazap
```

### from source
```bash
$ git clone https://github.com/ezquiaga/phazap.git
$ cd phazap
$ pip install .
```
### Quick-start
Refer to the [documentation](https://phazap.readthedocs.io/en/latest/examples.html) for two illustrative examples
