hwoutils 1.0.0

Shared JAX-based utilities for the HWO direct imaging simulation suite — constants, conversions, and image transforms.

---

hwoutils

hwoutils is the shared utility foundation for the HWO direct imaging simulation suite. It provides JAX-native physical constants, unit conversions, and flux-conserving image transforms used across:

• yippy — Coronagraph performance modeling
• orbix — Orbital dynamics and target scheduling
• coronagraphoto — Image simulation for coronagraphic observations
• coronalyze — Post-processing and SNR analysis
• hwosim — End-to-end mission simulations

Key Features

• Physical Constants — Single source of truth for SI constants, conversion factors, and astronomical quantities
• Unit Conversions — Pure JAX conversion functions (angular, flux, distance, time) with zero astropy overhead
• Image Transforms — Flux-conserving resampling, sub-pixel shifts, and cubic spline interpolation
• JAX-Native — All operations are JIT-compilable, differentiable, and GPU-accelerated

Installation

With uv (recommended):

uv pip install hwoutils

Or with pip:

pip install hwoutils

Quick Start

from hwoutils import constants as const
from hwoutils import conversions as conv
from hwoutils.transforms import resample_flux

# Convert 5 arcsec to lambda/D for a 6m telescope at 550nm
sep_lod = conv.arcsec_to_lambda_d(5.0, 550.0, 6.0)

# Flux-conserving PSF resampling
resampled = resample_flux(psf, pixscale_src=0.01, pixscale_tgt=0.1, shape_tgt=(64, 64))

Documentation

Full documentation is available at hwoutils.readthedocs.io.