GRASS logo

NAME

i.eodag - Eodag interface to install imagery datasets from various providers.

KEYWORDS

imagery, eodag, sentinel, landsat, modis, datasets, download

SYNOPSIS

i.eodag
i.eodag --help
i.eodag [-led] [dataset=string] [map=name] [clouds=integer] [output=name] [config=name] [id=string[,string,...]] [file=string] [provider=string] [start=string] [end=string] [--help] [--verbose] [--quiet] [--ui]

Flags:

-l
List the search result without downloading
-e
Extract the downloaded the datasets, not considered unless provider is set
-d
Delete the product archive after downloading, not considered unless provider is set
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--ui
Force launching GUI dialog

Parameters:

dataset=string
Imagery dataset to search for
Default: S2_MSI_L1C
map=name
Name of input vector map to define Area of Interest (AOI)
If not given then current computational extent is used
clouds=integer
Maximum cloud cover percentage for scene [0, 100]
output=name
Name for output directory where to store downloaded data OR search results
config=name
Full path to yaml config file
Name of input file
id=string[,string,...]
List of scenes IDs to download
file=string
Text file with a collection of IDs, one ID per line
provider=string
The provider to search within. Providers available by default: https://eodag.readthedocs.io/en/stable/getting_started_guide/providers.html
start=string
Start date (in any ISO 8601 format), by default it is 60 days ago
end=string
End date (in any ISO 8601 format)

Table of contents

DESCRIPTION

WARNING: I.EODAG IS UNDER DEVELOPMENT. THIS IS AN EXPERIMENTAL VERSION.

i.eodag allows to search and download imagery datasets, e.g. Sentinel, Landsat, and MODIS, from a number of different providers. The module utilizes the EODAG API, as a single interface to search for datasets on the providers that EODAG supports.

Currently, only products which footprint intersects the current computational region extent (area of interest, AOI) are retrieved.

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.

To be able to download data through i.eodag, the user will need to register for the providers of interest. i.eodag reads the user credentials, which the user should have acquired, from the EODAG YAML config file. User have to specify the config file path location through the config option, otherwise i.eodag will use the credentials found in the default config file ~/.config/eodag/eodag.yml

Following is an example for a config YAML file with Copernicus Dataspace credentials:

cop_dataspace:
    priority: # Lower value means lower priority (Default: 0)
    search:   # Search parameters configuration
    download:
        extract:
        outputs_prefix:
    auth:
        credentials:
          username: email@email.com
          password: password

See Providers Registration, and Configure EODAG sections for more details about registration and configuration of the providers' credentials.

EXAMPLES

Search and list the available Sentinel 2 scenes in the Copernicus Data Space Ecosystem, using a Vector Map as an AOI:
v.extract input=urbanarea where="NAME = 'Durham'" output=durham

i.eodag -l start=2022-05-25 end=2022-06-01 \
    map=durham dataset=S2_MSI_L2A provider=cop_dataspace
Download all available scenes in the tmp directory, with Cloud Coverage not exceeding 50%:
i.eodag start=2022-05-25 end=2022-06-01 \
    dataset=S2_MSI_L2A provider=cop_dataspace clouds=50
Download only selected scenes from a text file of IDs, using the Copernicus Data Space Ecosystem as the provider:
i.eodag file=ids_list.txt provider=cop_dataspace
Download and extract only selected scenes into the download_here directory, using a custom config file:
i.eodag -e provider=cop_dataspace \
    id="S2B_MSIL2A_20240526T080609_N0510_R078_T37SDD_20240526T094753,
    S2B_MSIL2A_20240529T081609_N0510_R121_T37SED_20240529T124818" \
    config=full/path/to/eodag/config.yaml \
    output=download_here

REQUIREMENTS

SEE ALSO

i.landsat, i.sentinel, i.modis

AUTHOR

Hamed Elgizery, Giza, Egypt.

GSoC 2024 Mentors: Luca Delucchi, Stefan Blumentrath, Veronica Andreo

SOURCE CODE

Available at: i.eodag source code (history)

Latest change: Sunday Jun 16 01:39:21 2024 in commit: abb96f2b7b50836a0d3e59665cffff75a203f966


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

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