sentinelsat 0.8.1

sentinelsat

Sentinelsat makes finding and downloading Copernicus Sentinel satellite images from the Sentinels Scientific Datahub easy.

It offers an easy to use command line interface.

sentinel search --sentinel2 --cloud 30 user password search_polygon.geojson

and a powerful Python API.

from sentinelsat.sentinel import SentinelAPI, get_coordinates

api = SentinelAPI('user', 'password')
products = api.query(get_coordinates('search_polygon.geojson'), \
                     producttype = 'SLC', \
                     orbitdirection='ASCENDING')
api.download_all(products)

Documentation is published at http://sentinelsat.readthedocs.io/.

Installation

Sentinelsat depends on homura, which depends on PycURL, so you might need to install some dependencies on your system.

Install sentinelsat through pip:

pip install sentinelsat

The documentation contains examples on how to install the dependencies for Ubuntu, Fedora and Windows.

Usage

Sentinelsat provides a Python Library and a Command Line Interface to search and download Sentinel products.

# connect to the API
from sentinelsat.sentinel import SentinelAPI, get_coordinates
api = SentinelAPI('user', 'password', 'https://scihub.copernicus.eu/dhus')

# download single scene by known product id
api.download(<product_id>)

# search by polygon, time, and SciHub query keywords
products = api.query(get_coordinates('map.geojson'), \
                     '20151219', date(2015, 12, 29), \
                     platformname = 'Sentinel-2', \
                     cloudcoverpercentage = '[0 TO 30]'})

# download all results from the search
api.download_all(products)

# GeoJSON FeatureCollection containing footprints and metadata of the scenes
api.get_footprints(products)

sentinel search [OPTIONS] <user> <password> <geojson>

sentinel search -s 20150101 -e 20151231 -d \
-q "producttype=SLC, orbitdirection=Descending" \
-u "https://scihub.copernicus.eu/dhus" <user> <password> <poly.geojson>

Troubleshooting

The download from Scihub will fail if the server certificate cannot be verified because no default CA bundle is defined, as on Windows, or when the CA bundle is outdated. In most cases the easiest solution is to install or update certifi:

pip install -U certifi You can also override the the path setting to the PEM file of the CA bundle using the pass_through_opts keyword argument when calling api.download() or api.download_all():

from pycurl import CAINFO
api.download_all(pass_through_opts={CAINFO: 'path/to/my/cacert.pem'})

Tests

To run the tests on sentinelsat:

git clone https://github.com/ibamacsr/sentinelsat.git
cd sentinelsat
pip install -e .[test]
export SENTINEL_USER=<your scihub username>
export SENTINEL_PASSWORD=<your scihub password>
py.test -v

By default, prerecorded responses to SciHub queries are used to not be affected by Scihub’s downtime. The only exceptions are downloading tests, which can be disabled with -m "not homura". To allow the tests to run actual queries on SciHub add --vcr disable to py.test arguments. If you wish to update the recordings use --vcr record_new or --vcr reset_all.

Changelog

Check CHANGELOG.

Contributors

• Wille Marcel

• Kersten Clauss

• Martin Valgur

• Jonas Sølvsteen

• Luca Delucchi

License

GPLv3+