Installation

From PyPI

pip install gw_remnant

With optional waveform surrogates:

pip install gw_remnant[surrogates]

With numerical relativity catalog access:

pip install gw_remnant[nr]

With effective-one-body waveforms:

pip install gw_remnant[eob]

Install everything:

pip install gw_remnant[all]

From source (development)

git clone https://github.com/tousifislam/gw_remnant.git
cd gw_remnant
pip install -e .[dev]

Dependencies

The following packages are required and will be installed automatically:

• numpy >= 1.20.0

• scipy >= 1.7.0

• matplotlib >= 3.3.0

• gwtools

Optional dependencies:

Install option	Packages	Purpose
[surrogates]	gwsurrogate, surfinBH	Waveform surrogate models and remnant fits
[nr]	sxs, mayawaves	Numerical relativity catalog access
[eob]	pyseobnr	Effective-one-body waveforms
[all]	All of the above	All non-dev optional dependencies

Building the documentation

To build the documentation locally:

pip install gw_remnant[docs]
cd docs
make html

The built documentation will be in docs/_build/html/.