Skip to main content

I-ALiRT Data Access

Project description

I-ALiRT Data Access Package

This lightweight Python package allows users to query and download log data.

Command Line Utility

To install

pip install ialirt-data-access
ialirt-data-access -h

Query / Search for logs

Find all files from a given year, day of year, and instance

$ ialirt-data-access --url <url> ialirt-log-query --year <year> --doy <doy> --instance <instance>

Download logs

Download a log and place in Downloads directory or optionally specify another local directory by appending --downloads_dir to the command

$ ialirt-data-access --url <url> ialirt-log-download --filename <filename>

Query the database

Query the database for a given time and/or data product. Examples shown below.

$ ialirt-data-access --url <url> ialirt-db-query --insert_time_start <insert_time_start> --insert_time_end <insert_time_end> --product_name <product_name>

or

$ ialirt-data-access --url <url> ialirt-db-query --met_start <met_start> --met_end <met_end>

or

$ ialirt-data-access --url <url> ialirt-db-query --product_name <product_name>

or

$ ialirt-data-access --url <url> ialirt-db-query --met_start <met_start> --product_name <product_name_prefix*>

Importing as a package

import ialirt_data_access

# Search for files
results = ialirt_data_access.query(year="2024", doy="045", instance="1")

Configuration

Data Access URL

To change the default URL that the package accesses, you can set the environment variable IALIRT_DATA_ACCESS_URL or within the package ialirt_data_access.config["DATA_ACCESS_URL"]. The default is the development server https://ialirt.dev.imap-mission.com.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ialirt_data_access-0.2.0.tar.gz (6.7 kB view details)

Uploaded Source

File details

Details for the file ialirt_data_access-0.2.0.tar.gz.

File metadata

  • Download URL: ialirt_data_access-0.2.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ialirt_data_access-0.2.0.tar.gz
Algorithm Hash digest
SHA256 dd1924fcd6cdef6e0b8ba269a556841bc363c501adfdff0956689ab81198475c
MD5 54330f1c506503085ff6da96af3cd802
BLAKE2b-256 70778c2a7f30624761571e62f6ed2ed268bcaf11e1413be125830a9c894a3dde

See more details on using hashes here.

Provenance

The following attestation bundles were made for ialirt_data_access-0.2.0.tar.gz:

Publisher: release.yml on IMAP-Science-Operations-Center/ialirt-data-access

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page