|
|
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
---
VLT
Instrumentation Software
Template
for Software Management Plan
Doc. No.: VLT-PLA-ESO-17240-3786
Issue: 1
Date: 30/09/2005
Name Date Signature
Prepared: A.Longinotti 30/09/2005
Name Date Signature
Approved: K.Wirenstrand
Name Date Signature
Released: M.Cullum
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 |
|
All |
First issue |
|
|
|
|
|
TABLE OF CONTENTS
TABLE OF CONTENTS 3
1 INTRODUCTION 4
1.1 PURPOSE 4
1.2 Scope 4
1.3 Applicable Documents 4
1.4 Reference Documents 5
1.5 Abbreviations and Acronyms 5
1.6 Glossary 6
1.7 Stylistic Conventions 6
1.8 Naming Conventions 6
1.9 Problem Reporting/Change Request 6
2 PROJECT PHASES 7
2.1 Analysis 7
2.2 Design 7
2.3 Implementation 7
2.4 Integration 8
2.5 Assembly, Integration and Verification 8
2.6 Commissioning 8
3 PROJECT ORGANISATION 9
4 Traceability matrix 10
This document aims to
provide Instrument Software Managers with a template of the Instrument Software
Management Plan (ISMP) document. Instrument specific ISMP documents should be based
on this template. They should contain at
least the structure and information described herein (whenever applicable),
and possibly add instrument specific parts.
In the present
document, XXXX is used to indicate the name of a generic instrument.
Paragraphs in italics should be removed or at least adapted to the
specific instrument.
The purpose of this document is to describe the Management Plan of the XXXX Control Software. [ISMP02]
It is based in what defined in [AD 06] and [AD 02]
In order to trace more easily all requirements, all major points described here have a numbered tag: [ISMP nn].
This document shall be
reviewed at the Preliminary Design Review (PDR). It shall be part of the PDR
data package. It shall be kept up-to-date and be included in all following
reviews (FDR, PAE).
This document defines the Management Plan of the XXXX Control Software only. It covers only the Software part of an Instrument Project. The overall Project Management Plan is described in [RD 01]
The following documents, of the exact issue shown, form a part of this document to the extent specified herein. In the event of conflict between the documents referenced herein and the contents of this document, the contents of this document shall be considered as a superseding requirement.
|
Reference |
Document Number |
Issue |
Date |
Title |
|
VLT-SPE-ESO-xxxxx-xxxx |
1 |
xx/xx/xxxx |
XXXX Technical Specification |
|
|
VLT-SPE-ESO-17212-0001 |
5 |
|
Instrumentation Software Specification |
|
|
VLT-SPE-ESO-17240-0385 |
4 |
|
INS Common Software Specification |
|
|
VLT-SPE-ESO-10000-2723 |
1 |
|
VLT Requirements for Scientific Instruments |
|
|
VLT-PRO-ESO-10000-0228 |
1 |
|
VLT Software Programming Standards |
|
|
VLT-PLA-ESO-00000-0006 |
2 |
|
VLT Software Management Plan |
|
|
VLT-ICD-ESO-17240-19200 |
1.3 |
|
ICD between VCS and OH |
|
|
VLT-ICD-ESO-17240-19400 |
2.6 |
|
ICD between VCS and Archive |
|
|
VLT-PLA-ESO-10000-0441 |
1.0 |
|
VLT Science Operation Plan |
|
|
GEN-SPE-ESO-19400-0794 |
3 |
|
Data Interface Control Document |
|
|
VLT-SPE-ESO-xxxx-xxxx |
1 |
xx/xx/xxxx |
XXXX Control Software User Requirements |
The following documents are referenced in this document.
|
Reference |
Document Number |
Issue |
Date |
Title |
|
VLT-PLA-ESO-xxxx-xxxx |
1 |
xx/xx/xxxx |
XXXX Project Management Plan |
|
|
VLT-MAN-ESO-17200-0981 |
2 |
|
VLT Problem Report Change Request User |
|
|
VLT-MAN-ESO-17240-1973 |
5 |
|
Template Instrument User and Maint.Manual |
|
|
VLT-PLA-ESO-17240-2266 |
5 |
|
INS Acceptance Test Plan Template Document |
1.5 Abbreviations and Acronyms
The contents of this
section must be adapted to contain only the abbreviations and acronyms actually
used within the document.
This document employs several abbreviations and acronyms to refer concisely to an item, after it has been introduced. The following list is aimed to help the reader in recalling the extended meaning of each short expression:
|
AIV |
Assembly, Integration and Verification |
|
API |
Application Programmatic Interface |
|
ATP |
Acceptance Test Plan |
|
CCS |
Central Control Software |
|
CPU |
Central Processing Unit |
|
DCS |
Detector Control Software |
|
DICB |
ESO Data Interface Control Board |
|
FDR |
Final Design Review |
|
FITS |
Flexible Image Transport Format |
|
GUI |
Graphical User Interface |
|
HW |
Hardware |
|
HOS |
High Level Operating Software |
|
ICS |
Instrument Control Software |
|
IEE |
Institution of Electrical Engineers ( |
|
IEEE |
Institute of Electrical and Electronics Engineers ( |
|
INS |
Instrumentation Software |
|
ISDD |
Instrument Software Design Description |
|
ISFS |
Instrument Software Functional Specification |
|
ISMP |
Instrument Software Management Plan |
|
ISURS |
Instrument Software User Requirements Specification |
|
ISUMM |
Instrument Software User and Maintenance Manual |
|
IWS |
Instrument Workstation |
|
LAN |
Local Area Network |
|
LCC |
LCU Common Software |
|
LCU |
Local Control Unit |
|
MS |
Maintenance Software |
|
MTBF |
Mean Time Between Failures |
|
MTBS |
Mean Time Between Service |
|
N/A |
Not Applicable |
|
|
Observation Block |
|
OLDB |
On-Line DataBase |
|
OMT |
Object Modeling Technique |
|
OO |
Object Oriented |
|
OS |
Observation Software |
|
|
Observer Support Software |
|
PAE |
Preliminary Acceptance |
|
PAF |
Parameters File |
|
PDR |
Preliminary Design Review |
|
SOS |
Supervisory Observation Software |
|
SW |
Software |
|
TBC |
To Be Clarified |
|
TBD |
To Be Defined |
|
TCCD |
Technical CCD |
|
TCS |
Telescope Control Software |
|
TSF |
Template Signature File |
|
UIF |
(Portable) User Interface (Toolkit) |
|
UNIX |
Trademark of Bell Laboratories (operating system) |
|
VLT |
Very Large Telescope |
|
VME |
Versa Module Eurocard |
|
WS |
Workstation |
|
|
|
The following is defined in [AD 02]:
Ø Exposure
Ø Integration
Ø Instrument Mode
Ø Instrument Workstation
The following is defined in [AD 07]:
Ø Observation Block
Ø Template
Ø Template Signature File
The following is defined in [AD 03]:
Ø Setup file
Ø Short Hierarchical Format
The following is defined in [AD 11]:
Ø User
The following styles are used:
bold
in the text, for commands, filenames, pre/suffixes as they have to be typed.
italic
in the text, for parts that have to be substituted with the real content before typing.
teletype
for examples.
<name>
in the examples, for parts that have to be substituted with the real content before typing.
bold and italic are also used to highlight words.
This implementation follows the naming conventions as outlined in [AD 03].
1.9 Problem Reporting/Change Request
The form described in [RD 02] shall be used.
During this phase the User Requirements (see [AD 11]) are studied. Taking also into account the rules and
guidelines specified in the VLT Instrumentation Software Specification (see [AD 02]), the Instrument Software Functional Specification
(ISFS) document is produced. The ISFS document is reviewed at PDR. [ISMP03]
The following activities are performed as part of the analysis
phase [ISMP01]:
- The Template Instrument is built on each development WS and the available test procedures, described in [RD 04], are executed.
- A skeleton of the Instrument Software is created as copy of the Template Instrument (see [RD 03]) and runs properly.
- Compatibility between Instrument
performance requirements and usage of the VLT common Software are verified.
This phase shall take from PDR till FDR, foreseen xx/xx/xxxx.
The design provides the input to the implementation and test of the modules. It defines:
- The overall architecture of Software (LAN, computers, environments)
- The installation and startup/shutdown procedures
- The functions provided and their implementation (algorithms).
- The software interfaces to other modules.
- The User Interface (at least a draft on paper of the most important panels).
- Prototypes of critical issues.
- The list of ICS devices, in particular the special ones, justifying for each of them why a standard device cannot be used instead.
- The list of OS and MS templates
- What has to be tested and in which way.
During the design phase the following activities will be completed [ISMP06]:
- Adapt the skeleton of the Instrument Software, as a copy of the Template Instrument, to the actual instrument configuration, in particular:
- Not applicable sub-systems (e.g. detectors) are removed
- Not applicable ICS devices are removed
- Special code, delivered with the Template Instrument as implementation examples, is removed
- ICS devices belonging to the new instrument are added.
- Critical prototypes code has been
implemented and tested.
The outputs of the design phase are the Instrument Software Design Description (ISDD) and the Test Procedure of each module, described in the Instrument Software Acceptance Test Plan (ATP) document.
The ISDD is part of
the FDR data package. The first
draft of will be submitted to ESO for review two months before the official FDR deadline for documentation, to
allow a few iterations. [ISMP04]
A first draft of the
ATP document, describing the foreseen test procedures, shall also be reviewed
at the FDR [ISMP05].
It will last from FDR till the beginning of integration, at present foreseen xx/xx/xxxx.
For each module, the implementation consists of:
- Developing the code for all the functions.
- Testing of the code as an independent part.
- Developing the code for all test programs used in the Integration phase (and completion of the Test Procedures).
- Documenting the code, updating the associated documentation, with sufficient detail to allow the code maintenance by other engineers. It is recommended to keep documentation aligned to the code as the different modules are archived, to make sure that documentation details match the actual code.
During this phase, every two months at every development location, the Instrumentation Software will be rebuilt from scratch and the automatic test procedures executed. The ESO contact person will take care to do the same in the VLT Control Model facility, thus taking the occasion to review the current status of the Control Software [ISMP09].
This phase is part of the more general integration process of the instrument. It will last from xx/xx/xxxx till PAE, at present foreseen xx/xx/xxxx.
During this phase the test software plays an essential role.
Every two months at every location, the Instrumentation Software will be
rebuilt from scratch and the automatic test procedures executed. The ESO contact person will take care to do the same in the VLT Control Model
facility, thus taking the occasion to review the current status of the
Control Software.
At the end of the integration phase, the instrument will be ready for Preliminary Acceptance Europe. The following documentation are part of the PAE data package:
- Instrument Software User and
Maintenance Manual (ISUMM)
- Instrument Software Acceptance Test
Plan (ATP)
A draft of each of them will be submitted to ESO for review two months before the official PAE deadline for documentation, to allow a few iterations [ISMP07].
The Instrument
Software Acceptance Report will be produced, by ESO and the Consortium, as
result of the instrument PAE [ISMP08].
The Observatory personnel is supposed to be involved at least at the end of this phase and for the PAE run.
2.5 Assembly, Integration and Verification
This phase includes all activities, mainly of technical
nature, which take place at the Observatory site and which shall bring the
Instrument to the same operational conditions and performances measured at PAE
in
It will last from the xx/xx/xxxx till xx/xx/xxxx.
All measurements and
activities (e.g. alignment, noise measurements etc.) carried out during this
phase shall be performed by technical templates.
During this phase, the Observatory personnel will be involved as support to the consortium team.
This phase includes all final tests, mainly of scientific nature, which are foreseen to decide if the Instrument is ready to enter regular operations. At present it is foreseen to have two commissioning runs:
- Commissioning 1 from xx/xx/xxxx till xx/xx/xxxx
- Commissioning 2 from xx/xx/xxxx till xx/xx/xxxx
At the end of this phase, the Instrument, including its Software and the related final documentation, is handed over to the Observatory.
All measurements and activities (e.g. alignment, noise measurements etc.) carried out during this phase shall be performed by technical templates.
Describe here who does
what where.
The contents of this
section, in the same details, may already be part of [RD 01]. If this is the case, it is enough to refer here to
that document.
The development of the Control Software will take place at the following locations:
1. Observatory of AAA
Responsibility: OS, MS, Integration
Personnel:
· N.Surname1
· N.Surname2
Computers needed:
· One VLT standard development WS
· The ICS LCU (starting from the integration phase)
· The DCS SLCU (starting from the integration phase)
2. Observatory of BBB
Responsibility: ICS.
Personnel:
· N.Surname3
· N.Surname4
Computers needed:
· One VLT standard development WS
· One standard target LCUs equipped with the following boards:
a. CPU board
b. …..
The LCU shall be shipped to Observatory of AAA in time for the integration phase
3. Observatory of CCC
Responsibility: DCS.
Personnel:
· N.Surname5
Computers needed:
· One VLT standard development WS
· One standard FIERA SLCU WS.
The SLCU shall be shipped to Observatory of AAA in time for the integration phase
· One standard IRACE SLCU WS.
The SLCU shall be shipped to Observatory of AAA in time for the integration phase
The following table aims to set a link between the
requirements defined in [AD 02] and the contents of this document.
|
Req. |
DOC. |
LABEL |
PAGE |
DESCRIPTION |
|
INS11 |
[AD 02] |
ISMP01 |
7 |
Use
Template Instrument to build a new instrument from scratch |
|
INS119 |
[AD 02] |
ISMP02 |
4 |
Software
activities included in the Instrument Software Management Plan |
|
INS120 |
[AD 02] |
ISMP03 |
7 |
Instrument
Software User Requirements document reviewed before PDR |
|
INS121 |
[AD 02] |
ISMP03 |
7 |
Freeze
Software User Requirements at PDR |
|
INS122 |
[AD 02] |
ISMP03 |
7 |
Review
Software Functional Specification at PDR. Recommended a few iterations before |
|
INS123 |
[AD 02] |
ISMP01 |
7 |
Before
PDR run Template Instrument, build Instrument Software skeleton, check
performances |
|
INS124 |
[AD 02] |
ISMP04 |
7 |
Review
Software Design document(s) at FDR. Recommended a few iterations before |
|
INS125 |
[AD 02] |
ISMP05 |
7 |
Review
Acceptance Test Plan document at FDR. |
|
INS126 |
[AD 02] |
ISMP06 |
7 |
Before
FDR Instrument skeleton according to actual configuration, no code except for
prototypes |
|
INS128 |
[AD 02] |
ISMP07 |
8 |
Accept.
Test Plan, User and Maintenance manual ready for PAE. Recommended a few
iterations before |
|
INS129 |
[AD 02] |
ISMP08 |
8 |
Acceptance
Test Report produced as result of PAE |
|
INS130 |
[AD 02] |
ISMP09 |
7 |
Agree
with ESO intermediate check points between FDR and PAE |
|
INS131 |
[AD 02] |
ISMP09 |
7 |
PAE at
integration premises and in the VLT Control Model |
___oOo___