Skip to content

Code to create gravitational-wave memory waveforms

License

Notifications You must be signed in to change notification settings

ColmTalbot/gwmemory

Repository files navigation

PyPI version Conda Version codecov

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

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

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

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

Examples

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

Supported waveforms

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.