CLMM

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 pertaining to absolute and relative mass calibration. CLMM is descended from clmassmod but distinguished by its modular structure and scope, which encompasses both simulated data sets with a known truth and observed data from which we aim to discover the truth. The documentation of the code can be found here.

Table of contents

1. Requirements
2. Installation
3. Overview
4. Contributing

Requirements

CLMM requires Python version 3.6 or later. To run the code, there are 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)

• cluster-toolkit (for halo functionality)

All but cluster-toolkit are pip installable:

  pip install numpy scipy astropy matplotlib

Ultimately, CLMM will depend on CCL, but until cluster_toolkit is incorporated into CCL, we have an explicit dependency. cluster_toolkit's installation instructions can be found here. Note: While cluster-toolkit mentions the potential need to install CAMB/CLASS for all cluster-toolkit functionality, you do not need to install these to run CLMM.

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 CLMM you currently need to build it from source:

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

To run the tests you can do:

pytest

Overview

Overview of the code can be found here

Contributing

Contributing documentation can be found here