ScopeSim's Instrument reference database
This repository contains the data files needed by ScopeSim to create a model of
any given optical train.
The data is split in the following way:
-
Primary observing packages
e.g. Instruments
Primary packages are complete packages which can be used by
scopesimto simulate the readout files from a full optical system (i.e. atmosphere + telescope + relay optics + instrument + detector)These packages contain all information regarding the internal working of the instrument, such as optics, detectors, properties (e.g. temperature), etc
-
Support packages
e.g: Telescopes / Observing sites / Relay optics
These packages only contain information pertaining to the effects generated by the specific set of optics contained within the optical subsystem. These packages are used to support the Primary packages, and can be shared between multiple primary instrument package.
For example, the ELT package cannot be used to generate images on its own, however it is need by both the MICADO and METIS instument packages.
-
PSFs
Currently PSFs are kept separately, simply due to their size
Packages kept here
- Armazones
- ELT
- MORFEO
- MICADO
- METIS (under construction)
Status of packages
Detailed information on the test suite can be found in the
Contributing
The IRDB is closely tied to ScopeSIM. The following development workflow is therefore used:
- The IRDB master branch should always work with the ScopeSIM master branch, similarly with the dev_master branches.
- The dev_master branch should always be ahead of the master branch.
- Feature branches are used to introduce new features and these are branched from dev_master, and merged into dev_master.
- Merging a feature branch into dev_master is only allowed if all tests against ScopeSIM dev_master succeed.
- Merging a feature branch into dev_master should preferably require a review from a second set of eyes to avoid accidents.
- dev_master is merged into master whenever ScopeSIM dev_master is merged into master.