esc-etc Logo

Getting started

  • Installation
    • Requirements
    • Install from source
    • Using a conda environment
    • Verify the installation
    • Running the test suite
    • Building the documentation locally
  • Quick start
    • The mental model
    • 1. Build a simulation from the defaults
    • 2. Compute signal-to-noise
    • 3. Invert: integration time for a target SNR
    • 4. Check saturation
    • 5. Change parameters and recompute
    • 6. Plot the results
    • Where to go next

User guide

  • User guide
    • Concepts and architecture
      • The four building blocks
      • The photometric aperture
      • Constructing a simulation
      • The noise model
      • Inspecting and updating parameters
      • Times
      • Count rates and the electron budget
    • Coronagraph and contrast
      • The vocabulary
      • Parameters
      • The off-axis throughput
      • Sweeping the parameters
    • Scenes and sources
      • Building a scene
      • Planet spectra
      • Magnitude systems
      • Updating scene elements
    • Signal-to-noise and integration time
      • The noise budget
      • Observing strategy
      • Computing SNR
      • Inverting for integration time
      • Saturation
      • Swapping the noise model
    • Saturation
      • The saturation time
      • What sets the peak-pixel rate
      • Choosing a frame time
    • Plotting
      • The methods
      • The overview
      • Single panels
      • Parameter sweeps
      • Several curves on one axis
      • The functions behind the methods
      • The house style

Tutorials

  • Tutorials
    • 01 Getting started with esc_etc
      • 1. A default simulation
      • 2. SNR for a given integration time
      • 3. Integration time for a target SNR
      • 4. Where the noise comes from
      • 5. Everything at once
    • 02 Components and parameters
      • 1. Telescope
      • 2. Sensor: detector and bandpass
      • 3. Filters
      • 4. Scene and coronagraph
      • 5. Assemble by hand
      • 6. Change parameters
    • 03 Coronagraph and contrast
      • 1. Raw dark-hole contrast
      • 2. Post-processing gain
      • 3. Separation and off-axis throughput
      • 4. Reference-star subtraction
    • 04 Integration time, frames and saturation
      • 1. Frame time and read noise
      • 2. Inverting for integration time
      • 3. Saturation

Reference

  • API reference
    • Top-level public API
    • Modules
      • Simulation (esc_etc.simulation)
      • Telescope (esc_etc.telescope)
      • Sensor (esc_etc.sensor)
      • Scene (esc_etc.scene)
      • Coronagraph (esc_etc.coronagraph)
      • Noise model (esc_etc.noise)
      • Plotting (esc_etc.plotting)
      • Bundled Lazuli configuration (esc_etc.uasal_config)
      • Legacy API (esc_etc.ExposureTimeSNRCalculatorESC, deprecated)
  • Configuration and filters
    • The default instrument
    • The ESC filters
    • Building the components yourself
    • Supplying your own configuration
    • Overriding parameters at runtime
    • What is in the bundled snapshot
  • Known limitations
  • Changelog
    • 0.1.0 (2026-10-12)
    • Physics
    • Object-oriented API
    • Plotting
    • Tutorials
    • Documentation site
    • Earlier history
esc-etc
  • Python Module Index

Python Module Index

e
 
e
- esc_etc
    esc_etc.coronagraph
    esc_etc.ExposureTimeSNRCalculatorESC
    esc_etc.noise
    esc_etc.plotting
    esc_etc.scene
    esc_etc.sensor
    esc_etc.simulation
    esc_etc.telescope
    esc_etc.uasal_config

© Copyright 2026, Schmidt Sciences / Schmidt Observatory System / UASAL.

Built with Sphinx using a theme provided by Read the Docs.