.. title:: HorizonGRound Documentation

========================================================
**Relativistic Effects in Ultra-Large-Scale Clustering**
========================================================

.. image:: https://img.shields.io/badge/arXiv-2007.01802-important
    :target: https://arxiv.org/abs/2007.01802
    :alt: arXiv eprint
.. image:: https://img.shields.io/github/v/release/MikeSWang/HorizonGRound?label=release
    :target: https://github.com/MikeSWang/HorizonGRound/releases/latest
    :alt: GitHub release (latest by date)
.. image:: https://readthedocs.org/projects/horizonground/badge/?version=latest
    :target: https://horizonground.readthedocs.io/en/latest
    :alt: Documentation status
.. image:: https://travis-ci.com/MikeSWang/HorizonGRound.svg?branch=master
    :target: https://travis-ci.com/MikeSWang/HorizonGRound
    :alt: Build status
.. image:: https://img.shields.io/codecov/c/github/MikeSWang/HorizonGRound
    :target: https://codecov.io/gh/MikeSWang/HorizonGRound
    :alt: Coverage
.. image:: https://img.shields.io/badge/licence-GPLv3-informational
    :target: https://github.com/mikeswang/HorizonGRound/tree/master/LICENCE
    :alt: Licence

|HorizonGRound| is a Python package that offers tools for forward modelling of
general relativistic effects from the tracer luminosity function as well as
comparing relativistic corrections with the local primordial non-Gaussianity
signature in ultra-large-scale clustering statistics.

.. |HorizonGRound| raw:: html

    <span style="font-variant: small-caps">HorizonGRound</span>


Installation
============

To install, enter in bash::

    pip install HorizonGRound


Where to start
==============

- :doc:`quick_recipes` for ready-made recipes
- :doc:`apidoc` for more detailed documentation of classes and functions


Attribution
===========

If you would like to acknowledge this work, please cite
`Wang, Beutler & Bacon (2020) <https://arxiv.org/abs/2007.01802>`_. You
may use the following BibTeX record::

    @article{Wang_2020a,
        author = {Wang, M.~S. and Beutler, F. and Bacon, D.},
        title = {%
            Impact of relativistic effects on the primordial {non-Gaussianity} %
            signature in the large-scale clustering of quasars%
        },
        year = {2020},
        archivePrefix = {arXiv},
        primaryClass = {astro-ph.CO},
        eprint = {2007.01802},
    }


Licence
=======

|HorizonGRound| is made freely available under the `GPL v3.0
<https://www.gnu.org/licenses/gpl-3.0.en.html>`_ licence.


.. toctree::
    :hidden:

    quick_recipes
    apidoc