Getting Started

BHPWave is designed to be a simple waveform generator for small bodies undergoing quasi-circular inspirals into rotating massive black holes (MBHs).

Warning

Installation has only been tested on MACOSX (Intel chip) and linux machines. We are working on updating installation instructions for MACOSX (M1 chip) and Windows users.

Installation

BHPWave relies on a few dependencies to install and run, namely a C/C++ compiler (e.g., g++), gsl, Cython, numpy, and python >= 3.7, though we recommend using Python 3.9. To reduce package conflicts and ensure that the proper dependencies are installed, we recommend using Anaconda and its virtual environments.

Create a conda environment bhpwave-env (or whatever name you would like) with the necessary dependencies to install bhpwave. For MACOSX run:

conda create -n bhpwave-env -c conda-forge gsl Cython numpy clang_osx-64 clangxx_osx-64 python=3.9
conda activate bhpwave-env

To instead include the necessary compiler on linux run:

conda create -n bhpwave-env -c conda-forge gsl Cython numpy gcc_linux-64 gxx_linux-64 python=3.9
conda activate bhpwave-env

Next clone the bhpwave repository from GitHub:

git clone https://github.com/znasipak/bhpwave.git
cd bhpwave

Finally, we recommend installing the package via pip:

pip install .

Conda Environments with Jupyter

To run the code in a jupyter notebook, we recommend pip installing the following dependencies:

pip install ipykernel matplotlib

One can then make the environment accessible within jupyter by running

python -m ipykernel install --user --name=bhpwave-env

Uninstalling

If the package is installed using pip, then one can easily uninstall the package using pip as well

pip uninstall bhpwave

To clean the repository, one will also need to remove the directories build and bhpwave.egg-info from the main repository