The Download Overlay is a component of the Mission Search forms that allows users to more finely control which files to download, and to select the method of download.
On this page...
Component Overview
This page describes the Download Overlay, used for selecting files to download.
Component Features and Functionality
A description of the Download Overlay: 'Select By Product Type', 'Select By Product Extension', 'Select By String Match', 'Download Button' (Download By Streaming To A Zip File), and the 'Show API Query Button' (Download Via A Script).
This filter shows or hides types of products based on their classification as defined by the Archive or mission pipelines. Examples include 'CALIBRATED', 'UNCALIBRATED', and 'REFERENCE'. Each option can be toggled on or off, displaying or hiding all products under that type from the overlay. When a type is selected, the background color changes to blue. After products are shown on the table, they need to be selected to be downloaded. Select rows using the checkboxes next to each Observation (dataset) or product displayed in the overlay. Alternatively, use 'SELECT ALL' to select all files or 'SELECT NONE' and then select individual files. As products are selected, the Observation count, file count, and total estimated download volume are updated at the top of the overlay.
By default, 'CALIBRATED' datasets are displayed and selected for download.
This video clip demonstrates how to choose products to display in the overlay based on the product extension.
Displaying Different Product Extensions
Another way to refine data, use the 'Extensions' drop-down. It is used to display products based on the product extension. Once clicking the menu, scroll through the available list of extensions and select those of interest to download. Alternatively, use 'SELECT ALL' or select individual extension after clicking 'SELECT NONE' inside the drop-down menu.
'Extension' here is referring to a suffix which indicates the type of data the file contains, not to a file extension. For example, if a file ends in '_x1d.fits', the product extension is 'x1d' (which is a suffix based on data type containing calibrated science spectra) while the file extension is 'fits'.
There are various product extensions depending the instruments of each Mission. For HST data, see the HST User documentation page for its filename format convention.
The string search box in the Download Overlay can be used to match product names, instruments, and filters/gratings. This can be used to further refine the displayed list of products for easy selection to download. This search box offers type-ahead functionality. For example, the search box can be used to display only "txt" file extension type by entering ".txt" into the search box, which will only display products that include the string. It is not limited to file types, any string in a file name can be searched. These can then be selected using the selection checkboxes to include in the download. Also, 'SELECT ALL' and 'SELECT NONE' are enabled.
To select only files which contain a specific string, make sure to click 'SELECT NONE' next to this string search box first (do not confuse with the one inside the 'Extensions' menu) and check that the number of Observations and Files is zero, at the top of the Download Overlay. Then type the string to refine the results, and click 'SELECT ALL' or select files individually using the checkboxes.
How To Select Products Using The Checkboxes
Any products displayed in the overlay must be selected using the checkboxes to download them. 'SELECT ALL' and 'SELECT NONE' will select or deselect all currently displayed products. The selection checkbox next to a given Observation ID will select or deselect all displayed products of that Observation. The selection checkbox next to a displayed product
will select or deselect only that product.
NOTE: Products that are selected will remain selected if they are later hidden using the filters in the Download Overlay. When in doubt, look at the number of Observations and Files at the top of the Overlay, or get a complete list of products and their selection status by displaying all Product Types and Product Extensions and remove any string matching in the search box.
When ready to download the selected products, click the 'START DOWNLOAD' button. This will begin downloading the products by streaming them to a Zip file. Note that the download location is set by the preference settings of the web browser. Some browsers allow choice of download location, otherwise the Zip file will be downloaded to the default location the browser downloads all files (Likely the download folder).
Pressing the 'DOWNLOAD WITH API QUERY' button will display the overlay below.
Another way to download products is to request a download script using the Mission Search API. Click the 'DOWNLOAD WITH API QUERY' button to show the Download By API Query Overlay. This overlay displays API commands based on the products selected to download the files one at a time. These commands can be copied from the overlay into a text editor and then run as an executable script.
Such API download scripts can be useful in a number of scenarios where a search was conducted at a different time than you want to download the products. Examples include slow internet connections, not being at the machine where the files will be stored, or very large product requests where the products can be requested in smaller batches at different times.
At this time, product downloads for non-public data using API commands is not supported, even if signed into a user account that has access to the products. Non-public products must be downloaded as a zip file using the Download Overlay.
| The account menu when not logged in. | The account menu when logged in. |
Example of non-public products in the Download Overlay if not authorized and/or not signed in. Instead of a selection checkbox, a locked icon with a yellow background will appear, indicating permission is not granted to download those products.
Downloading Non-Public (Exclusive Access) Products
Some missions, such as Hubble, have products that are not publicly available to everyone. These non-public (or "exclusive access") products will appear in the download overlay but will not be available for download except to those who sign in to the STScI account and authorized to retrieve those products.
NOTE: your account might be automatically logged-in if you have also signed in to another STScI service. The sign-in system is shared across many STScI interfaces.