icepyx.Query.download_granules

Query.download_granules(path, overwrite=False, subset=True, skip_preview=False)

Download the granules for the order, blocking until they are ready if necessary.

Parameters:

• path (str or Path) – The directory where granules should be saved.

• overwrite (bool, optional) – Whether to overwrite existing files (default is False).

• subset (bool, default True) – Apply subsetting to the data order using harmony, returning only data that meets the subset parameters. Spatial and temporal subsetting based on the input parameters happens by default when subset=True, but additional subsetting options are available. Spatial subsetting returns all data that are within the area of interest (but not complete granules. This eliminates false-positive granules returned by the metadata-level search)

• skip_preview (bool, default False) – If True, bypass the preview state when we order subsetting queries that exceed 300 granules.

Returns:

A list of the downloaded file paths if successful, otherwise None.

Return type:

list or None