The full cluster-lensing documentation is here.

###Installation cluster-lensing is a pure Python package that can be installed by running:

$ pip install cluster-lensing

This package runs on Python 2.7, and its dependencies include numpy, scipy, astropy, and pandas.

cluster-lensing is a Python project for calculating a variety of galaxy cluster properties, as well as mass-richness and mass-concentration scaling relations, and weak lensing profiles. These include surface mass density (Sigma) and differential surface mass density (DeltaSigma) for NFW halos, both with and without the effects of cluster miscentering.

The focus of this project is the ClusterEnsemble() class in clusters.py. See a demo of what it can do in the provided notebook: demo.ipynb.

ClusterEnsemble() allows you to easily build up a nicely formatted table (a pandas dataframe) of cluster attributes, and automatically generates parameters that depend on each other. It uses a customizable powerlaw mass-richness scaling relation to convert between richness N₂₀₀ and mass M₂₀₀, and to generate other parameters. Other customizeable options include specifications of the cosmology and a choice of several concentration-mass relationships from the literature.

The ClusterEnsemble.calc_nfw() method provides simplified access to the SurfaceMassDensity() class in nfw.py. The latter calculates the NFW halo profiles for Sigma(r) and DeltaSigma(r), which are useful for fitting weak lensing shear or magnification profiles. Optionally, it will calculate the miscentered profiles, given an offset parameter describing the width of the 2D Gaussian miscentering offset distribution. See, for example, Ford et al. 2015, for the miscentering formalism, and an example use case. All of the code you see in this repository (as well as the repositories linked below) is a cleaned up version of the same code used for that CFHTLenS cluster shear paper, as well as for our previous cluster magnification paper.

This project has inherited code from the cofm repository for concentration-mass relationships and the smd-nfw repository for calculating NFW halo profiles.