NAME
i.eodag - Downloads imagery scenes from various providers through the EODAG API.
KEYWORDS
imagery,
eodag,
sentinel,
landsat,
modis,
dataset,
scene,
download
SYNOPSIS
i.eodag
i.eodag --help
i.eodag [-lj] [producttype=string] [map=name] [clouds=integer] [output=name] [limit=integer] [config=name] [area_relation=string] [footprints=name] [minimum_overlap=integer] [id=string[,string,...]] [file=name] [provider=string] [sort=string[,string,...]] [order=string] [query=string[,string,...]] [start=string] [end=string] [save=name] [print=string] [--overwrite] [--help] [--verbose] [--quiet] [--ui]
Flags:
- -l
- List filtered products scenes and exit
- -j
- Print scenes extended metadata information in JSON style and exit
- --overwrite
- Allow output files to overwrite existing files
- --help
- Print usage summary
- --verbose
- Verbose module output
- --quiet
- Quiet module output
- --ui
- Force launching GUI dialog
Parameters:
- producttype=string
- Imagery product type to search for
- 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 scenes data
- limit=integer
- Limit number of scenes
- config=name
- Full path to yaml config file
- Name of input file
- area_relation=string
- Spatial relation of footprint to AOI
- Options: Intersects, Contains, IsWithin
- footprints=name
- Name for output vector map with footprints
- minimum_overlap=integer
- Minimal AOI area covered by the scene [0, 100]
- id=string[,string,...]
- List of scenes IDs to download
- file=name
- File with a list of scenes to read
- Can be either a text file (one product ID per line), or a geojson file that was created by i.eodag
- provider=string
- The provider to search within.
- Providers available by default: https://eodag.readthedocs.io/en/stable/getting_started_guide/providers.html
- sort=string[,string,...]
- Field to sort values by
- Options: ingestiondate, cloudcover
- Default: cloudcover,ingestiondate
- order=string
- Sort order (see sort parameter)
- Options: asc, desc
- Default: asc
- query=string[,string,...]
- Extra searching parameters to use in the search
- Note: Make sure to use provided options when possible, otherwise the values might not be recognized
- start=string
- Start date (ISO 8601 Format)
- By default it is 60 days ago
- end=string
- End date (ISO 8601 Format)
- By default it is the current date and time
- save=name
- Geojson file name to save the search results in
- print=string
- Print the available options of the given value in JSON
- Options: products, providers, queryables, config
i.eodag allows to search and download imagery scenes, 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 scenes 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.
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-01 end=2022-06-01 \
map=durham producttype=S2_MSI_L2A provider=cop_dataspace
6 scenes(s) found.
S2B_MSIL2A_20220518T155819_N0400_R097_T17SPV_20220518T204903 2022-05-18T15:58:19 24% S2MSI2A
S2A_MSIL2A_20220513T155821_N0400_R097_T17SPV_20220514T002317 2022-05-13T15:58:21 99% S2MSI2A
S2B_MSIL2A_20220508T155819_N0400_R097_T17SPV_20220508T205707 2022-05-08T15:58:19 100% S2MSI2A
S2A_MSIL2A_20220523T155831_N0400_R097_T17SPV_20220524T002713 2022-05-23T15:58:31 95% S2MSI2A
S2A_MSIL2A_20220503T155831_N0400_R097_T17SPV_20220503T233818 2022-05-03T15:58:31 86% S2MSI2A
S2B_MSIL2A_20220528T155819_N0400_R097_T17SPV_20220528T205325 2022-05-28T15:58:19 2% S2MSI2A
Search and list the available Sentinel 2 scenes in the Copernicus Data Space
Ecosystem, with at least 70% of the AOI covered:
v.extract input=urbanarea where="NAME = 'Durham'" output=durham
i.eodag -l start=2022-05-01 end=2022-06-01 \
producttype=S2_MSI_L2A provider=cop_dataspace \
clouds=50 map=durham minimum_overlap=70
Sort results, descendingly, by
cloudcover, and then by
ingestiondate
Note that sorting with
cloudcover use
unrounded values, while they are rounded to the nearest integer when listing.
i.eodag -l start=2022-05-25 end=2022-06-01 \
producttype=S2_MSI_L2A provider=cop_dataspace \
sort=cloudcover,ingestiondate order=desc
Search for scenes with a list of IDs text file, and filter the results with the
provided parameters:
i.eodag -l file=ids_list.txt \
start=2022-05-25 \
area_relation=Contains clouds=3
Search and list the available Sentinel 2 scenes in the Copernicus Data Space
Ecosystem, with relative orbit number 54:
i.eodag -l producttype=S2_MSI_L2A \
provider=cop_dataspace save=search_result.geojson \
query="relativeOrbitNumber=54"
Download all available scenes with cloud coverage not exceeding 50%
in the tmp directory:
i.eodag start=2022-05-25 end=2022-06-01 \
producttype=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
List recognized eodag providers:
List recognized eodag providers, offering Sentinel 2 scenes:
i.eodag print=providers producttype=S2_MSI_L2A
List recognized eodag products:
List recognized eodag products, offered by Copernicus Data Space Ecosystem:
i.eodag print=products provider=cop_dataspace
List queryables for Sentinel 2 scenes, that is offered by Copernicus Data Space Ecosystem:
i.eodag print=queryables provider=cop_dataspace producttype=S2_MSI_L2A
List current EODAG configuration:
List current EODAG configuration for Copernicus Data Space Ecosystem:
i.eodag print=config provider=cop_dataspace
i.landsat,
i.sentinel,
i.modis
Hamed Elgizery, Giza, Egypt.
GSoC 2024 Mentors: Luca Delucchi, Stefan Blumentrath, Veronica Andreo
SOURCE CODE
Available at:
i.eodag source code
(history)
Latest change: Wednesday Jul 10 22:38:43 2024 in commit: 4a380404bdfd6f4ea9bf2dad7b8edd0ac1e92876
Main index |
Imagery index |
Topics index |
Keywords index |
Graphical index |
Full index
© 2003-2024
GRASS Development Team,
GRASS GIS 8.3.3dev Reference Manual