Cluster Evaluation Resources (ClEvaR)

Library to validate cluster detection. A detailed documentation of the code can be found at https://lsstdesc.org/clevar.

Contriutors

• Michel Aguena (LAPP / LIneA)

Table of contents

1. Requirements
2. Installation
3. Running ClEvaR
4. Contributing
5. Contact

Requirements

ClEvaR requires Python version 3.6 or later. ClEvaR has the following dependencies:

• NumPy (1.17 or later)
• SciPy (1.3 or later)
• Astropy (3.x or later for units and cosmology dependence)
• Matplotlib (for plotting and going through tutorials)
• Healpy (1.14 or later for footprint computations)

  pip install numpy scipy astropy matplotlib healpy

(See the INSTALL documentation for more detailed installation instructions.)

For developers, you will also need to install:

• pytest (3.x or later for testing)
• Sphinx (for documentation)

These are also pip installable:

  pip install pytest sphinx sphinx_rtd_theme

Note, the last item, sphinx_rtd_theme is to make the docs.

Installation

To install ClEvaR you currently need to build it from source:

  git clone https://github.com/LSSTDESC/clevar.git
  cd clevar
  python setup.py install --user   # Add --user flag to install it locally

See the INSTALL documentation for more detailed installation instructions.

To run the tests you can do:

pytest

Running ClEvaR

ClEvaR can be imported as a python library or as an executable based on configuration yaml files. Check detailed description of each usage below:

• ClEvaR library
• ClEvaR executables

Contributing

Contributing documentation can be found here

Contact

If you have comments, questions, or feedback, please write us an issue.