Welcome to orpheus' documentation!
===================================

**Orpheus** is a Python library for an efficient estimation of higher-order correlation 
functions and integrated measures of those.  

.. note::
   This project is under active development.

User Guide
----------
.. toctree::
   :maxdepth: 1
   
   installation
   twopcf
   threepcf
   fourpcf
   direct
   algos
   tutorial
   
API documentation
-----------------
.. toctree::
   :maxdepth: 1
   
   api

Support
-------
In case you encounter any issue with orpheus, please raise an issue on the GitHub page.

Acknowledgement
---------------
As there is currently no dedicated orpheus paper, please cite the paper that introduced the functionality implemented in orpheus:

* If you use the three-point functionality, please cite 
  `Porth+2024 <https://doi.org/10.1051/0004-6361/202347987>`_
* If you use the four-point GGGG functionality, please cite 
  `Porth+2025 <https://arxiv.org/abs/2509.07974>`_ and `Silvestre-Rosello+2025 <https://arxiv.org/abs/2509.07973>`_
* If you use the direct estimator functionality, please cite 
  `Porth & Smith 2022 <https://doi.org/10.1093/mnras/stab2819>`_
* If you use the two-point functionality, please provide a `reference <https://github.com/lporth93/orpheus>`_ to the official GitHub repository in a footnote.

In each of the papers, you can find the main equations implemented in orpheus.

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

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