Python Documentation
====================

.. toctree::
   :maxdepth: 2

Top-level modules
-----------------

`boxes` module
^^^^^^^^^^^^^^

.. automodule:: scampy.boxes
   :members:

`catalogue` module
^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.catalogue
   :members:

`hod` module
^^^^^^^^^^^^

.. automodule:: scampy.hod
   :members:

`lightcone` module
^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.lightcone
   :members:

`power_spectrum` module
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.power_spectrum
   :members:

`sham` module
^^^^^^^^^^^^^

.. automodule:: scampy.sham
   :members:

`cosmology` extension module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.cosmology
   :members:

`halo` subpackage
-----------------

`halo.mass_function` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.halo.mass_function
   :members:

`halo.bias` module
^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.halo.bias
   :members:

`halo.density_profile` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.halo.density_profile
   :members:

`halo.model` module
^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.halo.model
   :members:

`io` subpackage
---------------

`io.hdf5` module
^^^^^^^^^^^^^^^^

.. automodule:: scampy.io.hdf5
   :members:

`io.subfind_table` module
^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.io.subfind_table
   :members:

`measure` subpackage
--------------------

`measure.abundances` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.measure.abundances
   :members:

`measure.clustering` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.measure.clustering
   :members:

`measure.clustering_core` extension module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.measure.clustering_core
   :members:

`utilities` subpackage
----------------------

`utilities.base_classes` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.utilities.base_classes
   :members:

`utilities.functions` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.utilities.functions
   :members:

`utilities.fft` module
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.utilities.fft
   :members:

`utilities.constants` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.utilities.constants
   :members:

`utilities.interpolation` extension module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: scampy.utilities.interpolation
   :members: