API
===

You may find more practical guidance in example notebooks: :root:`nb`.

High-level correlation function interface
-----------------------------------------

.. automodule:: pycorr.correlation_function
  :members:
  :inherited-members:
  :show-inheritance:

Correlation function estimators
-------------------------------

.. automodule:: pycorr.twopoint_estimator
  :members:
  :inherited-members:
  :show-inheritance:

Base two-point counter class
----------------------------

.. automodule:: pycorr.twopoint_counter
  :members:
  :inherited-members:
  :show-inheritance:

Jackknife two-point counter class
---------------------------------

.. automodule:: pycorr.twopoint_jackknife
  :members:
  :inherited-members:
  :show-inheritance:

Corrfunc two-point counter
--------------------------

.. automodule:: pycorr.corrfunc
  :members:
  :inherited-members:
  :show-inheritance:

Utilities
---------

.. automodule:: pycorr.utils
  :members:
  :inherited-members:
  :show-inheritance:

MPI
---

.. automodule:: pycorr.mpi
  :members:
  :inherited-members:
  :show-inheritance: