JWST Data Retrieval

There are a variety of options for retrieving data of interest from MAST, including direct download through the browser, via the MAST Portal download manager, or via custom scripts. Certain community tools are also able to search for and retrieve public data from MAST.

On this page

Retrieving JWST science data from MAST

Words in bold italics are also buttons 
or parameters in GUI tools. Bold 
style represents GUI menus/
panels & data software packages.

Science data that have been identified through a MAST Portal search may be retrieved in a number of ways. Anonymous users may search for and retrieve public datasets in MAST without registering and without logging in, but only authenticated and authorized users may retrieve data within the applicable exclusive access period. Retrieving contemporaneous JWST engineering data requires users to be logged in to MAST. See the Data Access Policy article for details and information on data access restrictions.

Browser Pop-ups

The MAST Portal interface requires that pop-up blockers be disabled for the domain https://mast.stsci.edu/ in order to download data. Check the documentation for your browser to determine how this is done, and be alert for notifications from the browser that popups are being blocked. In many cases it simply requires giving approval for popups when you are asked.

There are multiple ways in which data of interest may be identified. These include:

  • a search with the Portal,
  • following a link in a notification message (via email, or a Portal notification icon:) as generated with a data subscription,
  • by using a direct URL that was saved from a prior search by you or a colleague (e.g., by using the link  icon),
  • by performing a search with a script using a MAST programmatic interface (API)

See the article on Data Discovery for details. Once data files have been identified, the options for retrieving them are described in the sections below.



Data retrieval options

Science observations and ancillary data of interest, identified with the MAST Portal, may be retrieved using one of the methods summarized below. Retrieving engineering data via the Portal is analogous, but with some restrictions. For detailed instructions, see the following references:

Direct download

This download (through the browser) is the quickest and simplest choice for single entries in the results table: simply click the disk icon  in the table row corresponding to the entry of interest. It is also possible to save the search results table to a CSV file by clicking the file save icon ; this allows preserving the results of a complex search (with, say, many applied filters) and later uploading to the Portal to reproduce the search.

Download basket

The download basket (click this icon: ) is appropriate for retrieving multiple entries at once. The basket contents can be customized in the download manager to select specific product types (science, auxiliary, and preview), particular file types (FITS, ECSV, etc.), as well as the associated calibration reference files and contemporaneous Guide Star data. There are 2 options for retrieval: streaming download of a file bundle (i.e, a zip or tar file) through the browser, and staging data for later retrieval.

Immediate (streaming) download: The selected data files will be bundled into a .tar, .tar.gz, or .zip file and transferred to the user's machine.

Size Limitation

Data retrievals via immediate download are limited to about 20,000 files. Larger transfers require an asynchronous retrieval method: a cURL script, staging data for ftp retrieval, or the MAST API.

cURL script: A bash script can be created and downloaded to your machine. Simply execute the bash script in a Unix shell, and provide login credentials when prompted, to initiate the secure transfer of all selected files. The script contains a sequence of cURL commands, which are relatively robust against connection interruptions and other foibles of internet file transfers.

Batch retrieval

There are 2 methods of batch retrieval: staging data on the MAST ftp server for subsequent retrieval by the user, and having data written to hard media that is later shipped to the user. Note that fulfilling requests for data on hard media requires special effort, and will involve a significant delay. These options are summarized in Table 1, below.


Table 1. Batch retrieval methods

Staging
  • Data will be staged to an STScI ftp server.
  • The user will be notified via e-mail when the transfer is complete and will be given the server address and path to the staging directory.
  • Mac users with OS version 10.13 and higher will need to use a third-party file transfer client (such as Cyberduck).
  • Your file transfer client must be configured to use ftps, rather than ftp.
Shippable Media
  • The user must provide a full mailing address for shipment.
  • The options include a USB-mountable drive, such as a thumb drive or (for large requests) a drive that a user ships to MAST.
  • Users must certify that they cannot retrieve the data through other means, such as staging or via the API.

Note that a valid email address must be provided for all batch data retrieval requests, though an STScI MyST ID is not required for public data.

Batch retrieval is not supported for JWST engineering data.

What's in the box

All data products for all selected observations will be bundled together for delivery. When the .zip or .tar file is unpacked, data for each observation will appear in a separate subdirectory. For each subdirectory, the data bundle includes by default the highest-level data products, plus all parent data (unless those data have been de-selected in the download manager) For example, if an observation/visit/exposure/detector combination resulted in level-2 data products, all level-1 products would automatically be included unless the user explicitly chooses otherwise. Note: level-3 products will appear in separate directories.

The download manifest

The zip (or tar) file will include a file called MANIFEST.HTML which lists each file name, a short description, and whether access is restricted. It will also note any files that could not be downloaded and the reason why (e.g., if you do not have permission to retrieve them).



The MAST programmatic API

It is possible to retrieve science data using scripts in various programming languages, such as Unix shell scripts or Python, through the Mashup API for MAST. The most popular interface is the astroquery.mast Python package. See Programmatic Interfaces for details.

Retrieval of JWST engineering data using cURL scripts is possible, but it may be simpler to use a Python program. See the Using MAST APIs chapter of the JWST Archive Manual for details.



Community tools

A variety of community applications can retrieve data from astronomical archives, including MAST. These tools use Virtual Observatory protocols to discover and retrieve data files. Table 2 provides a few examples of such tools.


Table 2. List of applications and capabilities

ToolCapabilities
AladinSky atlas tool
SAOImage/DS9Image and catalog display tool
TOPCATCatalog joins, subsetting, editing, and visualization
VizieRExtensive Virtual Observatory catalog offerings
VO SoftwareStandalone, VO-aware software for querying and downloading data from Virtual Observatory archives

These tools currently lack the ability to provide user authentication credentials to archive services, and so cannot be used to retrieve data archived within the exclusive access period.



References

MAST Portal Guide

JWST Archive Manual

Programmatic data retrieval

astroquery.mast documentation




Latest updates
Originally published