pySitools2

A generic Python Sitools2 client

Introduction

The pySitools2 tool has been designed by the IAS MEDOC team as a client to perform all operations available within Sitools2. The code defines several classes of Sitools2: Dataset, Field, Project and Query.

It also contains specialized versions of the client, allowing the end-user to easily perform queries on selected datasets (namely EUV-SYN, GAIA-DEM, SDO/AIA, SDO/HMI, SOHO and STEREO at IDOC/MEDOC) and to download the corresponding data.

Features

• Search by providing a date range
• Filter the search results by providing additional options of the concerned dataset if desired (wavelength, cadence, detector...)
• Filter SDO (AIA or HMI) results with some specific metadata values (e.g. filter on quality)
• Get WCS metadata
• Download the results of the search in a TAR, ZIP or Tar.gz file

Installation

Requirements

It is recommended to create a Python virtual environment allowing to manage dependencies and avoid conflicts, in short, to ensure that the package works properly.

For Linux and macOS users:

python -m venv venv/
source venv/bin/activate

For Windows users:

python -m venv venv/
venv\Scripts\activate

Other requirements will be installed automatically by pip.

Installing from PyPI

The latest release is available from the Python Package Index and can be installed in the environment by:

python -m pip install pySitools2

Installing from the git repository

The code is developed on the IAS Gitlab instance, and you can install it like:

python -m pip install git+https://git.ias.u-psud.fr/medoc/PySitools2.git

or by cloning the source codes and then installing it:

git clone https://git.ias.u-psud.fr/medoc/PySitools2.git
cd pySitools2
python -m pip install .

Upgrading

Please use the --upgrade option of pip install.

Removing the library

Please use the uninstall command of pip instead of install.

Examples of use

Following examples will make a request, for each given python module below, using the search method and then simply download the results of the search() by calling the get method.

Full examples are provided in the examples/ directory.

euvsyn_client_medoc.py

from sitools2 import EuvsynClientMedoc
from datetime import datetime
d1 = datetime(2009, 7, 6, 0, 0, 0)
d2 = datetime(2009, 7, 10, 0, 0, 0)
euvsyn = EuvsynClientMedoc()
euvsyn_data_list = euvsyn.search(dates=[d1, d2], nb_res_max=10)
euvsyn.get(data_list=euvsyn_data_list, target_dir='euvsyn_results', download_type='TAR')

gaia_client_medoc.py

from sitools2 import GaiaClientMedoc
from datetime import datetime
d1 = datetime(2019, 9, 2, 0, 0, 0)
d2 = datetime(2019, 9, 3, 0, 0, 0)
gaia = GaiaClientMedoc()
gaia_data_list = gaia.search(dates=[d1, d2], nb_res_max=10)
gaia.get(data_list=gaia_data_list, target_dir='gaia_results', download_type='TAR')

sdo_client_medoc.py

from sitools2 import SdoClientMedoc
from datetime import datetime
d1 = datetime(2020, 1, 15, 0, 0, 0)
d2 = datetime(2020, 1, 15, 2, 0, 0)
sdo = SdoClientMedoc()
sdo_data_list = sdo.search(dates=[d1, d2], nb_res_max=10)
sdo.get(data_list=sdo_data_list, target_dir='sdo_results', download_type='TAR')

soho_client_medoc.py

from sitools2 import SohoClientMedoc
from datetime import datetime
d1 = datetime(2015, 3, 31, 0, 0, 0)
d2 = datetime(2015, 4, 1, 0, 0, 0)
soho = SohoClientMedoc()
soho_data_list = soho.search(dates=[d1, d2], nb_res_max=12)
soho.get(data_list=soho_data_list, target_dir='soho_results', download_type='TAR')

stereo_client_medoc.py

from sitools2 import StereoClientMedoc
from datetime import datetime
d1 = datetime(2019, 4, 4, 0, 0, 0)
d2 = datetime(2019, 4, 4, 1, 0, 0)
stereo = StereoClientMedoc()
stereo_data_list = stereo.search(dates=[d1, d2], nb_res_max=12)
stereo.get(data_list=stereo_data_list, target_dir='stereo_results', download_type='TAR')

Tests

The library is provided with tests (unit tests and functional tests). These tests have been written with pytest. To launch the tests, do the following:

cd pySitools2
python -m pytest .

Directory tree

The structure of pySitools2 directory is the following:

• examples/: examples for using the specialized clients.
• sitools2/: the pySitools2 module.
  • clients/: specialized clients for different data sets hosted at SiTools2 servers.
  • core/: the module core (objects for low-level SiTools2 API access).
• test_sitools2/: tests of both the specialized clients and the core packages.