EUROPEAN SOUTHERN OBSERVATORY

Organisation Européenne pour des Recherches Astronomiques dans l'Hémisphère Austral

Europäische Organisation für astronomische Forschung in der südlichen Hemisphäre

 

 

 

 

VLT PROGRAMME

 

 

VERY LARGE TELESCOPE

 

 

 

 

 

VLT Software

---

Template Instrument Software

User and Maintenance Manual

 

 

 

 

 

 

Doc. No.: VLT-MAN-ESO-17240-1973

 

Issue: 5

 

Date: 13/01/2005

 

 

 

 

 

 

Name                                                       Date                         Signature

                Prepared:  A.Longinotti                                                      13/01/2005

 

 

Name                                                       Date                         Signature

          Approved:  K.Wirenstrand                                                                 

 

Name                                                       Date                         Signature

                Released:  K.Wirenstrand                                     

 

 

VLT PROGRAMME * TELEPHONE: (089) 3 20 06-0 * FAX: (089) 3 20 06 514


 

CHANGE RECORD

 

 

ISSUE

DATE

SECTION/PAGE

AFFECTED

REASON/INITIATION

DOCUMENTS/REMARKS

 

1.0

28/11/1999

All

First issue, containing only ICS part

2.0

08/04/2001

All

Second issue, containing the whole instrument, including OS

3

28/03/2002

4.7.2 5.3 11.10.4

MAR2002, Added ICS stand-alone GUI, SPR VLTSW20010501, VLTSW20010502.

4

31/03/2003

3.2 Appendix B

APR2003

5

13/01/2005

2.2.1 3.2.1

Chapter 7

Chapter 8

11.5

App. A

App. B

New installation modules for locations other than the final one

Added chapter on test Software

Contents of modules updated

Contents of configuration files removed

Removed xxinsCreateNewInstrument (VLTSW20040136)

Removed xxinsChangeEnvs (VLTSW20040136)

 


 

TABLE OF CONTENTS

 

 

 

TABLE OF CONTENTS                                                                                                                                                                                      3

1 INTRODUCTION                                                                                                                                                                                             7

1.1     Purpose                                                                                                                                                                                                   7

1.2     Scope                                                                                                                                                                                                       7

1.3     Applicable Documents                                                                                                                                                                         7

1.4     Reference Documents                                                                                                                                                                           8

1.5     Abbreviations and Acronyms                                                                                                                                                             9

1.6     Glossary                                                                                                                                                                                                  9

1.7     Stylistic Conventions                                                                                                                                                                            9

1.7.1      Data Flow and Processor Model Diagrams                                                                                                                             9

1.8     Naming Conventions                                                                                                                                                                          10

1.9     Problem Reporting/Change Request                                                                                                                                                10

2 OVERVIEW                                                                                                                                                                                                     11

2.1     Hardware architecture                                                                                                                                                                         11

2.1.1      Devices                                                                                                                                                                                       11

2.1.2      Computers                                                                                                                                                                                  11

2.1.3      LANs                                                                                                                                                                                           11

2.1.4      Special connections                                                                                                                                                                  11

2.2     Software Architecture                                                                                                                                                                         13

2.2.1      Software Modules                                                                                                                                                                     13

2.2.2      Environments                                                                                                                                                                             13

2.2.3      Standards                                                                                                                                                                                   13

3 INSTALLATION GUIDE                                                                                                                                                                               15

3.1     Requirements                                                                                                                                                                                        15

3.1.1      Hardware                                                                                                                                                                                    15

3.1.2      Software                                                                                                                                                                                      15

3.2     Installation procedure                                                                                                                                                                         15

3.2.1      Installation at other locations                                                                                                                                                 16

4 OPERATOR’S GUIDE                                                                                                                                                                                   17

4.1     System Start-up                                                                                                                                                                                    17

4.1.1      Log-in                                                                                                                                                                                          17

4.1.2      Telescope availability                                                                                                                                                               17

4.1.3      Midas availability                                                                                                                                                                      18

4.1.4      Instrument Software Start-up                                                                                                                                                  18

4.1.5      Begin of operations                                                                                                                                                                  19

4.1.6      End of operations                                                                                                                                                                      19

4.2     System Shut-down                                                                                                                                                                              19

4.3     User Station                                                                                                                                                                                          20

4.4     Observations with Templates                                                                                                                                                            21

4.5     Alarms                                                                                                                                                                                                   21

4.6     Data files location                                                                                                                                                                                21

4.7     Engineering                                                                                                                                                                                           21

4.7.1      OS Engineering GUI                                                                                                                                                                  21

4.7.2      ICS Engineering GUI                                                                                                                                                                 21

5 PROGRAMMER'S GUIDE                                                                                                                                                                           23

5.1     Instrument Modes                                                                                                                                                                               23

5.2     Subsystems Identifiers                                                                                                                                                                       23

5.3     ICS Software Devices                                                                                                                                                                          23

5.3.1      ICS Special devices                                                                                                                                                                   24

5.3.2      ICS Assemblies                                                                                                                                                                         24

5.4     Exposures                                                                                                                                                                                              25

5.4.1      Exposure types                                                                                                                                                                          25

5.4.2      Exposure Id                                                                                                                                                                                25

5.4.3      Exposure Status                                                                                                                                                                         25

5.4.4      Exposure Parallelism                                                                                                                                                                 25

5.4.5      Exposure Life Cycle                                                                                                                                                                  25

5.4.6      Exposure execution                                                                                                                                                                   26

5.5     Operational States                                                                                                                                                                               26

5.6     Commands                                                                                                                                                                                            26

5.6.1      OS Special commands                                                                                                                                                              26

5.6.2      ICS Special commands                                                                                                                                                             26

