IMAP Data Access Package

This lightweight Python package allows users to download, query, and upload data from the IMAP Science Data Center (SDC).

For more information see the detailed instructions.

Command Line Utility

To install

pip install imap-data-access
imap-data-access -h

Base Command Arguments

$ imap-data-access query # or
$ imap-data-access download # or
$ imap-data-access upload

Add the '-h' help flag with any base command for more information

Query / Search for data

Find all files from the SWE instrument

$ imap-data-access query --instrument swe
Found [3] matching files
|-----------------------------------------------------------------------------------------------------------------------------------|
| Instrument | Data Level | Descriptor      | Start Date | Repointing | Version | Filename                                          |
|-----------------------------------------------------------------------------------------------------------------------------------|
| swe        | l0         | raw             | 20240510   |            | v022    | imap_swe_l0_raw_20240510_v022.pkts                |
| swe        | l1a        | sci             | 20240510   |            | v022    | imap_swe_l1a_sci_20240510_v022.cdf                |
| swe        | l1b        | sci             | 20240510   |            | v022    | imap_swe_l1b_sci_20240510_v022.cdf                |
|-----------------------------------------------------------------------------------------------------------------------------------|

Find all SWE files ingested since a specific date (useful as a "since" filter to get newly available data)

$ imap-data-access query --instrument swe --ingestion-start-date 20240501
Found [2] matching files
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| Instrument | Data Level | Descriptor | Start Date | Repointing | Version | Ingestion Date | Filename                                          |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| swe        | l1a        | sci        | 20240510   |            | v022    | 20240512       | imap_swe_l1a_sci_20240510_v022.cdf                |
| swe        | l1b        | sci        | 20240510   |            | v022    | 20240513       | imap_swe_l1b_sci_20240510_v022.cdf                |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|

You can also bound the ingestion date range with --ingestion-end-date

$ imap-data-access query --instrument swe --ingestion-start-date 20240501 --ingestion-end-date 20240601

[!NOTE] Ingestion date refers to when a file was added to the SDC, not the science start date of the data. Use --ingestion-start-date / --ingestion-end-date when you want to discover files that have been newly ingested since a given date (a "since" query), and use --start-date / --end-date when you want to filter by the science observation time. Combine ingestion date filters with at least one other parameter (e.g. --instrument) to avoid server errors.

Find all files during the year 2024 and return the response as raw json

$ imap-data-access query --start-date 20240101 --end-date 20241231 --output-format json
[{'file_path': 'imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts', 'instrument': 'swe', 'data_level': 'l0', 'descriptor': 'sci', 'start_date': '20240105', 'version': 'v001', 'extension': 'pkts'}, {'file_path': 'imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts', 'instrument': 'swe', 'data_level': 'l0', 'descriptor': 'sci', 'start_date': '20240105', 'version': 'v001', 'extension': 'pkts'}]

Find all latest predicted ephemeris kernels

$ imap-data-access query --table spice --ingestion-start-date 20260301 --type ephemeris_predicted --version latest

An equivalent curl command is shown.

$ curl "https://api.imap-mission.com/spice-query?start_ingest_date=20260301&type=ephemeris_predicted&latest=true"

Download a predicted ephemeris kernel

$ imap-data-access download spk/imap_pred_od025_20260303_20260414_v01.bsp

An equivalent curl command is shown.

$ curl "https://api.imap-mission.com/download/imap/spice/spk/imap_pred_od025_20260303_20260414_v01.bsp" --output imap_pred_od025_20260303_20260414_v01.bsp

Download a file

Download a level 0 SWE file on 2024/01/05

[!NOTE] Make sure the directory configuration is correct, see the Data Directory section for more information.

$ imap-data-access download imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts
Successfully downloaded the file to: <IMAP_DATA_DIR>/imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts

Upload a file

Upload a l1a file after decoding the l0 CCSDS ".pkts" file

$ imap-data-access upload /imap/swe/l1a/2024/01/imap_swe_l1a_sci_20240105_v001.cdf
Successfully uploaded the file to the IMAP SDC

Importing as a package

import imap_data_access

# Search for files
results = imap_data_access.query(instrument="mag", data_level="l0")
# results is a list of dictionaries
# [{'file_path': 'imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts', 'instrument': 'swe', 'data_level': 'l0', 'descriptor': 'sci', 'start_date': '20240105','version': 'v001', 'extension': 'pkts'}, {'file_path': 'imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts', 'instrument': 'swe', 'data_level': 'l0', 'descriptor': 'sci', 'start_date': '20240105', 'version': 'v001', 'extension': 'pkts'}]

