Metadata-Version: 2.1
Name: gwmemory
Version: 1.1.0
Summary: Calculate the gravitational-wave memory for arbitrary time series
Author-email: Colm Talbot <colm.talbot@ligo.org>
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: sympy
Provides-Extra: dev
Requires-Dist: numba ; extra == 'dev'

[![PyPI version](https://badge.fury.io/py/gwmemory.svg)](https://badge.fury.io/py/gwmemory)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/gwmemory.svg)](https://anaconda.org/conda-forge/gwmemory)
[![codecov](https://codecov.io/github/ColmTalbot/gwmemory/branch/master/graph/badge.svg?token=QAASCHZ7QI)](https://codecov.io/github/ColmTalbot/gwmemory)

# `GWMemory`

`GWMemory` calculates the nonlinear (Christodoulou) gravitational-wave memory waveform from arbitrary time-domain gravitational-waveforms.

## Installation

`GWMemory` is available via `conda-forge` and `pypi`

```console
$ conda install -c conda-forge gwmemory
$ python -m pip install gwmemory
```

You can also install from this repository in the usual way:

```console
$ git clone https://github.com/ColmTalbot/gwmemory.git
$ cd gwmemory
$ python -m pip install .
```

Note that it is no longer to install using
```bash
$ python setup.py install
```
The `pip` version is more stable.

**TODO: make pip/conda installable**

## Examples

Demonstrations of how to calculate memory waveforms can be found in the examples directory.

## Supported waveforms

- [NRSur7dq2](https://zenodo.org/record/1215824#.WzcMDuiFPEY) (Blackman _et al._ (2017), [Phys. Rev. D 96, 024058](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.96.024058))
- Aligned spin waveforms in [`lalsimulation`](http://git.ligo.org/lscsoft/lalsuite), e.g., `IMRPhenomD` ( Khan _et al._ (2016), [Phys. Rev. D 93, 044007](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.93.044007), `SEOBNRv4` (Bohe _et al._ (2017), [Phys. Rev. D 95, 044028](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.95.044028)).
- Minimal waveform model (Favata (2010), [CQG, 27, 8](http://iopscience.iop.org/article/10.1088/0264-9381/27/8/084036/meta))
- Any surrogate model available in `gwsurrogate`

To use these waveform models, you may need to install extra packages, this should be described if the packages aren't available.

Additionally users can supply any waveform decomposed onto the basis of spin-2 weighted spherical harmonics.

There is basic support for loading numerical relativity waveforms, based on the format of the simulating extreme spacetimes [waveform catalog](https://www.black-holes.org/for-researchers/waveform-catalog).
