Commit 95b60904 authored by Daniel Williams's avatar Daniel Williams 🤖
Browse files

Small tidy-up of docs.

parent e717a83f
Pipeline #130253 failed with stages
in 24 seconds
......@@ -88,14 +88,14 @@ This section has a brief overview of the models which are implemented in the pac
``HeronHODLR``
--------------
+---------------+-----------------------+------------+----------+--------------+
| Training data | GPR Technique | Model type | Spinning | Higher modes |
+==================+====================+============+==========+==============+
| NR: Georgia Tech | HODLR, Approximate | BBH | Fully | No |
+------------------+--------------------+------------+----------+--------------+
+------------------+-----------------------+------------+----------+--------------+
| Training data | GPR Technique | Model type | Spinning | Higher modes |
+==================+=======================+============+==========+==============+
| NR: Georgia Tech | HODLR, Approximate | BBH | Fully | No |
+------------------+-----------------------+------------+----------+--------------+
The HODLR model was the first fully-functioning binary black hole waveform model to be produced by the ``heron`` project, and it remains the recommended one to be used in further investigations at present.
The model is trained on `numerical relativity waveforms <http://www.einstein.gatech.edu/catalog/>`_ produced by the Centre for Relativistic Astrophysics at Georgia Tech, and uses a `HODLR inversion technique <http://arxiv.org/abs/1403.6015>`_ to make the Gaussian Process tractable for a large amount of data. The underlying package generating the GPR is ```george <https://george.readthedocs.io/en/latest/`_``.
The model is trained on `numerical relativity waveforms <http://www.einstein.gatech.edu/catalog/>`_ produced by the Centre for Relativistic Astrophysics at Georgia Tech, and uses a `HODLR inversion technique <http://arxiv.org/abs/1403.6015>`_ to make the Gaussian Process tractable for a large amount of data. The underlying package generating the GPR is `george <https://george.readthedocs.io/en/latest/`_.
-------------------
Citing this package
......
......@@ -22,14 +22,15 @@ This version of heron is implemented slightly differently to older versions, and
usage
api
Tutorials
=========
Tutorials and Examples
======================
.. toctree::
:maxdepth: 2
:caption: Tutorials
usage
theory
Pre-supplied Models
===================
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment