Get started

The Toolkit is many independent packages. Install only the ones you need — each tool's own page has the full detail. Here's the fast path for each ecosystem.

Python

Most Python packages are on PyPI and install with pip:

pip install fastemriwaveforms
pip install qnm
pip install kerrgeopy

For SageMath packages, use Sage’s bundled pip:

sage -pip install kerrgeodesic_gw

GPU-accelerated packages such as fastemriwaveforms have additional CUDA requirements — see the package page for the matching build.

Mathematica

Mathematica packages are distributed as paclets. Once you’ve added the BHPToolkit paclet server, install any package by name:

PacletInstall["Teukolsky"]
PacletInstall["KerrGeodesics"]
PacletInstall["SpinWeightedSpheroidalHarmonics"]

We recommend the released paclets over the development versions, which can be unstable while changes are being made. Full setup instructions, including adding the paclet server, are on the Mathematica install guide.

C / C++

C and C++ tools build from source and document their dependencies in each repository’s README. The typical pattern:

git clone https://github.com/BlackHolePerturbationToolkit/GremlinEq
cd GremlinEq
# follow the README for dependencies and the build step

Fortran

Fortran packages such as SelfForce-1D ship with build instructions in their repositories. Check the README for the required compiler and libraries.

Tip. Prefer released versions where they exist. The development branch is where active work happens and may break between commits.

Next steps

Browse the full catalogue to find the right package
Read the documentation for tutorials and conventions
See how to cite the Toolkit in your work