.. _function_usage_examples:

****************************************
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 :ref:`complete_reference_api`.

Modeling the Galaxy-Halo Connection
=====================================

Composite models
------------------

HOD models
~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/zheng07_composite_model
   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/leauthaud11_composite_model
   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/tinker13_composite_model
   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/hearin15_composite_model
   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/zu_mandelbaum15_composite_model
   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/zu_mandelbaum16_composite_model

CLF models
~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/cacciato09_composite_model

Subhalo-based models
~~~~~~~~~~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   ../quickstart_and_tutorials/tutorials/model_building/preloaded_models/behroozi10_composite_model
   abundance_matching

Component models
------------------

.. toctree::
   :maxdepth: 2

   phase_space_models_functions
   hod_occupation_functions
   empirical_model_factory_functions

Making Mock Observations
===========================

.. toctree::
   :maxdepth: 1

   mock_observables_functions

Processing Simulation Data
=============================

.. toctree::
   :maxdepth: 1

   processing_simulation_data

Utility Functions
=============================

.. toctree::
   :maxdepth: 1

   utility_functions