Data Requests - Solar Orbiter Archive
DATA REQUEST
For the data request, there are two different types of command:
1) the data_item_id is used - since each data_item_id is given in the request, this is only for requesting very few files at once
or
2) the data request contains a query, which can return the products that fulfil the query criteria
For the first type of request:
product_type can be SCIENCE, LOW_LATENCY or TELEMETRY (TM for authorised access only)
For both types of request:
retrieval_type can be PRODUCT (for latest version) or ALL_PRODUCTS (for all versions)
retrieval_access can be DIRECT (default, so not needed) or DEFERRED (for asynchronous downloads)
Note that for very large requests (up to 50 GB), the request will probably be accepted but is likely to timeout, so in this case, please use an Asynchronous Request.
WITH THE WHOLE DATA_ITEM_ID:
Knowing the data_item_id (e.g., solo_L[1,2,3]_descriptor) of a file we want, we can then download the data by making a data request. This consists of different parts that make up a different URL to put into the browser.
We are going to the same address to get the information, but asking for data ('data?' instead of 'tap/sync?'):
https://soar.esac.esa.int/soar-sl-tap/data?
then product_type=SCIENCE because we haven't specified a table (an alternative might be 'LOW_LATENCY')
product_type=SCIENCE&
then RETRIEVAL_TYPE=PRODUCT or ALL_PRODUCTS, depending if we want the latest version or all versions (which will come in a tar file)
RETRIEVAL_TYPE=PRODUCT&
then a data_item_id:
data_item_id=solo_L2_mag-srf-normal_20200415
Again, this can be copied and pasted into a browser address bar to get the results:
https://soar.esac.esa.int/soar-sl-tap/data?product_type=SCIENCE&RETRIEVAL_TYPE=PRODUCT&data_item_id=solo_L2_mag-srf-normal_20200415
WITH THE WHOLE FILENAME:
The above the way to get the data without specifying the table or making a query, but the queries can be used to get data too. For example, if we wanted to download an AUXILIARY file, the object of our query is the filepath and filename and the table in this case is v_auxiliary_file:
SELECT filepath,filename FROM soar.v_auxiliary_file WHERE filename='solo_ANC_soc-kernels-complete_V106_20200910_001.zip'
built up into the URL as before:
https://soar.esac.esa.int/soar-sl-tap/data?
retrieval_type=PRODUCT&
QUERY=SELECT+filepath,filename+FROM+soar.v_auxiliary_file+WHERE+filename='solo_ANC_soc-kernels-complete_V106_20200910_001.zip'
OR AS A QUERY (Using wildcards):
Where the ADQL would be:
SELECT filepath,filename FROM v_sc_data_item WHERE data_item_id LIKE 'solo_L2_mag-%_20220415'
LIKE allows us to use a wildcard, which for strings in tables is '%' for multiple character wildcard (instead of the usual *, and % is URL encoded as '%25') and '_' for a single character wildcard (instead of the usual '?', and _ is URL encoded as '%5F')
https://soar.esac.esa.int/soar-sl-tap/data?
retrieval_type=PRODUCT&
QUERY=SELECT+filepath,filename+FROM+soar.v_sc_data_item+WHERE+data_item_id+LIKE+'solo_L2_mag-%25_20200415'
https://soar.esac.esa.int/soar-sl-tap/data?retrieval_type=PRODUCT&QUERY=SELECT+filepath,filename+FROM+soar.v_sc_data_item+WHERE+data_item_id+LIKE+'solo_L2_mag-%25_20200415'
This query will request all L2 data files from MAG for 2022-04-15.
Data Requests
A data request consists of an TAP request that the user will have to build using a start syntax and several parameters. Once this request is sent, the ESA Solar Orbiter Archive backend will return the data that matches the given criteria.
If the number of resulting files is more than one the system will create a tar file automatically. It is possible to request as well the compression of the delivered products by sending the parameter compress=true .
SOLAR ORBITER PRODUCTS
The files associated to the Solar Orbiter mission are uniquely identified by an Id and a Product type that should be used in the data requests. The following table exposes the required parameters to be used in the product retrievals.
Parameter name | Description | Mandatory | Possible values |
---|---|---|---|
product_type | Type of product to be retrieved. | YES | TELEMETRY, PLANNING, LOW_LATENCY, SCIENCE |
retrieval_type | Type of product retrieval, either PRODUCT to retrieve the latest version, or ALL_PRODUCTS to request all versions of the files. | YES | PRODUCT or ALL_PRODUCTS |
telemetry_item_id | The identifier of the Telemetry files to request | YES | Values displayed in the Item Id column of the Results page |
planning_item_id | The identifier of the Planning files to request | YES | Values displayed in the Item Id column of the Results page |
data_item_id | The identifier of the Low Latency an Science files to request | YES | Values displayed in the Item Id column of the Results page |
data_retrieval_origin | The source of the retrieval request. | NO | AIO |
query | ADQL query allowing to download the desired file, composed of the following:
|
YES | See examples below |
retrieval_access | The type of access retrieval. DEFERRED indicates an asynchronous download | NO | DIRECT or DEFERRED |
Some examples:
SYNCHRONOUS QUERIES
SCIENCE
- Science files whose identifiers are 'solo_L2_epd-ept-north-rates_20200820' and 'solo_L2_epd-ept-south-rates_20200820':
- All versions of the files retrieved by the example above:
- The table can be queried instead of the products requested directly, and this allows wildcards to be used:
LOW LATENCY
- Low Latency whose identifiers are 'solo_LL02_epd-ept-north-rates_20200414T000009-20200415T000008' and 'solo_LL02_epd-ept-south-rates_20200414T000009-20200415T000008':
- Last version Low Latency files whose identifiers are 'solo_LL02_epd-ept-north-rates_20200414T000009-20200415T000008' and 'solo_LL02_epd-ept-south-rates_20200414T000009-20200415T000008':
SPICE KERNELS
- SPICE Kernel whose filename is 'solo_ANC_soc-kernels-complete_V106_20200910_001.zip':
- SPICE Kernels whose creation date is before '2020-09-21+00:00:00.0' and after '2020-09-22+00:00:00.0':
TELEMETRY (ONLY FOR AUTHORIZED USERS)
- Telemetry files whose identifier is 'solo_L0_sc_20000101':
- All versions of the Telemetry files whose identifier is 'solo_L0_sc_20000101':
ASYNCHRONOUS QUERIES
A detailed explanation about the steps to follow for launching asynchronous requests and retrieving the data is provided in the introduction page ('Introduction -> Asynchronous Queries').
Let's see the usage through some examples:
- Direct asynchronous request to download a product whose file name is 'solo_ANC_soc-kernels-complete_V106_20200910_001.zip'. (Assumes the user is logged in)
- Asyncronous request via curl to download a product whose file name is 'solo_ANC_soc-kernels-complete_V106_20200910_001.zip'.
curl -k -b cookies.txt -i -X POST --data "retrieval_type=PRODUCT&QUERY=SELECT+filepath,+filename+FROM+soar.v_auxiliary_file+WHERE+filename+='solo_ANC_soc-kernels-complete_V106_20200910_001.zip'&retrieval_access=DEFERRED" "http://soar.esac.esa.int/soar-sl-tap/data?"
Note the usage of 'retrieval_access=DEFERRED' which denotes the product download should be down in an asynchronous manner.
The logged in user should receive an email as below, containing a link to where the files can be downloaded: