APPROVAL SHEET. SYNOPSIS : This document describes the software requirements for the PI planning tools software of the TCS.

Transcription

1 APPROVAL SHEET TITLE : TCS PI Planning Tool Software Specification DOCUMENT NUMBER : 1732AS0004 ISSUE: C SYNOPSIS : This document describes the software requirements for the PI planning tools software of the TCS. KEYWORDS : PREPARED BY : E. Romero Colmenero APPROVED : Gerhard Swart SALT Systems Engineer Kobus Meiring SALT Project Manager Engineer DATE : June 2003 This issue is only valid when the above signatures are present. Printed: :19 Doc No. SALT-1732AS0004 Issue B 1

2 ACRONYMS AND ABBREVIATIONS ATP ATR BITE BMS CCD CDR COTS HET I/O ICD MMI MTBF MTTR OEM PC PDR PFIS PI PLC RT SA SALT SDD SDP SO SPCT SRS SW TBC TBD TCS VI PIPT OPT ODB SDB Acceptance Test Procedure Acceptance Test Report Built-in Test Equipment Building Management System Charge-coupled Device (Camera) Critical Design Rview Commercial off the shelf Hobby-Eberly Telescope Input/Output (Device) Interface Control Dossier Man-Machine Interface Mean Time Between Failures Mean Time to Repair Original Equipment Manufacturer Personal Computer Preliminary Design Review Prime Focus Imaging Spectrograph Principal Investigator (Astronomer) Programmable-Logic Controller Real-time SALT Astronomer Southern African Large Telescope Software Design Document Software Development Plan SALT Operator Single-point Communication Test Software Requirement Specification Software To Be Confirmed To Be Determined Telescope Control System Virtual Instrument (Labview function) PI Planning Tool Observation Planning Tool Observation Planning Database Science Database Doc No. SALT-1732AS0004 Issue B 2

3 DEFINITIONS Doc No. SALT-1732AS0004 Issue B 3

4 TABLE OF CONTENTS 1 Scope Referenced Documents Customer Furnished Equipment and Responsibilities Functional Requirements Phase I planning tool Basic information...8 a) Inputs...8 b) Outputs Basic Instrumentation information...8 a) Input...8 b) Output Phase I proposal form Input Fields Phase II planning tool Basic information Detailed instrument configuration...9 a) Input...9 b) Output...9 c) Multi-slit tool Phase II proposal form Summary of further PI input fields Technical Requirements Software Context External Interfaces PIPT - SDB PIPT Catalogues Software Capabilities Communication Capability Display Capability Storage Capability Calculation Capability Simulation Capability Graphical User Interface Operating System Resource Allocation Generic Software Requirements Software Testing Verification cross-reference matrix Detailed Test Requirements...13 Doc No. SALT-1732AS0004 Issue B 4

5 1 Scope This document specifies the requirements for the PI Planning Tool (PIPT) Software item of the SALT Telescope Control System (TCS). The purpose of this software is to enable the PI to investigate if and when a particular object is visible by SALT and to plan his/her observation details accordingly. It will also allow the PI to submit a proposal over the internet, receive acknowledgements of receipt and produce hardcopies. The PIPT will input proposal details into the Science Database (SDB). This software will be run in two phases, Phase I and Phase II. It is futher subdivided into four subprograms: Phase I PI planning tool, Phase I proposal form, Phase II planning tool, Phase II proposal form. These sub-programs will all be integrated within the same tool. 2 Referenced Documents The following documents are referenced in this specification and are applicable to the extent specified herein. 1000AA AB AD AS BP AS AS AS AS0003 SALT Safety Analysis SALT Labview Coding Standard SALT Computer Architecture SALT Operational Requirements TCS Development Plan TCS Specification TCS Interlock Panel Specification SALT Data Interface Control Dossier TCS Science Database Software Specifications 3 Customer Furnished Equipment and Responsibilities This software will require detailed information of all the instrumentation capabilities and different modes of operation of all of the available instruments on SALT in order to enable the PI to make accurate estimates of the exposure times required for a required signal to noise ratio. It will further require information regarding timescales changing from one instrument configuration to another in order to estimate the actual required track length. This software will require a version of the TCS pointing model, to be shared with the Observation Planning Tool (OPT). It will require pupil filling and vignetting information in order to estimate accurately the exposure times and/or signal-to-noise requirements for a particular observation. This sofware will require input/output access to the Science Database (SDB) via the proposal forms. 4 Functional Requirements This software will be downloadable by the PIs and run in their own PCs. The PIPT will comprise 4 programs, which must be able to communicate with each other and share information as required: Doc No. SALT-1732AS0004 Issue B 5

6 o Phase I planning tool o Phase I proposal form o Phase II planning tool o Phase II proposal form These four programs will share information as required. They will log all operations on the PI s own hard disk, which will be made available to the PI for viewing/editting at any time and in any operating system. The PI must be able to work on his/her proposal offline, and connect to the internet only occassionally: o For downloading of the PIPT o For submitting the Phase I proposal o For downloading finding charts for each of his/her targets using the Phase II planning tool o For submitting the Phase II proposal The PI will also be able to request Phase I information of his/her approved proposal to the SDB if necessary. 4.1 Phase I planning tool See Figure 1 for a high-level Phase I planning tool functional diagram. Doc No. SALT-1732AS0004 Issue B 6

