Skip to content

JohanComparat/sum_stat

Repository files navigation

sum_stat

PyPI version License: MIT Python 3.11+ CI codecov Documentation

Python wrapper package for measuring cosmological summary statistics from galaxy catalogues and lensing data. Careful, this is an early version, use at own risk !

Stable estimators

  • Stellar mass function
  • Angular correlation function
  • Projected correlation function
  • Excess surface density (galaxy-galaxy lensing)

Installation

pip install sum-stat

See pypi.org/project/sum-stat for details.

Citation

If you use sum_stat in your research, please cite it as:

@software{comparat2026sumstat,
  author  = {Comparat, Johan},
  title   = {{sum\_stat}: Cosmological summary statistics from galaxy catalogues and lensing data}, 
  year    = {2026},
  version = {0.2.0},
  url     = {https://github.com/JohanComparat/sum_stat},
  license = {MIT},
}

A CITATION.cff file is also provided for automated citation tools (GitHub "Cite this repository" button).

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for development setup, coding conventions, and how to submit a pull request.

License

MIT — see LICENSE.

Package structure

sum_stat/
├── sum_stat/
│   ├── catalogue.py       # GalaxyCatalogue, ShapeCatalogue, PhotoZCalibTable
│   ├── cosmology.py       # JAX-differentiable distances and Σ_crit
│   ├── covariance/        # jackknife_covariance, bootstrap_covariance
│   ├── io/                # SummaryStatWriter, SummaryStatReader
│   ├── lensing/           # delta_sigma
│   ├── lf_smf/            # 1/Vmax, SWML, C⁻, EP τ, Rauzy
│   ├── nz/                # nz_histogram, nz_kde
│   ├── powspec/           # cl_angular, pk3d, pk_multipoles  [development]
│   └── twopcf/            # w_theta, wp, xi_r, xi_multipoles
├── tests/
├── docs/
├── environment.yml
└── pyproject.toml

About

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors