EUI Selektor client

Lightweight client for EUI Selektor.

Installation

Clone the repository (or download the sources), and install with pip:

git clone https://github.com/gpelouze/eui_selektor_client
pip install --user eui_selektor_client

Example

Python

import os
from eui_selektor_client import EUISelektorClient, EUISelektorFormViewer

if __name__ == '__main__':

    # Set credentials
    os.environ['EUI_SELEKTOR_USERNAME'] = 'my_username'
    os.environ['EUI_SELEKTOR_PASSWORD'] = 'my_password'

    # Download the form and print available search keywords
    form_viewer = EUISelektorFormViewer()
    form = form_viewer.get_form()
    form_viewer.show_form(form)

    # Query images captured in December 2021 with FSI 304
    client = EUISelektorClient()
    res = client.search({
        'detector[]': 'FSI',
        'wavelnth[]': '304',
        'imgtype[]': 'solar image',
        'date_begin_start': '2021-12-01',
        'date_begin_end': '2021-12-31',
        'limit[]': 500,
        })
    print(res)
    # #                 date-beg detector  ...      crval2  crpix1  crpix2
    # 0      0  2021-12-30T23:45:15.335      FSI  ...  102.484419  1536.5  1536.5
    # 1      1  2021-12-30T23:30:15.547      FSI  ...  102.692080  1536.5  1536.5
    # 2      2  2021-12-30T23:15:15.269      FSI  ...  102.401791  1536.5  1536.5
    # 3      3  2021-12-30T23:00:15.501      FSI  ...  102.394845  1536.5  1536.5
    # 4      4  2021-12-30T22:45:15.239      FSI  ...  102.337948  1536.5  1536.5
    # ..   ...                      ...      ...  ...         ...     ...     ...
    # 495  495  2021-12-26T15:38:15.297      FSI  ...  102.821920  1536.5  1536.5
    # 496  496  2021-12-26T15:36:15.297      FSI  ...  102.388034  1536.5  1536.5
    # 497  497  2021-12-26T15:34:15.297      FSI  ...  102.156946  1536.5  1536.5
    # 498  498  2021-12-26T15:32:15.297      FSI  ...  102.694615  1536.5  1536.5
    # 499  499  2021-12-26T15:30:15.296      FSI  ...  102.723120  1536.5  1536.5

Command line interface

The above query can also be run from the command line:

export EUI_SELEKTOR_USERNAME="my_username"
export EUI_SELEKTOR_PASSWORD="my_password"
# retrieve and display the search form parameters:
eui_selektor_client --view-form
# run a query:
eui_selektor_client --output query_results.csv --query "detector[]:FSI" "wavelnth[]:304" "imgtype[]:solar image" date_begin_start:2021-12-01 date_begin_end:2021-12-31 "limit[]:500"
# get help:
eui_selektor_client --help

(Note that query parameters containing spaces or square brackets should be put between quotation marks.)

Authentication

The EUI selektor page is password protected. The credentials should be provided through the environment variables EUI_SELEKTOR_USERNAME and EUI_SELEKTOR_PASSWORD.

(Note: the old credentials storage using keyring was removed in v2023.5.12.)

License

This package is released under a MIT open source licence. See LICENSE.txt.