Welcome to hst123’s documentation!

hst123 is a Python pipeline for Hubble Space Telescope data: query and download from MAST, align images (TweakReg / JHAT), combine with AstroDrizzle, optionally run DOLPHOT for PSF photometry, and scrape DOLPHOT catalogs at a target position.

• Installation — Python 3.12, Conda, DrizzlePac, optional DOLPHOT.

• User guide — Work-directory layout, CLI overview, outputs, formats.

• API reference — hst123 class, utilities, DOLPHOT HDF5 export.

Quick install

From the repository root (see Installation for detail):

conda env create -f environment.yml
conda activate hst123
pip install drizzlepac
pip install -e .

Build this documentation locally:

pip install -e ".[docs]"
cd docs && make html

The documentation workflow publishes to GitHub Pages.

Repository layout

• hst123/ — _pipeline (CLI and orchestration), primitives/ (FITS, photometry, astrometry, DOLPHOT, scrape), utils/ (options, logging, paths, AstroDrizzle helpers, DOLPHOT utilities, bundled STScI WCS under utils.stwcs), datamodels/.

• tests/ — pytest suite (markers: network, dolphot).

• docs/ — Sphinx (reStructuredText + MyST Markdown): this site, changelog, zeropoints.

Contents

• Installation
  • Python and environment
• User guide
  • Overview
  • Work directory layout
  • Supported instruments and file types
  • Command-line usage
  • Output data formats
  • Python API
  • Further reading
• Changelog
  • Pre-releases (historical)
  • Documentation (Sphinx)
  • Releases
• Zero points
• API reference
  • Entry point
  • Pipeline class
  • CLI options and redo helpers
  • Path helpers
  • Parallel BLAS / OpenMP guard
  • Work directory cleanup
  • DOLPHOT catalog → HDF5
  • Data model
  • Primitives base class

Indices and tables

• Index

• Module Index

• Search Page