telescope-sim

Composable, config-driven simulation of multi-aperture telescope PSFs, deformable mirrors, coronagraphs, and fiber coupling — built on HCIPy.

The package exposes a small set of abstract base classes (Aperture, Corrector, Coronagraph, FocalPlane, OutputTap, PostProcessor) plus a registry of stock implementations. Optical pipelines are described in YAML; the package validates the config with pydantic v2 and instantiates a TelescopeSim ready to sample().

Getting Started

• Getting started
  • Installation
  • Quick start
  • Bundled presets

User guide

• Architecture & concepts
  • The pipeline
  • Stages and the registry
  • The corrector role system
  • Reference PSF
  • Atmosphere
• Configuration reference
  • Strehl
  • Per-sample state
  • Stages
  • Examples

Tutorials

• 1. Canonical mini-ELF
  • Detector noise
  • Extended-source imaging via convolve_image
• 2. Vortex coronagraph
• 3. Custom pupil + Zernike DM (VAMPIRES)
  • Atmosphere as a per-sample input
• 4. Fiber MMF coupling
• 5. Extending telescope-sim with custom components
  • Part 1 — Custom Corrector: a Xinetics DM
  • Part 2 — Custom PostProcessor: PowScale
  • Recap
• 6. Actuator-grid DM with baked-in misalignment
  • Misalignment: rotation and command flips
  • Influence models: gaussian vs xinetics
  • Notes for real-DM workflows

API reference

• API reference
  • Top-level
  • Pipeline
  • Abstract base classes
  • Configuration
  • Concrete implementations
  • Helpers
  • Registry

Indices and tables

• Index

• Module Index

• Search Page