Astronomers Proposal Tool (APT)
The Astronomer's Proposal Tool (APT) is the tool used to design observing programs for the Nancy Grace Roman Space Telescope.
APT Overview
The Astronomers Proposal Tool (APT) has been in use as an observation planning tool for HST and JWST; it now includes options for the Roman Space Telescope. APT is a stand-alone GUI-based software package used by proposers to write, validate, and submit observing programs. APT runs on your local machine, but accesses various tools and databases over the internet for performing certain tasks.
In most of the fields in the APT graphical interface, you choose a keyword or parameter in a list from a pull-down menu, or check a box. In a few other fields you enter free text in the field using the formats specified in this document. If you haven’t selected or entered a value then required items are marked with a value icon. Also, for many of the keywords, a ToolTips message will appear when you place your pointer on the keyword: red X area. value
Current Version of APT
APT is used for multiple missions in operations (both HST and JWST) and the Roman mission is under active development. Thus, the APT software is updated on a regular basis to reflect the most current knowledge of on-going missions and to reflect development status of the Roman mission. APT version 2024.2 is the most current release that has Roman features enabled. Documentation on the Roman APT User's Guide (RAUG) is up-to-date for this version. Changes to the technical details and other specifications presented here are expected as a part of the process of defining the Core Community Surveys. Thus, some of the specific technical implementations of some options are expected to change.
Working with program files
To create a new Roman observation, click New Roman Proposal in File menu.
To save a draft program as a local file, click Save on the File menu.
To open a draft program, click Open on the File menu.
To send an approved program to STScI, Submit the Program.
To retrieve and open an approved program from STScI, on the File menu click Retrieve from STScI > Retrieve using Proposal ID, then enter the Program ID.
Demonstration programs
Demonstration programs are available from the APT File menu. Demonstration programs may be useful as models or examples for learning APT or for creating your own programs.
Currently only one demonstration program is available, but more will be added.
Getting help
Documentation
Available documentation for Roman include the following Handbooks:
Additional documentation for Roman is under development.
Formatting in the Roman APT User Guide
Special formatting is used throughout the Roman APT User Guide to help identify specific aspects of APT as described in the table below. Additionally, hovering a cursor over the graphic associated with each type of formatting will provide the name of the formatting.
Roman APT User Guide Formatting Table
Example | Hover-text Name | Explanation |
---|---|---|
parameter | APT Parameter Field | The name of a parameter in the APT tool. |
value | APT Value Field | A value that can be selected from a list of options for a given parameter. |
range | APT Range Field | This is used to specify the allowed range of numerical values for a given parameter. |
restricted | APT Restricted Field | These are APT fields that users generally do not need to access, such as calibration specific fields. |
warning | APT Warning | Formatting denoting items which will cause an APT warning, also indicated in the APT software by a yellow triangle. |
error | APT Error | This formatting marks items which will cause an APT error, also indicated in the APT software by a red X. |
Context-Sensitive Help
APT provides context-sensitive help for most parameters. To use context-sensitive help, hover over the name of the parameter in the APT form. If help is available, a question mark icon will appear. Click the question mark to show help for the parameter.
Context-Sensitive Help is not yet enabled in APT for Roman.
APT errors and warnings
and Warnings generated by APT are intended to help users identify and resolve problems or inconsistencies. Hover the cursor over these icons for pop-up help with a short description. You can also get summaries of these messages by clicking the Errors and Warnings icon on the top tool bar or the “errors and warnings” box at bottom right in the GUI. error messages