i.earthaccess.download - GRASS manual

NAME

i.earthaccess.download - Searches and downloads earth observation data using the EarthAccess library for NASA Earthdata APIs.

KEYWORDS

imagery, satellite, download, EarthData, earthaccess

SYNOPSIS

i.earthaccess.download

i.earthaccess.download --help

i.earthaccess.download [-isw] [output_directory=string] [aoi=string] [temporal=string[,string,...]] [created_at=string[,string,...]] [production_date=string[,string,...]] [revision_date=string[,string,...]] [keyword=string] [short_name=string] [granule_name=string] [provider=string] [limit=integer] [print=string] format=name [file=name] [nprocs=integer] [check_scenes=string] [scenes=string] [order_by=string[,string,...]] [--overwrite] [--help] [--verbose] [--quiet] [--ui]

Flags:

-i: Ignore failure of downloads for single files (give a warning instead of error)
-s: Skip downloading existing scenes
-w: Write log file with download results
--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:

output_directory=string: Directory where to store downloaded data; Name for output directory where to store downloaded Sentinel data
aoi=string: GRASS GIS Map or OGR readable file with one polygon to delinate the Area of Interest (AOI)
temporal=string[,string,...]: Pair of ISO-formated time stamps (YYYY-MM-DD HH:MM:SS) for start end end of sensing time
created_at=string[,string,...]: Pair of ISO-formated time stamps (YYYY-MM-DD HH:MM:SS) for start end end of creation time
production_date=string[,string,...]: Pair of ISO-formated time stamps (YYYY-MM-DD HH:MM:SS) for start end end of production time
revision_date=string[,string,...]: Pair of ISO-formated time stamps (YYYY-MM-DD HH:MM:SS) for start end end of modification time
keyword=string: Keyword used for searching datasets or collection (supports wildcards)
short_name=string: Short name of dataset to download or collection to search
granule_name=string: File name of the granule to download (supports wildcards)
provider=string: Provider to download from
limit=integer: Limit number of matches to return / download
print=string: Print search result (do not download); Options: collections, collection_names, granule_metadata
format=name [required]: Output format; Print search result (do not download); Options: plain, json; Default: plain; plain: Plain text output; json: JSON (JavaScript Object Notation)
file=name: Write search result to file
nprocs=integer: Number of threads for parallel computing; Number of cores used for downloading; Default: 1
check_scenes=string: Perform checksum / modification time test for the given set of scenes; Perform checksum / modification time test; Options: existing, downloaded, all
scenes=string: Selected scenes to download using earthaccess; Comma separated list of scenes or file with scenes (one per row)
order_by=string[,string,...]: Comma separated list of sort parameters; Options: temporal, revision_date

DESCRIPTION
EXAMPLES
REQUIREMENTS
REFERENCES
AUTHOR

DESCRIPTION

i.earthaccess.download searches and downloads NASA EarthData datasets using the earthaccess libary.

The module options largely represent search parameters for collections and archives (granules).

The earthaccess library is quite restrictive with regards to formating of the aoi GeoJSON. Only polygons (no multi or 3D geometries) are supported with counter-clockwise ordering of vertices.

The optional temporal search parameters (temporal, created_at, production_date, revision_date) are given as a comma separated pair of ISO-formated datetime strings.

In order to be able to download data the user has to create an EarthData account and provide credentials to the module add earthaccess library respectively. Credentials can be provided in form of a ~/.netrc file or using environment variables named EARTHDATA_USERNAME and EARTHDATA_PASSWORD.

EXAMPLES

Retrieve and print metadata for available data(-sets)

List short-names of available datasets (collections)

i.earthaccess.download keyword=SWOT* print=collection_names

Get core metadata of available datasets (collections)

i.earthaccess.download keyword=SWOT* print=collections

Get full metadata of available datasets (collections) in JSON format

i.earthaccess.download keyword=SWOT* print=collections format=json

Get full metadata of selected archives (granules) in JSON format

i.earthaccess.download short_name=SWOT_L2_HR_Raster_100m_2.0 \
  print=granule_metadata format=json

Search and download data

Search selected archives (granules) using sensinig time

i.earthaccess.download short_name=SWOT_L2_HR_Raster_100m_2.0 \
  temporal="2024-04-20,2024-06-10 12:34:56"

Search selected archives (granules) using modification time

i.earthaccess.download short_name=SWOT_L2_HR_Raster_100m_2.0 \
  revision_date="2024-04-20,2024-06-10 12:34:56" \
  output=/data/SWOT_L2_HR_Raster_100m/

REQUIREMENTS

i.earthaccess.download uses the following non-standard Python libraries:

Python bindings for GDAL
the earthaccess Python library

REFERENCES

earthaccess documentation

AUTHOR

Stefan Blumentrath

SOURCE CODE

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

Accessed: Monday Jul 27 12:22:30 2026