Installation

From source

git clone https://github.com/tousifislam/gwGenealogy.git
cd gwGenealogy
pip install -e .

Dependencies

Required:

Optional:

  • surfinBH — NR surrogate remnant models (NRSur7dq4Remnant, NRSur3dq8Remnant, NRSur7dq4EmriRemnant)

Building the documentation

pip install sphinx sphinx-rtd-theme nbsphinx
cd docs
make html

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