7 Figure 1: PIPT Phase I planning tool high-level functional diagram Doc No. SALT-1732AS0004 Issue B 7

8 There will be 2 sections on this: Basic information a) INPUTS i. RA, Dec, Equinox of the object (including proper motions). ii. Observation date (optional). b) OUTPUTS i. Plot of maximum track length vs. date, with Moon information (zoom in and zoom out capabilities) ii. Best observing date (ie date of maximum track time). iii. Maximum tracking time for requested date (best observing time if no date requested) iv. Moon brightness and distance to object (also in plot). v. Best azimuth for observation (useful?) vi. A plot of the path of the tracker and/or pupil over the primary mirror vii. An estimate of exposure time lost through underfilling the pupil through the track Basic Instrumentation information a) INPUT Some of the information can be taken from the input/output of the basic information section, or input afresh by the PI. Here are is a list of fields required: i. Target brightness. ii. Basic instrument configuration iii. Estimate of sky brightness iv. Either an unvignetted exposure time or a S/N requirement v. Estimate of seeing vi. Estimate of sky transparency b) OUTPUT i. Required exposure time or S/N (assuming 100% pupil fill). 4.2 Phase I proposal form The Phase I proposal form will look like a web proposal form. It will: o allow the PI to prepare and submit a proposal on-line, to save and exit at any stage for later continuation and to submit the proposal. o While the proposal is being prepared, it will be stored inthe hard-disk of the PI. o When the PI attempts to submit the proposal, the PIPT will perform some basic viability checks: o If the proposal passes the tests, it will be stored in the SDB and the PI will no longer be able to modify it. o If the proposal fails the tests, it will indicate the reason for the failure and give the PI two choices: Continue to submit: in this case, the proposal will be submitted but a flag will be added to the information to indicate the reason(s) for its failure. This reason will be made known to the TACs. Further modify the proposal: in this case, submission is cancelled and the PI has a chance to correct his/her proposal (eg. from accidental input of wrong coordinates). o The PI will receive confirmation of submission Input Fields These are the suggested fields for the Phase I proposal form: Doc No. SALT-1732AS0004 Issue B 8

9 i. PI s name, institution and contact details ii. Co-Is names, addresses and institutions iii. Observing time distribution amongst participating insitutions (if required) iv. Title of proposal v. Abstract vi. Scientific Justification vii. ToO/time restricted proposal? viii. Total time (ksec) requested ix. Input list of targets (if available) with basic details for each: Target name Target coordinates (if multi-object proposal, coordinates of centre of the field) for the different pointings Type of source (drop-down list) Magnitude (range) Whether the calibration data can be shared with other PIs with same configuration (eg. in the case of a standard). Basic instrument configuration (drop-down list). Extra night-time calibrations required (eg. sky flats, arcs) s/n required exposure time required limiting weather requirements (seeing, sky transparency and magnitude) 4.3 Phase II planning tool This will become essential on acceptance of a Phase I proposal. Its primary function is to allow the PI to prepare detail information about his/her projected observations: Basic information This is essentially the same as for the Phase I planning tool. It will now be used by the PI to plan timerestricted observations in detail (eg. during specific dates) if required Detailed instrument configuration a) INPUT i. Detailed instrument configuration with exposure sequential information -> it will be built into a script. ii. Target brightness iii. Estimate of sky brightness iv. Estimate of seeing v. Estimate of sky transparency vi. Either an unvignetted exposure time or a S/N requirement vii. Mark on finding chart the target(s) and the standard b) OUTPUT i. Depending on input, either the resulting s/n or the required exposure time. ii. Estimate acceptable image quality (if required) iii. Estimate minimum exposure time and/or number of exposures (eg. time series) iv. Estimate total exposure time required and minumum S/N v. A finding chart in FITS format per target with WCS with the target and guide star clearly marked, ready for direct inclusion in the Phase 2 proposal vi. An observation script ready for inclusion into the Phase II proposal. c) MULTI-SLIT TOOL As part of the PFIS configuration, there will be an extra tool to allow the PI to configure his/her multi-slit Doc No. SALT-1732AS0004 Issue B 9

