********************
ClEvaR Documentation
********************

The Cluster Evaluation Resources (ClEvaR) is a Python library
to validate cluster detection from catalog comparisons.
Its main goal is to provide a framework for easy matching of catalogs,
and compute the main metrics and scaling relations.
This library has been developed in the LSST context,
to be used on the current simulations and on the upcoming cluster detections,
but can also be used with any set of catalogs.


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


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

   source/overview
   source/installation
   source/citing


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

   compiled-examples/catalogs.rst
   compiled-examples/proximity_matching.rst
   compiled-examples/proximity_matching_detailed.rst
   compiled-examples/membership_matching.rst
   compiled-examples/membership_matching_detailed.rst
   compiled-examples/match_metrics.rst
   compiled-examples/match_metrics_advanced.rst
   compiled-examples/footprint.rst
   compiled-examples/intrinsic_completeness.rst
.. toctree::
   :maxdepth: 1
   :caption: Mass Fitting Examples


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

   api