User guide

The user guide explains the ideas behind wcc-etc and how the pieces fit together. The API reference has the exact signatures and docstrings.

• Concepts and architecture
  • The three building blocks
  • Constructing a simulation
  • Inspecting and updating parameters
  • Count rates and the electron budget
  • Accessor properties
• Scenes, sources, and backgrounds
  • What goes in which slot
  • Building a scene
  • How an element is distributed on the detector
  • Hosts with a spatial profile: Sersic galaxies
  • Magnitude systems
  • Stellar and galaxy templates
  • Parametric source spectra
  • Rebuilding a parametric spectrum with update
  • Backgrounds
  • Working with scene elements directly
• Signal-to-noise and exposure time
  • What goes into the SNR
  • Image-based SNR (the default)
  • Exposure time for a target SNR
  • Multiple reads (n_reads)
  • The analytic Airy SNR
• PSFs and image simulation
  • PSF models
  • The wavelength the PSF is rendered at
  • Automatic PSF selection by focus level
  • Rendering a PSF on its own
  • Simulating an image
  • Grid size and oversampling
  • Telescope jitter
• Saturation
  • The peak pixel
  • The saturation flag
  • Saturation in the image and SNR paths
• Plotting
  • The house style
  • The example image
  • The image plots
  • Two ways to call them
  • Convenience methods on SimulatedImage
  • Return values and embedding
  • Filter throughput
  • Curves from a Simulation
  • Objects that plot themselves

If you would rather learn from a worked example, the Tutorials cover the same ground as runnable notebooks.