download#

iris.data.download(urls, directory=None, overwrite=False)[source]#

Download the given URLs to a specified directory. If overwrite is False, the file will not be downloaded if it exists.

Parameters:

urls (list[str]) – The URLs to download.
directory (None | Path) – The directory to place the downloaded files.
overwrite (bool) – Boolean flag controlling whether to overwrite existing files.

Return type:

list[Path]

Examples

Download the last “A1: QS monitoring” spectrograph file in 2023.

import astropy.time
import iris

urls = iris.data.urls_hek(
    time_start=astropy.time.Time("2023-01-01T00:00"),
    time_stop=astropy.time.Time("2024-01-01T00:00"),
    description="A1: QS monitoring",
    limit=1,
    sji=False,
)

iris.data.download(urls)

[PosixPath('/home/docs/.iris/cache/iris_l2_20231231_070352_3882010194_raster.tar.gz')]