.. gwaxion documentation master file, created by
   sphinx-quickstart on Thu Jul 14 12:57:21 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

gwaxion
=======

**gwaxion** is a package to facilitate computations related to gravitational waves from ultralight-boson condensates around black holes. The code was primarilty developed in writing arXiv:1810.03812, but it is of broad applicability.

This documentation is being actively developed. Usage examples can be found :doc:`here <gallery>` and API documentation in the :ref:`modindex`.

.. toctree::
   :maxdepth: 2
   :caption: Contents:


   gallery
   modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`