Downloaders

All download routines are stored in the itipy.download module. The following examples shows how to download the data using the ITI downloader classes.

SDO

For SDO we use the itipy.download.download_sdo.SDODownloader class:

class itipy.download.download_sdo.SDODownloader(base_path, email, wavelengths=['131', '171', '193', '211', '304', '335'], n_workers=5, cadence=60)[source]

Class to download SDO data from JSOC.

Parameters:

base_path (str) – Path to the directory where the downloaded data should be stored.
email (str) – Email address for JSOC registration.
wavelengths (list) – List of wavelengths to download.
n_workers (int) – Number of worker threads for parallel download.

The default settings for the AIA instrument is given by downloading the data in the 131, 171, 193, 211, 304, 335 Å channels without the HMI magnetograms. However, we can include them by adding the 6173 Å in the wavelength initialization of the itipy.download.download_sdo.SDODownloader. The itipy.download.download_sdo.SDODownloader class contains a function to download the data for specific dates with the downloadDate function.

itipy.download.download_sdo.SDODownloader.downloadDate(self, date)

Download the data for the given date.

Parameters:: date (datetime) – The date for which the data should be downloaded.
Returns:: List of paths to the downloaded files.
Return type:: list

SOHO

For SOHO we use the itipy.download.download_soho.SOHODownloader class:

class itipy.download.download_soho.SOHODownloader(base_path, wavelengths=['171', '195', '284', '304'])[source]

Class to download SOHO EIT and MDI data from the VSO.

Parameters:: base_path (str) – Path to the directory where the downloaded data should be stored.

The default settings for the SOHO downloader class is given by downloading the data from the EIT in the 171, 195, 284 and 304 Å channels as well as the MDI instrument simultaneously. It contains functions to download the data for specific dates with the downloadDate function, but also for the individual imagers EIT and MDI.

itipy.download.download_soho.SOHODownloader.downloadDate(self, date)

Download the data for the given date.

Parameters:: date (datetime) – The date for which the data should be downloaded.
Returns:: List of paths to the downloaded files.
Return type:: list

itipy.download.download_soho.SOHODownloader.downloadEIT(self, query_date, wl)

Download the EIT data for the given date and wavelength.

Parameters:

query_date (datetime) – The date for which the data should be downloaded.
wl (int) – The wavelength of the data.

Returns:

Path to the downloaded file.

Return type:

str

itipy.download.download_soho.SOHODownloader.downloadMDI(self, download_date)

Download the MDI data for the given date.

Parameters:: download_date (datetime) – The date for which the data should be downloaded.
Returns:: Path to the downloaded file.
Return type:: str

STEREO

For STEREO we employ the itipy.download.download_stereo.STEREODownloader class:

class itipy.download.download_stereo.STEREODownloader(base_path)[source]

Class to download STEREO SECCHI data from the VSO.

Parameters:: base_path (str) – Path to the directory where the downloaded data should be stored.

Similar as for SDO and SOHO, the default settings for the STEREO downloader class is given by downloading the data from the EUVI instrument in the 171, 195, 284 and 304 Å channels . It also contains a function to download the data for specific dates with the downloadDate function.

itipy.download.download_stereo.STEREODownloader.downloadDate(self, sample)

Download the data for the given date.

Parameters:: sample (tuple) – Tuple containing the date and source information.
Returns:: List of paths to the downloaded files.
Return type:: list

PROBA2

For PROBA2 we use the itipy.download.download_proba2.PROBA2Downloader class:

class itipy.download.download_proba2.PROBA2Downloader(base_path)[source]

Class to download PROBA2 SWAP data from the VSO.

Parameters:: base_path (str) – Path to the directory where the downloaded data should be stored.

The default settings for the PROBA2 downloader class is given by downloading the data from the SWAP instrument in the 174 Å channel. With the downloadDate function, the data can be downloaded for specific dates.

itipy.download.download_proba2.PROBA2Downloader.downloadDate(self, date)

Download the data for the given date.

Parameters:: date (datetime) – The date for which the data should be downloaded.
Returns:: List of paths to the downloaded files.
Return type:: list

Solar Orbiter

For Solar Orbiter we use the itipy.download.download_solo.SOLODownloader class:

class itipy.download.download_solo.SOLODownloader(base_path)[source]

Class to download Solar Orbiter data from the VSO.

Parameters:: base_path (str) – Path to the directory where the downloaded data should be stored.

For the Solar Orbiter downloader class, the default settings are given by downloading the data from the EUI instrument. This contains both the FSI and HRI instrument. Note that for FSI, data is available in the 174 and 304 Å channels, while for HRI, data can be downloaded in the 174 Å and the Lyman-α channel. The data can be downloaded for specific dates with the downloadDate function.

itipy.download.download_solo.SOLODownloader.downloadDate(self, date, FSI=True)

Download the data for the given date.

Parameters:

date (datetime) – The date for which the data should be downloaded.
FSI (bool) – If True, download FSI data, else download HRI data.

Returns:

List of paths to the downloaded files.

Return type:

list

Kanzelhoehe Solar Observatory

The Kanzelhoehe Solar Observatory download routine is based on the two functions searchHalpha and downloadFile. The searchHalpha function searches for the available H-alpha images for a specific date and the downloadFile function downloads the data for the specified date.

itipy.download.download_kso_synoptic.searchHalpha(base_dir='')[source]

Search for Halpha files in the given directory and download them.

Parameters:: base_dir (str) – The directory to search in.

itipy.download.download_kso_synoptic.downloadFile(filename)[source]

Download the given file.

Parameters:: filename (str) – The name of the file to download.
Returns:: Path to the downloaded file.
Return type:: str

Download data in the terminal

For all download routines, that are based on downloader classes the data can be downloaded with a terminal command. The timeframe can be specified with the start_date and end_date parameters. The data is stored in the download_dir directory which can be specified individually.

To download the data from the terminal, you can run:

python3 -m `itipy.download.download_class --start_date 'start_date' --end_date 'end_date' --download_dir '/path/to/download_dir'

If an end_date is not specified, the current date will be used as default. The download routine will create a subdirectory for each channel in the download directory.