run

simcado.simulation.run(src, mode='wide', cmds=None, opt_train=None, fpa=None, detector_layout='small', filename=None, return_internals=False, filter_name=None, exptime=None, sub_pixel=False, sim_data_dir=None, **kwargs)[source]

Run a MICADO simulation with default parameters

Parameters
srcsimcado.Source

The object of interest

modestr, optional

[“wide”, “zoom”] Default is “wide”, for a 4mas FoV. “Zoom” -> 1.5mas

cmdssimcado.UserCommands, optional

A custom set of commands for the simulation. Default is None

opt_trainsimcado.OpticalTrain, optional

A custom optical train for the simulation. Default is None

fpasimcado.Detector, optional

A custom detector layout for the simulation. Default is None

detector_layoutstr, optional

[“small”, “centre”, “full”, “tiny”] Default is “small”. “small” - 1x 1k-detector centred in the FoV “tiny” - 128 x 128 pixels centred in the FoV “centre” - 1x 4k-detector centred in the FoV “full” - 9x 4k-detectors

filenamestr, optional

The filepath for where the FITS images should be saved. Default is None. If None, the output images are returned to the user as FITS format astropy.io.HDUList objects.

return_internalsbool

[False, True] Default is False. If True, the UserCommands, OpticalTrain and Detector objects used in the simulation are returned in a tuple: return hdu, (cmds, opt_train, fpa)

filter_namestr, TransmissionCurve

Analogous to passing INST_FILTER_TC as a keyword argument

exptimeint, float
[s] Total integration time. Currently, this is observed in one DIT

(i.e. NDIT=1). Use OBS_DIT and OBS_NDIT for more general setup.

sim_data_dirstr

Path to where the data is kept