5.6.3      DCS Special commands                                                                                                                                                            26

5.7     Tcl libraries                                                                                                                                                                                           26

5.8     Dictionaries                                                                                                                                                                                           26

5.9     Alias files                                                                                                                                                                                              27

5.10    Configuration files                                                                                                                                                                               27

5.11    Setup files and keywords                                                                                                                                                                   27

5.11.1        OCS keywords                                                                                                                                                                       27

5.11.2        INS keywords                                                                                                                                                                        27

5.11.3        DCS keywords                                                                                                                                                                       28

5.12    FITS files                                                                                                                                                                                               28

5.13    Public on-line database attributes                                                                                                                                                     28

5.14    Operational logs                                                                                                                                                                                   28

5.15    Templates                                                                                                                                                                                              28

5.15.1        Acquisition Templates                                                                                                                                                         29

5.15.2        Calibration Templates                                                                                                                                                          29

5.15.3        Observation Templates                                                                                                                                                        29

6 CONFIGURATION                                                                                                                                                                                        30

6.1     Change Instrument Configuration Parameters                                                                                                                                30

7 TEST                                                                                                                                                                                                                 32

8 MAINTENANCE                                                                                                                                                                                             33

8.1     General                                                                                                                                                                                                   33

8.1.1      Module xxins                                                                                                                                                                              33

8.1.2      Module dicXXXX                                                                                                                                                                     33

8.2     OS                                                                                                                                                                                                           33

8.2.1      Module xxo                                                                                                                                                                                 33

8.2.2      Module xxopan                                                                                                                                                                          34

8.2.3      Module xxotsf                                                                                                                                                                            34

8.2.4      Module xxoseq                                                                                                                                                                          35

8.3     ICS                                                                                                                                                                                                          36

8.3.1      Module xxi                                                                                                                                                                                  36

8.3.2      Module xxipan                                                                                                                                                                           37

8.3.3      Module xxidev                                                                                                                                                                           37

8.4     DCS                                                                                                                                                                                                        37

8.4.1      Engineering                                                                                                                                                                                37

8.5     MS                                                                                                                                                                                                          38

8.5.1      Maintenance Templates                                                                                                                                                           38

8.5.2      Module xxmcfg                                                                                                                                                                          38

8.5.3      Module xxmseq                                                                                                                                                                          38

8.5.4      Module xxmtsf                                                                                                                                                                           38

9 FAQ AND TROUBLESHOOTING                                                                                                                                                              39

9.1     Problems at System Start-up                                                                                                                                                              39

9.1.1      Log-in fails                                                                                                                                                                                 39

9.1.2      Start-up of GUIs fails                                                                                                                                                                39

9.1.3      Start-up of control processes fails                                                                                                                                         39

9.1.4      xxiControl starts with a wrong simulation level                                                                                                                    39

9.1.5      TCCD starts with a wrong simulation level and fails to go STANDBY                                                                            39

9.1.6      xxoControl tries to access sub-systems declared as not available                                                                                    39

9.1.7      Going ONLINE fails                                                                                                                                                                  39

9.2     Problems when running exposures                                                                                                                                                   40

9.2.1      Cannot send commands to TCS or access tif                                                                                                                       40

9.2.2      Templates cannot access Midas                                                                                                                                            40

10     ERROR DEFINITIONS                                                                                                                                                                           41

11     REFERENCE                                                                                                                                                                                             42

11.1    Programs                                                                                                                                                                                               42

11.1.1        Command Definition Table for program xxoControl                                                                                                        42

11.2    Scripts                                                                                                                                                                                                    43

11.2.1        xxinsStartup                                                                                                                                                                           43

11.2.2        xxinsStart                                                                                                                                                                                44

11.2.3        xxinsStop                                                                                                                                                                                46

11.3    Include Files                                                                                                                                                                                         48

11.4    Tcl libraries                                                                                                                                                                                           49

11.4.1        xxoseqICS                                                                                                                                                                               49

11.5    Configuration files                                                                                                                                                                               50

11.6    Setup files                                                                                                                                                                                             51

11.6.1        Example of  Reference Setup file                                                                                                                                         51

11.6.2        Example of Instrument Setup File                                                                                                                                       51

11.7    Templates                                                                                                                                                                                              52

11.7.1        IR Imaging acquisition template                                                                                                                                         52

11.7.2        IR Imaging observation template                                                                                                                                       53

11.7.3        IR Spectroscopy acquisition template                                                                                                                               54

11.7.4        IR Spectroscopy observation template                                                                                                                             55

11.7.5        Optical Imaging acquisition template                                                                                                                                56

11.7.6        Optical Imaging observation template                                                                                                                               57

11.7.7        Optical Imaging bias calibration template                                                                                                                         58

11.7.8        Optical Imaging flat-field calibration template                                                                                                                  59

11.7.9        Optical Imaging detector linearity calibration template                                                                                                  60

11.7.10      Optical Imaging focus calibration template                                                                                                                      61

11.8    FITS files                                                                                                                                                                                               62

11.8.1        Example of FITS header                                                                                                                                                       62

11.9    Log files                                                                                                                                                                                                 63

11.9.1        Example of Operational Log (FITS format)                                                                                                                        63

11.10  Panels                                                                                                                                                                                                    64

11.10.1      OS Control                                                                                                                                                                             64

11.10.2      OS Status                                                                                                                                                                               65

11.10.3      OS Engineering                                                                                                                                                                     66

11.10.4      ICS stand-alone                                                                                                                                                                     68

11.11  Error files                                                                                                                                                                                               70

11.11.1      xxoErrors.h                                                                                                                                                                             70

11.11.2      xxo_ERRORS                                                                                                                                                                         71

Appendix A. Create a new Instrument