orpheus-npcf 0.1.0

Compute N-point correlation functions of spin-s fields.

Orpheus is python package for the calculation of second- third- and fourth-order correlation functions of scalar and polar fields such as weak lensing shear. To efficiently perform the calculations, orpheus makes use of a mulitpole decomposition of the N>2 correlation functions and uses parallelized C code for the heavy lifting.

Installation, Documentation and Examples

Installation steps, documentation and examples are provided at orpheus.readthedocs.io.

Installation

First clone the directory via:

git clone [e-mail]:lporth93/orpheus.git

or

git clone https://github.com/lporth/orpheus.git

Then navigate to the cloned directory

cd orpheus
conda env create -f orpheus_env.yaml
conda activate orpheus_env
pip install .

Documentation

In the documentation you find more information about the algorithms and approximation schemes employed in orpheus, as well as a series of jupyter notebooks that give examples of how to use the different estimators implemented in orpheus.

Using the code

As at this moment there is 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 functionality, please cite Porth+2025
• If you use the direct estimator functionality, please cite Porth & Smith 2022

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