wcc-sim Logo

Getting started

  • Installation
    • Requirements
    • Install from PyPI
    • Install from source
    • Using a conda environment
    • Verify the installation
    • Running the test suite
    • Building the documentation locally
  • Quick start
    • The mental model
    • 1. Simulate a field
    • 2. Inspect the result
    • 3. Or use the command line
    • 4. Read the FITS output back
    • Where to go next

User guide

  • User guide
    • Concepts: the pipeline
      • Design principles
      • The two detectors
      • Key parameters at a glance
    • Gaia catalogs
      • Cone search
      • On-disk cache
      • Bright stars Gaia does not have
      • Bringing your own catalog
      • The output catalog
    • From Gaia photometry to count rates
      • Memoization
      • Sky and dark
      • Practical notes
    • PSFs and defocus
      • The three focus modes
      • Which wavelength
      • Oversampled rendering
      • Stamp sizes
      • Jitter
      • Beyond the stamp
      • Looking at it
    • Scattered light
      • How the halo enters the image
      • Why a radial profile
      • Normalisation
      • Limits
    • Noise and saturation
      • The model
      • n_reads semantics
      • Per-star saturation flags
      • Quick example
    • FITS output and WCS
      • The SimulatedField object
      • FITS layout
      • Header cards
      • The WCS
      • Reading it back
    • Plotting
      • What is available
      • The house style

Tutorials

  • Tutorials
    • Getting started with wcc-sim
      • 1. Simulate a field
      • 2. The image with the Gaia catalog overlaid
      • 3. The three PSF modes on one star
      • 4. Write the FITS file
      • Summary
    • Verifying the simulated images
      • 1. The test field
      • 2. PSF modes: peak ordering
      • 3. Astrometry
      • 4. Photometric closure
      • 5. Noise statistics
      • 6. Saturation flags
      • 7. FITS round trip
      • Summary
    • PSF focus modes: Airy vs defocus
      • 1. Render the three PSFs
      • 2. Radial profiles and encircled energy
      • 3. Jitter
      • Summary
    • Detectors, filters, and count rates
      • 1. The two detectors
      • 2. Available sensorfilter keys
      • 3. BP−RP → Pickles spectral type
      • 4. Count rates through the instrument model
      • 5. The same field on both detectors
      • Summary
    • Noise and saturation
      • 1. A brightness ladder
      • 2. The background noise budget
      • 3. n_reads: trading saturation for read noise
      • 4. Noiseless closure
      • Summary
    • Astrometry, WCS, and custom catalogs
      • 1. The TAN WCS and its round-trip
      • 2. Do stars land where the WCS says?
      • 3. Position angle
      • 4. Edges and the in_image flag
      • Summary
    • The command line and the FITS output
      • 1. wcc-sim --help
      • 2. Simulate a field from the shell
      • 3. What is in the file
      • 4. The catalog extension
      • 5. Astrometric closure through the file
      • Summary
    • PSF wings: no more postage stamps
      • 1. Before / after on a real field
      • 2. The wing model
      • 3. Seam smoothness
      • 4. Encircled energy: what do the wings change?
      • 5. How far do the wings extend in practice?
      • 6. Is the extrapolation correct?
      • Summary
    • wcc-phot: differential photometry of a WCC image series
      • 1. Simulate a dithered series
      • 2. Pick a target and run aperture photometry
      • 3. The field, with apertures
      • 4. Relative light curve
      • 5. Per-frame centroiding
      • 6. PSF photometry
      • 7. Watching it live
      • Summary
    • Plotting: every .plot_* method in one place
      • 1. A synthetic field
      • 2. field.plot()
      • 3. field.plot_cutout()
      • 4. field.plot_psf_profile()
      • 5. field.plot_satmask() and field.psf_report()
      • 6. Stamps, radial profiles and encircled energy
      • 7. Photometry: PhotometryResult.plot_*
      • Summary

Reference

  • Command-line interface
    • Options
    • Cookbook
    • wcc-phot
    • Example scripts
  • API reference
    • Top-level public API
    • Modules
      • End-to-end pipeline (wcc_sim.pipeline)
      • Gaia catalogs (wcc_sim.catalog)
      • Bright-star supplement (wcc_sim.brightcat)
      • Epoch propagation and cross-matching (wcc_sim.astrometry)
      • Count rates (wcc_sim.starflux)
      • PSF rendering (wcc_sim.psf)
      • Chromatic effective PSFs (wcc_sim.chromatic)
      • PSF wing extension (wcc_sim.wings)
      • Scattered-light halo (wcc_sim.scatter)
      • Scene rendering & noise (wcc_sim.render)
      • Extended sources (wcc_sim.extended)
      • Detector geometry (wcc_sim.detectors)
      • WCS construction (wcc_sim.wcsutil)
      • FITS output (wcc_sim.fitswriter)
      • Plotting helpers (wcc_sim.plotting)
      • PSF report (wcc_sim.psfreport)
      • Command-line interface (wcc_sim.cli)
      • wcc_phot: differential photometry
  • Glossary
  • Changelog
    • 0.1.0 (2026-10-12)
      • Packaging
      • Simulator (wcc_sim)
      • Photometry (wcc_phot)
      • Plotting
      • Validation
      • Fixes from the September 2026 audit
      • Documentation
wcc-sim
  • Overview: module code

All modules for which code is available

  • wcc_phot.apphot
  • wcc_phot.centroid
  • wcc_phot.cli
  • wcc_phot.geometry
  • wcc_phot.io
  • wcc_phot.lightcurve
  • wcc_phot.live
  • wcc_phot.pipeline
  • wcc_phot.psfphot
  • wcc_phot.report
  • wcc_phot.select
  • wcc_phot.validation
  • wcc_sim.astrometry
  • wcc_sim.brightcat
  • wcc_sim.catalog
  • wcc_sim.chromatic
  • wcc_sim.cli
  • wcc_sim.detectors
  • wcc_sim.extended
  • wcc_sim.fitswriter
  • wcc_sim.pipeline
  • wcc_sim.plotting
  • wcc_sim.psf
  • wcc_sim.psfreport
  • wcc_sim.render
  • wcc_sim.scatter
  • wcc_sim.starflux
  • wcc_sim.wcsutil
  • wcc_sim.wings

© Copyright 2026, Schmidt Sciences / Schmidt Observatory System.

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