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

• Installation
• Two-point Correlation Functions
• Three-point Correlation Functions
• Four-point Correlation Functions
• Direct estimator of aperture mass cumulants
• How orpheus works
• Tutorial

API documentation

• orpheus

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

• If you use the four-point GGGG functionality, please cite Porth+2025 and Silvestre-Rosello+2025

• If you use the direct estimator functionality, please cite Porth & Smith 2022

• If you use the two-point functionality, please provide a reference 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

• Index

• Module Index

• Search Page