Skip to main content

A JAX-based toolkit for end-to-end HWO mission simulations, integrating yippy, orbix, coronagraphoto, and coronalyze.

Project description

PyPI Documentation Status Tests License Python Versions


hwosim

hwosim is a JAX-based toolkit for running end-to-end Habitable Worlds Observatory (HWO) mission simulations. It ties together the full suite of HWO direct imaging simulation tools:

  • yippy — Coronagraph performance modeling
  • orbix — Orbital dynamics and target scheduling
  • coronagraphoto — Image simulation for coronagraphic observations
  • coronalyze — Post-processing and SNR analysis
  • All the other ones I need to still write

Key Features

  • Mission Simulation: End-to-end simulation pipelines from target selection through observation and analysis
  • Yield Estimation: Detection completeness and exoplanet yield calculations
  • Integration Orchestration: Unified interface across the HWO simulation suite
  • JAX-Native: Fully JIT-compilable, differentiable, and GPU-accelerated

Installation

With uv (recommended):

uv pip install hwosim

Or with pip:

pip install hwosim

(Note: You may need to install JAX separately to match your specific hardware acceleration requirements.)

Quick Start

import hwosim

Documentation

Full documentation is available at hwosim.readthedocs.io.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hwosim-0.0.1.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hwosim-0.0.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file hwosim-0.0.1.tar.gz.

File metadata

  • Download URL: hwosim-0.0.1.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hwosim-0.0.1.tar.gz
Algorithm Hash digest
SHA256 b8efd38d2a07deae2e624340cb55defbcc04b3528d766f8f335ff544315e2dd3
MD5 b81cb8f5bd61b91faf9004d843bd474e
BLAKE2b-256 1e6ae7f1d8834ab72b6a8ad2fbe764aa4f32ff62d253c575afb8977b1a245df3

See more details on using hashes here.

Provenance

The following attestation bundles were made for hwosim-0.0.1.tar.gz:

Publisher: publish-to-pypi.yml on CoreySpohn/hwosim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hwosim-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: hwosim-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hwosim-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7040680f5bea4e1b1641f762088ddf5fe91adbcb30564563c82aac186f6bd707
MD5 b37f2b5acb7caca394327e8774ccfcc0
BLAKE2b-256 a94d40f30ecae80879d5bf93032fe689bf6f224ed009035b72ad65b6a1cd0ff1

See more details on using hashes here.

Provenance

The following attestation bundles were made for hwosim-0.0.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on CoreySpohn/hwosim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page