pyhotpants documentation

Version 0.2.0 (staging on the development branch)

pyhotpants is a Python wrapper around A. Becker’s HOTPANTS (High Order Transform of PSF And Template Subtraction) C code. It exposes the Alard & Lupton image-subtraction algorithm through a NumPy/Astropy-friendly API.

Stable releases on main remain 0.1.x (currently prepared as 0.1.2) with the C extension as the default backend. This 0.2.0 documentation describes the staging line on development, which adds an opt-in pure Python backend, oversampled templates, and connected-region stamps. Old call patterns continue to work; see Compatibility and migration.

Contents:

• Compatibility and migration
  • Supported compatibility contract (0.2.0 staging)
  • What is new in 0.2.0 (staging on development)
  • Migration tips
• Backends (C extension vs pure Python)
  • Default: C extension
  • Opt-in: pure Python
  • Pure-Python-only features
• C vs pure Python parity policy
  • In scope
  • Compared products (minimum)
  • Out of scope (no C twin)
  • How we test
• Connected-region stamps
  • Requirements
  • Example
  • Related HotpantsConfig fields
• API Reference
  • Core pipeline
• Configuration Reference
  • HotpantsConfig
• The Substamp Class
  • Substamp
  • SubstampStatus
• Standalone template convolution
  • Quick start
  • API