SMPy: Shear Mapping in Python

SMPy is a mass reconstruction toolkit for weak gravitational lensing analysis.

Note

This documentation is under active development. For now, it contains the auto-generated API reference and configuration guide. Tutorials and examples will be added in future updates.

Overview:

• Overview
  • Quickstart
  • Methods at a glance
  • What SMPy includes

Installation:

• Installation

Tutorials:

• Tutorials
  • 00 – One‑liner CLI
  • Subpages

API Reference:

• High-Level Interface
  • smpy.map_mass
  • smpy.map_kaiser_squires
  • smpy.map_aperture_mass
  • smpy.map_ks_plus
• Configuration Management
  • smpy.Config
• Core Pipeline
  • smpy.run
• Mass Mapping Methods
  • Base Class
  • Algorithm Implementations
• Coordinate Systems
  • Factory Function
  • Base Class
  • Implementations
• Filters & Processing
  • Aperture Mass Filters
  • Starlet Wavelet Processing
  • Plotting Filters
• Plotting
  • smpy.plotting.plot.plot_mass_map
  • smpy.plotting.plot.plot_snr_map
  • Counts Map
  • X-ray Contour Overlay
• Error Quantification
  • smpy.error_quantification.snr.run.run
• Utilities
  • Data I/O
  • Analysis Tools

Configuration:

• Configuration Guide
  • Configuration Structure
  • Loading Configuration
  • Parameter Reference
  • Example Configuration Files

Indices and tables

• Index

• Module Index

• Search Page