AUSTRALIAN NATIONAL UNIVERSITY   Software Maintenance Manual   Created: 23 February 2001 Last modified: 21 March 2001

 

SOFTWARE MAINTENANCE MANUAL

 

Mark Jarnyk and Peter Young

 

Research School of Astronomy and Astrophysics

Institute of Advanced Studies

Australian National University

 

Revision History

 

 

 

Contents

 

1 Purpose. 3

2 Applicable Documents. 3

3 Introduction. 3

4 System Overview.. 3

5 Software Design. 3

6 Software Implementation Detail 4

7 File Organization. 6

8 Software Building Instructions. 6

9 Software Configuration. 7

10 Starting the NIFS Software. 7

11 Testing and Verification. 7

12 Software Operation. 8

13 Appendix: Listings. 10

 

 [Note: in the final document, the table of contents will be to third level]

 

1 Purpose

 

The Software Maintenance Manual describes the procedures for installation and maintenance of the software for the Gemini Near-infrared Integral Field Spectrograph (NIFS).

 

2 Applicable Documents

 

 

 

3 Introduction

 

Section 19.4.3 of the document “Programmatic Requirements for Gemini Instrumentation Development” states the requirements for the Software Maintenance Manual.

 

This manual should describe the software at a sufficient level of detail so that a programmer familiar with the Gemini environment, but not initially familiar with the software, can maintain it properly. It should include:

·         Detailed written descriptions of all software systems and sub-systems.

·         Systems analyses.

·         Data flow diagrams.

·         Data dictionaries.

·         Structure charts.

·         Specifications.

·         Listings of all software including firmware (DSP code).

 

3.1 Scope

 

This section will include an identification of the system. It will summarize the purpose and content of the manual, and indicate the intended audience.

 

4 System Overview

 

4.1 Software Application

 

A brief description of the intended uses of the software – what it does.

 

4.2 Software Environment

 

Identifies the hardware, software, manual operations, and all other resources needed to perform the actions described in this manual. This will include things such as:

1. Computer equipment required, the amount of memory needed, disk-space required, peripheral devices etc.
2. Operating System (version etc.).
3. Support software systems (DHS etc.).

 

5 Software Design

 

5.1 Software Architecture

 

5.2 Instrument Sequencer

 

5.3 Components Controller

 

5.4 OIWFS Components Controller

 

5.5 Detector Controller

 

6 Software Implementation Detail

 

6.1 Instrument Sequencer

 

6.1.1 Databases

 

6.1.1.1 CAD/CAR

 

6.1.1.2 Status and Alarm

 

6.1.2 SNL Code

 

6.1.3 C Code

 

6.2 Components Controller

 

6.2.1 Databases

 

6.2.1.1 CAD/CAR

 

6.2.1.2 Status and Alarm

 

6.2.1.3 Mechanism

 

6.2.1.4 Temperature

 

6.2.2 SNL Code

 

6.2.3 C Code

 

6.2.3.1 Records

 

6.2.3.2 Device Handlers

 

6.2.3.3 Drivers

 

6.2.3.4 CAD Record Support Routines

 

This section will contain snam & inam stuff etc.

 

6.3 OIWFS Components Controller

 

6.3.1 Databases

 

6.3.1.1 CAD/CAR

 

6.3.1.2 Status and Alarm

 

6.3.1.3 Mechanism

 

6.3.2 SNL Code

 

6.3.3 C Code

 

6.3.3.1 Records

 

6.3.3.2 Device Handlers

 

6.3.3.3 Drivers

 

6.3.3.4 CAD Record Support Routines

 

This section will contain snam & inam stuff etc.

 

6.4 Detector Controller

 

6.4.1 Databases

 

6.4.1.1 CAD/CAR Database

 

6.4.1.2 Status and Alarm Database

 

6.4.2 SNL Code

 

6.4.3 C Code

 

6.4.3.1 Records

 

6.4.3.2 Device Handlers

 

6.4.3.3 Drivers

 

6.4.3.4 CAD Record Support Routines

 

This section will contain snam & inam stuff etc.