This document describes
how interface control documents (ICDs) are produced and approved. For the
purposes of interface control the NAOMI system, the William Herschel Telescope
(WHT) and supporting facilities have been divided into various “subsystems”
where the term “subsystem” has a very broad meaning. Section 3.0 lists these
subsystems together with brief definitions and comments where appropriate. The
project recognises that the subsystems defined for ICD purposes may not be
suited for other NAOMI applications and there is no requirement to conform to
this configuration for other applications. ICD formats for four types of interface are given in Section
4.0. Software interfaces will be addressed in a separate document.
All required interface documents associated with each subsystem are listed in matrix form in the document number AOW/GEN/RAH/4.1/02/98/ICD Matrix. The current version defines the type of document required, i.e. electronics, mechanical, optical, facilities and software. Document numbers will be added later using the numbering system defined in Section 5.0. Each organisation is responsible for consulting the ICD matrix and preparing the applicable ICD(s). As the subsystems have been divided partly along organisational lines, preparation of an ICD will usually involve working closely with another organisation. Responsibility for the division of effort should be determined by the organisations involved, with a goal of sharing the total load about equally. Administrative problems should be referred to the project manager.
Table 1 specifies the responsibility for initiating the various ICDs. (The ING has been omitted from the table to avoid placing an excessive burden on its resources.) Local managers are responsible for insuring initiation but they may delegate the effort. As an interim measure the ATC has been substituted for RGO as the new organisation responsible for the WFS. All references to ROE have been replaced by the ATC. The requirement for interface documents between the WFS and the OMC has been left intact partly to emphasise the need for these documents, even though they may become internal ATC documents, and partly to allow for any future division of responsibility of the WFS work. This document will be modified if necessary when the organisational responsibilities for the WFS work have been clearly defined.
Table 1. Responsibility for ICD initiation.
Initiator |
ICDs |
Durham |
a. DM to all other applicable subsystems. b. Electra to all other applicable subsystems c. RTCS to all applicable other subsystems except WFS-RTCS d. WFS to Electra. |
ATC |
WFS to all other applicable subsystems except Electra. |
RGO ATC |
Science instrument (INGRID) and its CIA All other subsystems not covered above. |
The applicable subsystems in Table 1 are determined from the ICD matrix (document number AOW/GEN/RAH/4.1/02/98/ICD Matrix).
The ICD formats given in Section 4.0 shall be followed. All items must be addressed but if not applicable they need not be included in the interface document . Note that the “Other Requirements” section may be used in circumstances where the interface is not adequately covered by the normal entries. Approval is required from a representative of each organisationinvolved and the project engineer. (In the case of the interfaces between the WFS and OMC the term “organisation” refers to the groups responsible for each subsystem.) The representative may be the local manager or he may assign this responsibility. The ‘User’ is represented by the Project Scientist. Areas of responsibility are indicated in brackets () after the subsystem name. Where two sites are given, both must agree the change but the first mentioned has the primary responsibility.
When an ICD is complete, the project engineer will place it in an appropriate area on BSCW.
Document number and version: ICD/ELE/mmm/#.#/month/yr/title
Purpose and scope:
Approved by (Organisation A): Date:
Approved by (Organisation B): Date:
Approved by (PE): Date
Protocols:
Data rate
Signal levels:
Power supply requirement:
Rack location:
Terminal type:
Shielding/earthing arrangement:
Type of cable(s):
Length of cable(s):
Minimum bend radius:
Harnessing requirements:
Responsibility for cable preparation:
Connector type(s) (incl. M/F):
Subsystem A numbered pin diagram(s) :
Subsystem B numbered pin diagram(s) :
Other requirements
Revision history
Document number and version: ICD/OPT/mmm/#.#/month/yr/title
Purpose and scope:
Approved by (Organisation A): Date:
Approved by (Organisation B): Date:
Approved by (PE): Date
Input beam requirements:
Co-ordinates relative to Nasmyth focus and optical axis:
f/ratio
Field size
Pupil location
Pupil size
Output beam requirements:
Co-ordinates relative to Nasmyth focus and optical axis:
f/ratio:
Field size:
Pupil location:
Pupil size:
Beam quality:
Alignment aids required:
Other requirements:
Revision history:
Document number and version: ICD/MEC/mmm/#.#/month/yr/title
Purpose and scope:
Approved by (Organisation A): Date:
Approved by (Organisation B): Date:
Approved by (PE): Date:
Interface drawing (attachment):
Materials of mating surfaces:
Surface finishes of mating surfaces:
Mounting procedure:
Degrees of freedom:
Adjustment tolerance(s):
Adjustment method:
Adjustment sequence (e.g. adj. A to B):
Adjustment technique
Differential temperature / thermal effect tolerance(s):
Any safety precautions required:
Other requirements:
Revision history
Document number and version: ICD/FAC/mmm/#.#/month/yr/title
Purpose and scope:
Approved by: Date:
Utilities:
Cooling system:
Power:
Air:
Dry nitrogen:
Helium:
Lighting:
Handling equipment:
Trolley:
Weight:
Crane:
Lifting tackle:
Storage:
Safety:
Communications:
Video links:
Audio:
Network(s):
Serial ports:
Bench location:
Modification to bench:
GHRIL roof:
Dust protection:
Light protection:
EMC protection:
Alignment equipment (e.g. micro-alignment telescope, interferometer):
Revision history:
The following numbering format shall be used:
ICD/nnn/mmm/#.#/month/yr/title (format sys1 to sys2)
where ICD replaces the standard AOW in the normal documentation system
nnn is one of OPT, MEC, ELE, FAC, SOF.
mmm is the author
#.# is document number and version by that author on that nnn topic
title should include the (two) subsystems whose interface is
being described, such as OMC to WFS, RTCS to DM.