GRASS logo

Note: This document is for an older version of GRASS GIS that will be discontinued soon. You should upgrade, and read the current manual page.

NAME

i.landsat.download - Downloads Landsat TM, ETM and OLI data from EarthExplorer using landsatxplore library

KEYWORDS

imagery, satellite, Landsat, download

SYNOPSIS

i.landsat.download
i.landsat.download --help
i.landsat.download [-l] [output=name] [map=name] [datasource=string] [clouds=integer] [dataset=string] [start=string] [end=string] [id=string[,string,...]] [tier=string[,string,...]] [sort=string[,string,...]] [order=string] [timeout=integer] [limit=integer] [--help] [--verbose] [--quiet] [--ui]

Flags:

-l
List filtered products and exit
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--ui
Force launching GUI dialog

Parameters:

output=name
Name for output directory where to store downloaded Landsat data
map=name
Name of input vector map to define Area of Interest (AOI)
If not given then current computational extent is used
datasource=string
Data source to use for searching and downloading landsat scenes
Options: planetary_computer, usgs
Default: planetary_computer
clouds=integer
Maximum cloud cover percentage for Landsat scene
Default: 100
dataset=string
Landsat dataset to search for
Options: landsat_tm_c2_l1, landsat_tm_c2_l2, landsat_etm_c2_l1, landsat_etm_c2_l2, landsat_8_ot_c2_l1, landsat_8_ot_c2_l2, landsat_9_ot_c2_l1, landsat_9_ot_c2_l2
Default: landsat_9_ot_c2_l2
start=string
Start date ('YYYY-MM-DD')
end=string
End date ('YYYY-MM-DD')
id=string[,string,...]
List of scenes IDs to download
tier=string[,string,...]
Tiers
Options: RT, T1, T2
sort=string[,string,...]
Sort by values in given order
Options: acquisition_date, cloud_cover
Default: cloud_cover,acquisition_date
order=string
Sort order (see sort parameter)
Options: asc, desc
Default: asc
timeout=integer
Download timeout in seconds
Default: 300
limit=integer
maximum number of Landsat scenes
Default: 50

Table of contents

DESCRIPTION

i.landsat.download allows to search and download Landsat TM, ETM and OLI data from USGS EarthExplorer and Planetary Computer using EODAG Python library.

Landsat data are organized in tiers: Newly-acquired Landsat scenes are placed in the Real-Time (RT) tier. After reprocessing they are transitioned to either Tier 1 (T1; scenes with the highest available data quality, considered suitable for time-series analysis) or Tier 2 (T2; less accurate geometry). The Tier designation (T1, T2, RT) is indicated at the end of the Landsat Product Identifier.

The supported Landsat satellites include (see also Landsat satellite chronology):

The dataset names and IDs are:
Dataset Name Dataset ID
Landsat 5 TM Collection 2 Level 1 landsat_tm_c2_l1
Landsat 5 TM Collection 2 Level 2 landsat_tm_c2_l2
Landsat 7 ETM+ Collection 2 Level 1 landsat_etm_c2_l1
Landsat 7 ETM+ Collection 2 Level 2 landsat_etm_c2_l2
Landsat 8 Collection 2 Level 1 landsat_8_ot_c2_l1
Landsat 8 Collection 2 Level 2 landsat_8_ot_c2_l2
Landsat 9 Collection 2 Level 1 landsat_9_ot_c2_l1
Landsat 9 Collection 2 Level 2 landsat_9_ot_c2_l2

To connect to EODAG the credentials of the data source of interest (either USGS or Planetary Computer) have to be filled in the EODAG config file. See EODAG Configuration section in i.eodag and EODAG Configuration. The configuration file is stored by default in $HOME/.config/eodag/eodag.yml. If it is not there, it will be created after running the module.

By default, only products which footprint intersects current computation region extent (area of interest, AOI) are filtered. The AOI can be optionally defined by a vector map. In this case, the vector will be used as AOI.

To only list available scenes, l flag must be set. If no start or end dates are provided, the module will search scenes from the past 60 days.

To download all scenes found within the time frame provided, the user must remove the l flag and provide an output directory. Otherwise, files will be downloaded into /tmp directory. To download only selected scenes, one or more IDs must be provided through the id option, along with an output directory. In addition, a timeout (in seconds) can be set to define how long a request should wait for a response before aborting (default is 300 seconds).

NOTES

USGS is still under development and can't be used for searching nor downloading.

EXAMPLES

Search available scenes:
i.landsat.download -l dataset=landsat_8_ot_c2_l2 \
    clouds=15 start='2018-08-24' end='2018-12-21'
Download all available scenes:
i.landsat.download dataset=landsat_8_ot_c2_l2 \
    clouds=15 start='2018-08-24' end='2018-12-21' \
    timeout=600
Download selected scenes by ID:
i.landsat.download \
    id=LC09_L2SP_015035_20240529_02_T1,LC09_L2SP_015035_20240614_02_T1 \
    output=/tmp

REQUIREMENTS

SEE ALSO

Overview of i.landsat tools

i.landsat.import, i.landsat.qa, i.landsat.toar

Landsat Collection 1 info

Landsat Collection 2 info

AUTHOR

Veronica Andreo, CONICET, Argentina.

SOURCE CODE

Available at: i.landsat.download source code (history)

Latest change: Monday Jul 29 16:51:29 2024 in commit: 7d82bb9f2b024afd63a812ae85d4e9613e810076


Note: This document is for an older version of GRASS GIS that will be discontinued soon. You should upgrade, and read the current manual page.

Main index | Imagery index | Topics index | Keywords index | Graphical index | Full index

© 2003-2024 GRASS Development Team, GRASS GIS 8.3.3dev Reference Manual