corfu 0.1.1

projected angular correlation functions

corfu

The corfu library computes exact equal-time or unequal-time angular correlation functions and power spectra by projecting three-dimensional correlation functions or power spectra onto the sphere in real space.

Maintainers:

Nicolas Tessore, Lucia F. de la Bella

Getting Started

Please refer to the documentation, where you can find

• the theory behind the corfu package,

• results to demonstrate that the package works as intended,

• an explanation of how to use the package, and

• the function reference.

Installation

The easiest way to install the corfu module is via pip:

$ pip install corfu

You can install the corfu module from a local working directory, such as a repository clone:

$ cd corfu
$ ls
corfu.py    setup.py    ...
$ pip install .

Alternative, the corfu.py file is self-contained and can be copied to where it is required:

$ cd myproject
$ cp ../corfu/corfu.py .
$ python
>>> import corfu  # works

Usage

To project 3d (matter) correlation functions or power spectra along lines of sight and obtain angular correlation functions or angular power spectra:

• Use the corfu.ptoxi() function to obtain the 3d (matter) correlation function from the 3d (matter) power spectrum.

• Use the corfu.uneqt() function to obtain the projected angular correlation function from the 3d (matter) correlation function.

• Use the corfu.wtocl() function to obtain the angular power spectrum from the angular correlation function.

For further guidance, see the documentation, and in particular the usage page. For an explanation of how the computation works, see the theory page.