sum_stat

Cosmological summary statistics from galaxy catalogues and lensing data.

User Guide

• Overview
  • Estimator maturity
  • Summary statistics
  • One-point statistics — density functions (stable: SMF)
  • Two-point statistics (stable: WPRP, WTHETA, DeltaSigma)
  • Statistics in development
  • JAX design
  • Unit conventions
  • Script organisation
  • Output format
  • Bin specification
• Estimators from discrete galaxy surveys
  • The goal of a galaxy survey
  • The selection function and survey completeness
  • The 1/\(V_\mathrm{max}\) estimator (Schmidt 1968)
  • The Step-Wise Maximum Likelihood estimator (SWML)
  • The \(C^-\) estimator (Lynden-Bell 1971)
  • Independence tests: detecting luminosity evolution
  • The Schechter luminosity/mass function
  • Eddington bias
  • Angular two-point correlation function \(w(\theta)\)
  • Projected two-point correlation function \(w_p(r_p)\)
  • Redshift-space multipoles \(\xi_\ell(s)\)
  • Jackknife covariance
  • Excess surface density \(\Delta\Sigma(R)\)
  • References
• Test suite and validation
  • Test philosophy
  • Running the tests
  • Per-module test summaries
  • Benchmark timing (test_benchmarks.py)
  • Test coverage gaps (pre-release)
  • Adding new tests
• Installation
  • Requirements
  • Create and activate the environment
  • Install the package in editable mode
  • Verify the installation
  • Build the documentation
  • Run the tests
  • GPU / JAX configuration
  • Remote / HPC cluster setup
• Running the measurement scripts
  • measure_joint_sumstat.py — unified entry point
  • Output directory layout
• Quick start
• Data format
  • HDF5 group schema
  • Provenance attributes
  • Reading example
  • gga_model required fields

Measurement Runs

• Measurement runs
  • Validation run plan
  • Uchuu Mock VLIM M★ — Run Summary
  • BGS VLIM M★ LS10 — Run Summary
  • BGS LS10 — Joint SMF + w_p(r_p) + ΔΣ
  • COSMOS validation: LF and SMF
  • GAMA DR4 validation: LF and SMF

Visualisation

• Visualisation
  • 2D Light-cone Wedge Plot
  • 3D Light-cone Visualisation

Literature

• Literature Benchmarks
  • Galaxy Benchmark
  • AGN Benchmark
  • Gas Benchmark
  • Survey Completeness
  • Cross-benchmark connections

API Reference — Stable

• Catalogues
  • GalaxyCatalogue
  • PhotoZCalibTable
  • ShapeCatalogue
• Luminosity and stellar mass functions
  • Stable: SMF estimators
  • Deprecated: Schechter model functions
• Two-point correlation functions
  • Stable estimators
  • Development estimators
• Galaxy-galaxy lensing
  • delta_sigma()
  • apply_multiplicative_bias()
  • apply_shear_response()
  • effective_sigma_crit_inv()
  • nz_from_calibration_table()
• Covariance estimation
  • assign_jackknife_regions()
  • jackknife_covariance()
  • jackknife_covariance_from_labels()
  • jackknife_covariance_from_subsamples()
  • bootstrap_covariance()
• I/O
  • SummaryStatWriter
  • SummaryStatReader

API Reference — Development

• k-Nearest-Neighbor Statistics — API
  • Mathematical Definition
  • Backend: pyfnntw
  • Quick-Start Example
  • Output HDF5 Schema
  • API Reference
  • References
• Power spectra
  • cl_angular()
  • pk3d()
  • pk_multipoles()
• Redshift distributions
  • nz_histogram()
  • nz_kde()
• Cosmology utilities
  • astropy_to_jax_cosmo()
  • comoving_distance_jax()
  • comoving_volume_jax()
  • critical_surface_density_jax()

Development

• Estimators in development
• Changelog

References

• Bibliography

For students

• Introduction for students
  • What is a galaxy survey?
  • Major galaxy surveys
  • Why do we compress data into summary statistics?
  • The three families of statistics
  • How sum_stat fits in the pipeline
  • Glossary

Indices and tables

• Index

• Module Index

• Search Page