10 observation. 4.4 Phase II proposal form The Phase II proposal form will look like the Phase I proposal form with many more target and instrument configuration details. It will: o allow the PI to prepare and submit a proposal on-line, to save and exit at any stage for later continuation and to submit the proposal. o Allow the PI to connect to the SDB and request details of Phase I proposal details o While the proposal is being prepared, it will be stored on the hard-disk of the PI. o When the PI attempts to submit the proposal, the PIPT will perform some basic viability checks: o If the proposal passes the tests, it will be stored in the SDB and the PI will no longer be able to modify it. o If the proposal fails the tests, it will indicate the reason for the failure and give the PI two choices: Continue to submit: in this case, the proposal will be submitted but a flag will be added to the information to indicate the reason(s) for its failure. This reason will be made known to the TACs. Further modify the proposal: in this case, submission is cancelled and the PI has a chance to correct his/her proposal (eg. from accidental input of wrong coordinates). o The PI will receive confirmation of submission Summary of further PI input fields Further details per target: i. Target grouping (eg. if standard required immediately before/after the science target) ii. Target priority/order iii. Finding chart with target(s) clearly marked (MOS) iv. Observing date restrictions (if required) v. Detailed instrument configuration (including Multi-Slit details if required). 5 Technical Requirements 5.1 Software Context Figure 2 shows a schematic diagram of the PIPT software context. Doc No. SALT-1732AS0004 Issue B 10

11 Figure 2: PIPT context What follows is a description of the diagram: o The PIPT will be downloaded by the PI from the SALT website to the PI s own computer. o The PIPT will interact with the SDB software of the TCS in order to populate the SDB proposal fields, although there is a firewall that must be tunelled through in order to access the SDB from the outside world. o The PIPT will be able to read from the firewall Phase I information if necessary, once the proposal has been approved. 5.2 External Interfaces PIPT - SDB o The PIPT will communicate with the SDB using a MySQL interface via a tunnel in the firewall. o The access to the SDB will be password protected. Doc No. SALT-1732AS0004 Issue B 11

12 o This access will be write-only during Phase I preparation/submission, and read-write during Phase II to allow the PI to read his/her Phase I details if required (NB there should already be a copy of these details in the PI s hard disk). o The data transferred will be in ASCII format (RTML). Its update rate will be sporadic, at the request of the PI via buttons on his proposal forms. The data indicated here is for information only. The most current data will be in the PIPT Design Document PIPT Catalogues o The PIPT will require access to on-line image servers (eg. Digitized Sky Survey) for finding chart preparations. 5.3 Software Capabilities Communication Capability o Input/output access to the planning database will be through a password-protected MySQL connection which will somehow tunnel through the firewall. o It will only require updating at the request of the PI via a submit or upload button o It will need to communicate with an online catalogue image server for downloading of a raw finding chart. o Exceptions to the above shall only be allowed with approval of the SALT Systems Engineer Display Capability o This software will allow the display of graphics (e.g. the path of the tracker over the primary mirror) and allow user interaction (e.g. zoom-in or out, mark the position of their observing target etc.). o The PIPT will display the results in the form of text, graphs and images Storage Capability The storage of the PIPT data will be: o on the hard disk of the PI in the form of a text file and some fits files the required disk space will depend strongly on the number of targets, as each will have its own FITS finding chart). o On the SDB Calculation Capability The PIPT will be fairly calculation-intensive. It will require the ability to perform double precision calculations Simulation Capability The PIPT must have the capability of simulating accurately both the telescope and the instrumentation. 5.4 Graphical User Interface The GUI for the PI Planning Software will be user-friendly, self-explanatory as far as possible, and with in-built help capabilities. Gerhard and David would like it to resemble as much as possible the GEMINI planning tool. 5.5 Operating System The PI Planning Software shall be platform independent. 5.6 Resource Allocation The PI Planning software shall be capable of performing its function on a PC with the following Doc No. SALT-1732AS0004 Issue B 12

13 specifications: GHz Pentium - 512MB memory - 17" Monitor x 1024 resolution 6 Generic Software Requirements o The PIPT will be written in Java 2 to ensure its independence from operating systems. o The PI Planning Software shall comply with the requirements specified in the SALT Software Standard as referenced in section Software Testing 7.1 Verification cross-reference matrix The software specified herein must be verified for compliance with this specification, as indicated in the table below. Where appropriate, detailed test methods have been defined in the next section. Spec. Para. Requirement Test Level [Note 1] Test Method [Note 2] Test Detail (see 7.2) 1 Scope N/A 2 Referenced Documents N/A 3 Customer Furnished Equipment and Responsibilities 4 Functional Requirements SI D/T 5 Technical Requirements N/A 5.1 Software Architecture SI R 5.2 Software Interfaces TCS D/T 5.3 Software Capabilities N/A Communication Capability SI D/T Display Capability SI D/T Storage Capability SI R Calculation Capability SI T 5.4 Graphical User Interface Requirements SI D 5.5 Operating System SI D 5.6 Resource Allocation SI T 6. Generic Requirements SI/SC R/D/T Note 1: Test Level defines the level of integration at which this particular requirement will be verified. This could be SC - Software Component (parts of this software on their own), SI - Software Item (this spec s software on its own), TCS (this software integrated with other parts of the TCS), System (this software working with the whole telescope). Note 2: Test method could be R- Review, D demonstrate (not quantitative or precise), T Test (most comprehensive). 7.2 Detailed Test Requirements Add specific tests, reviews or demonstrations here, if it known now, or if it makes the interpretation of the requirement clearer. Doc No. SALT-1732AS0004 Issue B 13