Download Related Modules¶

This module makes searching, downloading and retrieving metadata of Sentinel 1 satellite images, from the Copernicus Open Access Hub, easy.

class gscpy.ds1_download.ds1_download.S1Download(username, password, region, timestart, timeend, outdir, producttype=None, polarisationmode=None, sensoroperationalmode=None, orbitnumber=None, orbitdirection=None)[source]¶

This module makes searching, downloading and retrieving metadata of Sentinel-1 satellite images from the Copernicus Open Access Hub easy.

Parameters:

username (str) – Username for Copernicus Open Access Hub
password (str) – Password for Copernicus Open Access Hub
region (str) – A geojson file.
timestart (str) – Start time like “YYYY-MM-DD”
timeend (str) – End time like “YYYY-MM-DD”.
outdir (str) – Output directory.
producttype ({'SLC', 'GRD', 'OCN', ''RAW}) – Product type. If None, all types will be recognized.
tuple or str (polarisationmode) – A combination of V and H like (‘VH’, ‘HV’) or simple ‘VH’.
sensoroperationalmode ({'SM', 'IW', 'EW', 'WV'}) – Sensor operational mode. If None, all types will be recognized.
orbitnumber (int) – Orbit number
orbitdirection ({DESCENDING, ASCENDING}) – Orbit direction. If None, all types will be recognized.

api¶: object – Sentinelsat API object.

outdir¶: str

region¶: wkt – A geojson to WKT object.

kwargs¶: dict – Dictionary with setted attributes.

files¶: DataFrame – Pandas DataFrame with detected files.

download()[source]¶: Download all files.

print_products()[source]¶: Print all detected files.

Examples

The general usage is

$ ds1.download [-p] username=string password=string region=string timestart=string timeend=string outdir=sting
[*attributes=string] [--verbose] [--quiet]

For *attributes the following parameters can be used

>>> ["producttype", "polarisationmode", "sensoroperationalmode", "orbitnumber", "orbitdirection"]

Print all Sentinel 1 data with product type GRD between 2015-01-02 and 2015-01-12::: $ ds1.download -p username=USER password=PASSWORD region=myGEoJsOnFile.geojson timestart=2015-01-02 timeend=2015-01-12 outdir=’home/usr/data’ producttype=SLC

Download the last query

$ ds1.download username=USER password=PASSWORD region=myGEoJsOnFile.geojson timestart=2015-01-02
timeend=2015-01-12 outdir='home/usr/data' producttype=SLC

Notes

Flags:

p : Print the detected files and exit.

print_products()[source]

Print all detected files.

Returns:
Return type:	None