Function-usage examples by category

Here we present docstrings of the most commonly used functions and classes grouped together by functionality. Many docstrings contain example code to demonstrate basic usage. For documentation of functions not listed here, see Comprehensive Corrfunc Reference/API.

Clustering statistics on a Simulation

Clustering statistics For Mocks

Utilities

Reading input data

Creating a file with bins for the clustering statistics