Example

In this chapter, an overview of the example of a real (semi-real), Calibration Configuration for an instrument, here FORSUP, is provided.

The Calibration Configuration Set example is used internally in the CalOb Project for the purpose of testing, and to provide a ‘live example’ that makes it possible to execute the CalOb Generator on the shell with no configuration.

The example is provided as an ‘integral part’ of the CalOb source tree, to be able to use it for the software unit and integration testing, executed for the purpose of SQA.

Note: For instruments it is foreseen to have a ready-to-use Resource Tree inside the Instrument Source Tree, which is referenced by the “CFGPATH” environment variable.

Example Files in the CalOb Source Tree

The example provides the following files:

ifw-calob/common/resource/config/ifw/calob/example/configuration.yaml: The CalOb Configuration file, used when invoking the “calobGenerator” tool on the command line.

ifw-calob/common/resource/image/ifw/calob/example/FORS*_no_data.fits: Entire FITS data set, generated for one representative night with the FORS2 (later FORSUP) instrument, making it possible to obtain a realistic invocation of the “calobGenerator” tool on the command line.

ifw-calob/common/resource/obd/ifw/calob/example/FORSUP_*.obd.json: The actual set of Static Calibration OB file (OBD) for the FORS2 (later FORSUP) instrument.

ifw-calob/common/resource/obdx/ifw/calob/example/FORSUP_*.obdx.json: The actual set of Template Calibration OB file (OBD) for the FORS2 (later FORSUP) instrument.

ifw-calob./common/src/ifw/calob/example/FORSUP_calibration_plan.py: The Calibration Plan Module, executed in the Python interpreter by the “calobGenerator” tool to generate the output Daily Calibration OB. It provides examples of the Instrument External Functions Library Class, the Instrument Calibration Tables Class and the Calibration Schedule Class.

Example Files in the “INTROOT”

After installation, the files of the example are replicated into the “INTROOT” to make them easier accessible and to be able to use them on the command line, e.g. for demo invocation of the “calobGenerator” tool (listed in the same order as above, without additional comments):

  • $INTROOT/resource/config/ifw/calob/example/configuration.yaml.

  • $INTROOT/resource/image/ifw/calob/example/FORS*_no_data.fits.

  • $INTROOT/resource/obd/ifw/calob/example/FORSUP*.obd.json.

  • $INTROOT/resource/obdx/ifw/calob/example/FORSUP*.obdx.json.

  • $INTROOT/lib/python<version>/site-packages/ifw/calob/example/FORSUP_calibration_schedule.py.

If the “$INTROOT/resource” path is included in the paths of the “CFGPATH” environment variable, the files will be automatically searchable by the standard ELT environment search mechanism.

Again, instruments shall not install the files, pertaining the Instrument CalOb Configuration Set in the “INTROOT” but shall provide a ready-to-use Resource Tree inside the Instrument Source Tree to keep the run-time files under configuration control. The same goes for the science FITS files, which shall be stored in the “$DATAROOT” area.