Gremlin is a toolkit for studying solutions to the Teukolsky equation using a point-particle source. GremlinEq is a version of Gremlin that specializes the source to circular and equatorial orbits of Kerr black holes. The full Gremlin package will be released publicly via the Black Hole Perturbation Toolkit; certain proprietary libraries that were used in its development must be cleaned up and replaced with Open Source resources. GremlinEq has been so cleaned, and is hereby provided as an initial release.
GremlinEq depends upon:
- The GNU Scientific Library (GSL) version >= 2.5
- The GNU Multiple Precision Arithmetic Library (GMP)
- The Fastest Fourier Transform in the West
- The Hierarchical Data Format
If you are on a Mac these are can be easily installed using Brew. On Linux the package manager should be able to install them. To install on Windows it is recommended to use the Windows Subsystem for Linux. Further instructions can be found in the Install-Windows.md file in the /doc folder.
To compile GremlinEq you will need:
- a C++ compiler (we have tested it with g++)
- Make
Once you have compiled GremlinEq the binaries are placed in the bin/ folder. The main binary is 'Circ_Eq'. This will output an HDF5 file which contains information about the computed mode. Many other binaries are provided which provide additional functions -- see the documentation for details.
Initial documentation can be found in doc/doc.pdf
Doxygen documentation is automatically re-generated with each commit and can be found at: http://bhptoolkit.org/GremlinEq/doc/. You can also generate the documentation locally by running doxygen in the root folder.
Scott Hughes