Skip to content

i.sentinel.parallel.download

Downloads Sentinel-2 images in parallel using i.sentinel.download.

i.sentinel.parallel.download [-sfe] [settings=name] [scene_name=string [,string,...]] [output=name] [clouds=integer] [producttype=string] [start=string] [end=string] [nprocs=integer] [datasource=string] [limit=integer] [--verbose] [--quiet] [--qq] [--ui]

Example:

i.sentinel.parallel.download

grass.script.run_command("i.sentinel.parallel.download", settings=None, scene_name=None, output=None, clouds=20, producttype="S2MSI2A", start=None, end=None, nprocs=1, datasource="ESA_COAH", limit=None, flags=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("i.sentinel.parallel.download")

grass.tools.Tools.i_sentinel_parallel_download(settings=None, scene_name=None, output=None, clouds=20, producttype="S2MSI2A", start=None, end=None, nprocs=1, datasource="ESA_COAH", limit=None, flags=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.i_sentinel_parallel_download()

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

Parameters

settings=name
    Full path to settings file (user, password)
    Name of input file
scene_name=string [,string,...]
    Names of the scenes to be downloaded
output=name
    Name for output directory where to store downloaded Sentinel data
clouds=integer
    Maximum cloud cover percentage for Sentinel scene
    Default: 20
producttype=string
    Sentinel product type to filter
    Allowed values: SLC, GRD, OCN, S2MSI1C, S2MSI2A, S2MSI2Ap
    Default: S2MSI2A
start=string
    Start date ('YYYY-MM-DD')
end=string
    End date ('YYYY-MM-DD')
nprocs=integer
    Number of parallel processes
    Number of used CPUs
    Default: 1
datasource=string
    Default is ESA Copernicus Open Access Hub (ESA_COAH), but Sentinel-2 L1C data can also be acquired from USGS Earth Explorer (USGS_EE) or Google Cloud Storage (GCS)
    Data-Hub to download scenes from
    Allowed values: ESA_COAH, USGS_EE, GCS
    Default: ESA_COAH
limit=integer
    Maximum number of scenes to filter/download
-s
    Use scenename/s instead of start/end/producttype to download specific S2 data (specify in the scene_name field)
-f
    Download each Sentinel-2 datasat into an individual folder within the output folder
-e
    Use ESA-style scenename/s to download from USGS
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

settings : str, optional
    Full path to settings file (user, password)
    Name of input file
    Used as: input, file, name
scene_name : str | list[str], optional
    Names of the scenes to be downloaded
output : str, optional
    Name for output directory where to store downloaded Sentinel data
    Used as: input, dir, name
clouds : int, optional
    Maximum cloud cover percentage for Sentinel scene
    Default: 20
producttype : str, optional
    Sentinel product type to filter
    Allowed values: SLC, GRD, OCN, S2MSI1C, S2MSI2A, S2MSI2Ap
    Default: S2MSI2A
start : str, optional
    Start date ('YYYY-MM-DD')
end : str, optional
    End date ('YYYY-MM-DD')
nprocs : int, optional
    Number of parallel processes
    Number of used CPUs
    Default: 1
datasource : str, optional
    Default is ESA Copernicus Open Access Hub (ESA_COAH), but Sentinel-2 L1C data can also be acquired from USGS Earth Explorer (USGS_EE) or Google Cloud Storage (GCS)
    Data-Hub to download scenes from
    Allowed values: ESA_COAH, USGS_EE, GCS
    Default: ESA_COAH
limit : int, optional
    Maximum number of scenes to filter/download
flags : str, optional
    Allowed values: s, f, e
    s
        Use scenename/s instead of start/end/producttype to download specific S2 data (specify in the scene_name field)
    f
        Download each Sentinel-2 datasat into an individual folder within the output folder
    e
        Use ESA-style scenename/s to download from USGS
verbose: bool, optional
    Verbose module output
    Default: None
quiet: bool, optional
    Quiet module output
    Default: None
superquiet: bool, optional
    Very quiet module output
    Default: None

settings : str | io.StringIO, optional
    Full path to settings file (user, password)
    Name of input file
    Used as: input, file, name
scene_name : str | list[str], optional
    Names of the scenes to be downloaded
output : str, optional
    Name for output directory where to store downloaded Sentinel data
    Used as: input, dir, name
clouds : int, optional
    Maximum cloud cover percentage for Sentinel scene
    Default: 20
producttype : str, optional
    Sentinel product type to filter
    Allowed values: SLC, GRD, OCN, S2MSI1C, S2MSI2A, S2MSI2Ap
    Default: S2MSI2A
start : str, optional
    Start date ('YYYY-MM-DD')
end : str, optional
    End date ('YYYY-MM-DD')
nprocs : int, optional
    Number of parallel processes
    Number of used CPUs
    Default: 1
datasource : str, optional
    Default is ESA Copernicus Open Access Hub (ESA_COAH), but Sentinel-2 L1C data can also be acquired from USGS Earth Explorer (USGS_EE) or Google Cloud Storage (GCS)
    Data-Hub to download scenes from
    Allowed values: ESA_COAH, USGS_EE, GCS
    Default: ESA_COAH
limit : int, optional
    Maximum number of scenes to filter/download
flags : str, optional
    Allowed values: s, f, e
    s
        Use scenename/s instead of start/end/producttype to download specific S2 data (specify in the scene_name field)
    f
        Download each Sentinel-2 datasat into an individual folder within the output folder
    e
        Use ESA-style scenename/s to download from USGS
verbose: bool, optional
    Verbose module output
    Default: None
quiet: bool, optional
    Quiet module output
    Default: None
superquiet: bool, optional
    Very quiet module output
    Default: None

DESCRIPTION

i.sentinel.parallel.download downloads Sentinel-2 data defined by scene names in parallel using i.sentinel.download.
If no scene names are specified i.sentinel.parallel.download downloads data for the computational region set in the mapset; i.e, only products which footprint intersects the current computation region extent (area of interest, AOI) are selected.

SEE ALSO

i.sentinel module set, i.sentinel.download

AUTHOR

Guido Riembauer, mundialis

SOURCE CODE

Available at: i.sentinel.parallel.download source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819