User guide

The user guide explains the physics behind each part of a calculation and how the pieces fit together. The API reference gives the exact signatures and docstrings, and the Tutorials cover the same ground as runnable notebooks.

• 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