Tool Kit Documentation

CASA Modification Request 15C108, November 2007



1. Introduction

There are two parts: (1) The CASA Reference Manual on the CASA web-page is essentially the Tool Reference Manual. While a lot of work has gone into this manual, it is still uneven in documentation quality and much of the manual description is still in the glish-orientated aips++ syntax, rather than the python-oriented casa syntax. (2) The on-line tool-kit help is extremely limited, and in many cases useless, so that a user must go to the reference manual for even simple questions.

2. Background

3. Requirements

Because the tool-kit is significantly more powerful than what is available in the tasks at present and for the next several years, it is important to document the tool-kit more effectively in three ways: (1) Complete the reference manual changeover from aips++ to casa; (2) Improve the on-line tool documentation from poor to at least mediocre; (3) Increase the visibility of using the tool-kit in the cookbook (coming along).

4. Design

5. Deployment Checklist

6. Test Plan

6.1 Internal Testing

6.2 Sponsor Testing

There is no testing. This is all documentation

6.3 Integration/Regression Tests

6.4 Testing for Scientific Validity

No real testing in the formal manner.


Signatures

APPROVED: I acknowledge that my request is fully contained in this MR, and if the CASA development group delivers exactly what I specified, I will be happy.

ACCEPTED: I acknowledge that I have validated the completed code according to the acceptance tests, and I am happy with the results.

Written - - - - -
Checked - - - - -
Approved by Scientific Sponsor - - - - -
Accepted/Delivered by Sponsor - - - - -

Symbols:
  • Use %X% if MR is not complete (will display ALERT!)
  • Use %Y% if MR iscomplete (will display DONE)


Discussion Area

-- NicoleRadziwill - 30 Oct 2007

-- EdFomalont - 06 Nov 2007
Topic revision: r3 - 2007-11-06, EdFomalont
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding NRAO Public Wiki? Send feedback