Workflow Summary
This page catalogues every simulation block workflow shipped with the repository. Each workflow is a Python script that bundles a set of YAML observation templates and parameters to produce a self-contained dataset for one instrument mode.
All workflows follow the same pattern: call
runSimulationBlock(yamlFiles, params) with a list of YAML files and a
parameter dictionary. See How to Write a Workflow for how to create your own.
imgLM – LM-band Imaging
- Script:
python/imgLM.py- Output directory:
output/imgLM- Start date:
2027-01-25 00:00:00- Calibrations:
3 darks/flats per type, static calibrations enabled
YAML files used:
scienceLM.yaml– science exposures and sky framesstdLM.yaml– standard star and skydistortionLM.yaml– pinhole-mask distortion calibrationdetlinLM.yaml– detector linearity series
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
star_field |
Lp |
3 science exposures |
|
empty_sky |
Lp |
3 sky frames |
|
calib_star |
Lp |
3 standard star exposures |
|
empty_sky |
Lp |
3 standard sky frames |
|
pinhole_mask |
Lp |
WCU pinhole distortion |
|
empty_sky |
closed |
4 DITs (1, 2, 3, 4 s) |
Plus auto-generated darks, lamp flats, and twilight flats.
imgN – N-band Imaging
- Script:
python/imgN.py- Output directory:
output/imgN- Start date:
2027-01-26 00:00:00- Calibrations:
2 darks/flats per type, static calibrations enabled
YAML files used:
scienceN.yamlstdN.yamldistortionN.yamldetlinN.yaml
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
star_field |
N2 |
1 science exposure |
|
empty_sky |
N2 |
1 sky frame |
|
calib_star |
N2 |
1 standard |
|
empty_sky |
N2 |
1 standard sky |
|
pinhole_mask |
N2 |
WCU pinhole distortion |
|
empty_sky |
closed |
4 DITs (1, 2, 3, 4 s) |
lssLM – LM-band Long-Slit Spectroscopy
- Script:
python/lssLM.py- Output directory:
output/lssLM- Start date:
2027-01-27 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
- Extra parameter:
slit_name = "C-38_1"
YAML files used:
scienceLSSLM.yaml– galaxy science + skystdLSSLM.yaml– standard star + skydetlinLM.yaml– detector linearitydistortionLM.yaml– distortionrsrfLSSLM.yaml– relative spectral response (2 lamp temperatures)rsrfPinhLSSLM.yaml– pinhole RSRFwavecalLSSLM.yaml– wavelength calibration (internal laser)slitlossLSSLM.yaml– slit-loss measurement
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
simple_gal |
L_spec |
Galaxy spectrum |
|
empty_sky |
L_spec |
Sky frame |
|
calib_star |
L_spec |
Standard star |
|
empty_sky |
L_spec |
Standard sky |
|
flat_field |
L_spec |
2 lamp temps (8000 K, 800 K) |
|
pinhole_mask |
L_spec |
Pinhole RSRF, 2 lamp temps |
|
laser_spectrum_lm |
L_spec |
Wavelength calibration |
|
calib_star |
L_spec |
Slit-loss measurement |
|
empty_sky |
closed |
Detector linearity |
|
pinhole_mask |
Lp |
Distortion |
lssN – N-band Long-Slit Spectroscopy
- Script:
python/lssN.py- Output directory:
output/lssN- Start date:
2027-01-28 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
- Extra parameter:
slit_name = "D-57_1"
YAML files used:
scienceLSSN.yamlstdLSSN.yamldetlinN.yamldistortionN.yamlrsrfLSSN.yamlrsrfPinhLSSN.yamlwavecalLSSN.yamlslitlossLSSN.yaml
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
simple_gal |
open |
Galaxy spectrum |
|
empty_sky |
open |
Sky frame |
|
calib_star |
open |
Standard star |
|
empty_sky |
open |
Standard sky |
|
flat_field |
open |
2 lamp temps (8000 K, 800 K) |
|
pinhole_mask |
open |
Pinhole RSRF, 2 lamp temps |
|
laser_spectrum_n |
open |
Wavelength calibration |
|
calib_star |
open |
Slit-loss measurement |
|
empty_sky |
closed |
Detector linearity |
|
pinhole_mask |
N2 |
Distortion |
ifu – IFU (LMS) Spectroscopy
- Script:
python/ifu.py- Output directory:
output/ifu- Start date:
2027-02-01 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
- Cores:
6 (IFU simulations are memory-intensive)
YAML files used:
wavecalIFU.yaml– wavelength calibration (laser, 3.555 um)scienceIFU.yaml– galaxy science + skystdIFU.yaml– standard star + skydetlinIFU.yaml– detector linearitydistortionIFU.yaml– distortionrsrfIFU.yaml– relative spectral responsersrfPinhIFU.yaml– pinhole RSRF
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
laser_spectrum_lm |
open |
Laser at 3.555 um |
|
simple_gal1 |
open |
Galaxy, dit=100 s |
|
empty_sky |
open |
Sky frame |
|
calib_star |
open |
Standard, dit=100 s, ndit=3 |
|
empty_sky |
open |
Standard sky |
|
empty_sky |
closed |
4 DITs (1, 2, 3, 4 s) |
|
pinhole_mask |
open |
Distortion |
|
flat_field |
open |
2 bb_aperture settings |
|
pinhole_mask |
open |
2 bb_aperture settings |
calib – Standalone Calibrations
- Script:
python/calib.py- Output directory:
output/Calib- Start date:
2027-02-02 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
YAML files used:
chophomeLM.yaml– chopper home positionpupilLM.yaml– LM pupil imagingpupilN.yaml– N pupil imagingslitlossLSSLM.yaml– LM slit-lossslitlossLSSN.yaml– N slit-loss
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
empty_sky |
Lp |
3 chopper home frames |
|
star_sky1 |
Lp |
Pupil imaging LM |
|
star_sky1 |
N2 |
Pupil imaging N |
|
calib_star |
L_spec |
Slit-loss LM |
|
calib_star |
open |
Slit-loss N |
hciRavcLM – High-Contrast Imaging, RAVC (LM)
- Script:
python/hciRavcLM.py- Output directory:
output/hciRavcLM- Start date:
2027-01-31 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
YAML files used:
offAxisLM.yaml– off-axis PSF referencehciRavcLM.yaml– RAVC coronagraphic science + skydistortionLM.yamldetlinLM.yamlstdLM.yaml– photometric standard
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
star_sky2 |
Lp |
Off-axis PSF |
|
calib_star |
open |
RAVC coronagraph, dit=0.25 s |
|
empty_sky |
Lp |
Sky for coronagraph |
|
pinhole_mask |
Lp |
Distortion |
|
empty_sky |
closed |
Detector linearity |
|
calib_star |
Lp |
Standard star |
|
empty_sky |
Lp |
Standard sky |
hciAppLM – High-Contrast Imaging, APP (LM)
- Script:
python/hciAppLm.py- Output directory:
output/hciAppLM- Start date:
2027-01-29 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
YAML files used:
offAxisLM.yaml– off-axis PSF referencehciAppLM.yaml– APP coronagraphic science + skydistortionLM.yamldetlinLM.yaml
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
star_sky2 |
Lp |
Off-axis PSF |
|
calib_star |
Lp |
APP coronagraph |
|
empty_sky |
Lp |
Sky for coronagraph |
|
pinhole_mask |
Lp |
Distortion |
|
empty_sky |
closed |
Detector linearity |
hciRavcIfu – High-Contrast Imaging, RAVC (IFU)
- Script:
python/hciRavcIfu.py- Output directory:
output/hciRavcIfu- Start date:
2027-01-30 00:00:00- Calibrations:
2 darks/flats, static calibrations enabled
- Cores:
6 (IFU simulations are memory-intensive)
YAML files used:
offAxisLM.yaml– off-axis PSF reference (img_lm mode)hciRavcIfu.yaml– RAVC IFU coronagraphic science + skydistortionIFU.yamldetlinIFU.yamlrsrfIFU.yaml– relative spectral responsersrfPinhIFU.yaml– pinhole RSRFwavecalIFU.yaml– wavelength calibration
Produces these FITS file categories:
DO category |
Source |
Filter |
Notes |
|---|---|---|---|
|
star_sky2 |
Lp |
Off-axis PSF (img_lm mode) |
|
calib_star |
open |
RAVC IFU, dit=100 s, 3.555 um |
|
empty_sky |
open |
Sky, dit=100 s, 3.555 um |
|
pinhole_mask |
open |
Distortion |
|
empty_sky |
closed |
4 DITs (1, 2, 3, 4 s) |
|
flat_field |
open |
Relative spectral response |
|
pinhole_mask |
open |
Pinhole RSRF |
|
laser_spectrum_lm |
open |
Laser wavelength calibration |
Auto-Generated Calibrations
When doCalib > 0, the framework inspects every template that was simulated
and automatically generates matching calibration frames:
Dark frames – one set for each unique DIT/NDIT/detector combination found in the science and calibration templates.
Lamp flats – flat-field exposures using the WCU blackbody source, matched to each filter used.
Twilight flats – flat-field exposures using a twilight sky source, matched to each filter used.
The doCalib parameter controls how many of each calibration type to
generate (e.g. doCalib=3 produces 3 darks and 3 flats per configuration).
Static Calibration Files
When doStatic=True, the framework generates prototype FITS files for
external/static calibrations via makeCalibPrototypes.py:
File |
Description |
|---|---|
|
Reference standard star catalogue |
|
Flux standard source catalogue |
|
Pinhole mask position table |
|
Laser spectrum table |
|
Line Spread Function kernel |
|
Initial wavelength guess for LSS |
|
Distortion solution tables |
|
Atmospheric transmission profile |
|
Adaptive optics PSF model |
|
Synthetic transmission curves |
|
Detector persistence map |