# Search for files ingested since a specific date ("since" query)
results = imap_data_access.query(instrument="swe", ingestion_start_date="20240501")
# Optionally bound the range
results = imap_data_access.query(instrument="swe", ingestion_start_date="20240501", ingestion_end_date="20240601")

# Download a file that was returned from the search
imap_data_access.download("imap/mag/l0/2024/01/imap_mag_l0_raw_202040101_v001.pkts")

# Upload a calibration file that exists locally
imap_data_access.upload("imap/swe/l1a/2024/01/imap_swe_l1a_sci_20240105_v001.cdf")

Configuration

Data directory

The folder structure for data files within the IMAP SDC is rigidly defined, so the data access will mimic that structure to make sure all data is stored in the same heirarchical structure as the SDC. This will enable seamless transition between a user's local system and the SDC. This is only used for downloads.

A user's root data location can be specified as an environment variable IMAP_DATA_DIR or through a configuration dictionary within the package itself imap_data_access.config["DATA_DIR"]. If the IMAP_DATA_DIR variable is not set, the program defaults to the user's current working directory + data/.

The following is the directory structure the IMAP SDC uses.

<IMAP_DATA_DIR>/
  imap/
    <instrument>/
      <data_level>/
        <year>/
          <month>/
            <filename>

for example, with IMAP_DATA_DIR=/data:

/data/
  imap/
    swe/
      l0/
        2024/
          01/
            imap_swe_l0_sci_20240105_v001.pkts

Data Access URL

To change the default URL that the package accesses, you can set the environment variable IMAP_DATA_ACCESS_URL or within the package imap_data_access.config["DATA_ACCESS_URL"]. The default is the production server https://api.imap-mission.com.

Use with API Keys

The default for the CLI is to use the public endpoints. To access some unreleased data products and quicklooks, you may need elevated permissions. To get that, you need an API Key, which can be requested from the SDC team.

There are two ways to provide your API Key:

1. Environment variable: Set the IMAP_API_KEY environment variable

IMAP_API_KEY=<your-api-key> imap-data-access ...

2. Command line flag: Use the --api-key flag

imap-data-access --api-key <your-api-key> ...

The command line flag will override the environment variable if both are set.

[!NOTE] When using an API key, requests are automatically routed to api.imap-mission.com/api-key endpoints for authentication.

Automated use with Access token (for software)

An alternative to using an API key to access protected data is using an access token provided by LASP's authentication server. LASP's authentication uses keycloak authentication.

To use an access token with imap-data-access you can set the following environment variable:

IMAP_ACCESS_TOKEN={{Access token from LASP auth server}}

Any queries or downloads made with imap-data-access will now use these credentials.

Troubleshooting

Network issues

SSL

If you encounter SSL errors similar to the following:

urllib.error.URLError: <urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:997)>

That generally means the Python environment you're using is not finding your system's root certificates properly. This means you need to tell Python how to find those certificates with the following potential solutions.

1. Upgrade the certifi package

   pip install --upgrade certifi
   

2. Install system certificates Depending on the Python version you installed the program with the command will look something like this:

   /Applications/Python\ 3.10/Install\ Certificates.command
   

HTTP Error 502: Bad Gateway

This could mean that the service is temporarily down. If you continue to encounter this, reach out to the IMAP SDC at imap-sdc@lasp.colorado.edu.

FileNotFoundError

This could mean that the local data directory is not set up with the same paths as the SDC. See the data directory section for an example of how to set this up.

File Validation

This package validates filenames and paths to check they follow our standards, as defined by the filename conventions. There is also a class available for use by other packages to create filepaths and filenames that follow the IMAP SDC conventions.

To use this class, use imap_data_access.ScienceFilePath.

Usage:

science_file = imap_data_access.ScienceFilePath("imap_swe_l0_sci_20240101_v001.pkts")

# Filepath = /imap/swe/l0/2024/01/imap_swe_l0_sci_20240101_v001.pkts
filepath = science_file.construct_path()

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Greg Lucas 💻

Matthew Bourque 💻

Maxine Hartnett 💻

Michele Facchinelli 💻

anamanica 📖

Daralynn Rhode 📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!