Skip to main content

PyPI Documentation Status Tests License Python Versions


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.

Metadata

Release files for hwoutils 1.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hwoutils 1.10.0
File Size Uploaded
hwoutils-1.10.0.tar.gz 25.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hwoutils 1.10.0
File Interpreter ABI Platform
hwoutils-1.10.0-py3-none-any.whl Python 3 none any Details

Total release size: 48.3 kB

Release files / hwoutils-1.10.0.tar.gz

Download URL hwoutils-1.10.0.tar.gz
Size 25.4 kB
Tags Source
SHA-256 checksum
How to use checksums
21532a57f3683b8ba761033bbce23119f68a80fbd0a2c8f761861a16e94d13e2
BLAKE2b-256 checksum
How to use checksums
f731ca0308ba8740566657414f83c67d774fe81b97588acd6b2326fb5eb18a2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.

Transparency log

Release files / hwoutils-1.10.0-py3-none-any.whl

Download URL hwoutils-1.10.0-py3-none-any.whl
Size 22.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1c0f93830e6525121b55428b5db033aae758fbfbecb69daf2cf07c6d7123b937
BLAKE2b-256 checksum
How to use checksums
d0eb1b43a001e77b43b84ebdf3382295c97d37a3403656cc33cd7e4be1a65ac9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 14, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.10.0 This release

2 release files

1.9.0

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page