******************
CLMM Documentation
******************

The LSST-DESC Cluster Lensing Mass Modeling (CLMM) code is a Python
library for performing galaxy cluster weak lensing analyses. clmm is
associated with Key Tasks DC1 SW+RQ and DC2 SW of the LSST-DESC
`Science Roadmap
<https://lsstdesc.org/sites/default/files/DESC_SRM_V1_4.pdf>`_
pertaining to absolute and relative mass calibration. 


The source code is publically available at https://github.com/LSSTDESC/CLMM


.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   source/overview
   source/installation
   source/citing


.. toctree::
   :maxdepth: 1
   :caption: Usage Demos

   compiled-examples/demo_mock_cluster.rst
   compiled-examples/demo_dataops_functionality.rst
   compiled-examples/demo_theory_functionality.rst
   compiled-examples/demo_mock_ensemble.rst
   compiled-examples/data_and_model_demo_DC2.rst

.. toctree::
   :maxdepth: 1
   :caption: Mass Fitting Examples

   compiled-examples/Example1_Fit_Halo_Mass_to_Shear_Catalog.rst
   compiled-examples/Example1_Fit_shear_profile_with_miscentering.rst
   compiled-examples/Example2_Fit_Halo_Mass_to_Shear_Catalog.rst
   compiled-examples/Example3_Fit_Halo_Mass_to_Shear_Catalog.rst
   compiled-examples/Example4_Fit_Halo_mass_to_HSC_data.rst
   compiled-examples/Example5_Fit_Halo_mass_to_DES_data.rst

.. toctree::
   :maxdepth: 1
   :caption: Other

   compiled-examples/demo_theory_functionality_diff_z_types.rst
   compiled-examples/demo_theory_functionality_oo.rst
   compiled-examples/demo_boost_factors.rst
   compiled-examples/demo_compute_deltasigma_weights.rst
   compiled-examples/demo_mass_conversion.rst
   compiled-examples/demo_mock_ensemble_realistic.rst

.. toctree::
   :maxdepth: 1
   :caption: Reference

   api