Utility to search and download Copernicus Sentinel satellite images
Project description
sentinelsat
Sentinelsat makes searching, downloading and retrieving the metadata of Sentinel satellite images from the Copernicus Open Access Hub easy.
It offers an easy-to-use command line interface
sentinel search --sentinel 2 --cloud 30 user password search_polygon.geojsonand a powerful Python API.
from sentinelsat import SentinelAPI, read_geojson, geojson_to_wkt
api = SentinelAPI('user', 'password')
footprint = geojson_to_wkt(read_geojson('search_polygon.geojson'))
products = api.query(footprint,
producttype='SLC',
orbitdirection='ASCENDING')
api.download_all(products)Documentation is published at http://sentinelsat.readthedocs.io/.
Installation
Install sentinelsat through pip:
pip install sentinelsatUsage
Sentinelsat provides a Python API and a command line interface to search, download and retrieve the metadata for Sentinel products.
Python Library
# connect to the API
from sentinelsat.sentinel import SentinelAPI, read_geojson, geojson_to_wkt
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
footprint = geojson_to_wkt(read_geojson('map.geojson'))
products = api.query(footprint,
'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.to_geojson(products)
# GeoPandas GeoDataFrame with the metadata of the scenes and the footprints as geometries
api.to_geopandas(products)
# Get basic information about the product: its title, file size, MD5 sum, date, footprint and
# its download url
api.get_product_odata(<product_id>)
# Get the product's full metadata available on the server
api.get_product_odata(<product_id>, full=True)Valid search query keywords can be found at the Copernicus Open Access Hub documentation.
Command Line Interface
A basic search query consists of a search polygon as well as the username and password to access the Copernicus Open Access Hub.
sentinel search [OPTIONS] <user> <password> <geojson>Search areas are provided as GeoJSON polygons, which can be created with QGIS or geojson.io. If you do not specify a start and end date only products published in the last 24 hours will be queried.
Example
Search and download all Sentinel-1 scenes of type SLC, in descending orbit, for the year 2015.
sentinel search -s 20150101 -e 20151231 -d \
--producttype SLC -q "orbitdirection=Descending" \
-u "https://scihub.copernicus.eu/dhus" <user> <password> poly.geojsonOptions
-s |
--start |
TEXT |
Start date of the query in the format YYYYMMDD. |
-e |
--end |
TEXT |
End date of the query in the format YYYYMMDD. |
-d |
--download |
Download all results of the query. |
|
-f |
--footprints |
Create geojson file search_footprints.geojson with footprints of the query result. |
|
-p |
--path |
PATH |
Set the path where the files will be saved. |
-q |
--query |
TEXT |
Extra search keywords you want to use in the query. Separate keywords with comma. Example: ‘producttype=GRD,polarisationmode=HH’. |
-u |
--url |
TEXT |
Define another API URL. Default URL is ‘https://scihub.copernicus.eu/apihub/’. |
--md5 |
Verify the MD5 checksum and write corrupt product ids and filenames to corrupt_scenes.txt. |
||
--sentinel |
Limit search to a Sentinel satellite (constellation). |
||
--instrument |
Limit search to a specific instrument on a Sentinel satellite. |
||
--producttype |
Limit search to a Sentinel product type. |
||
-c |
--cloud |
INT |
Maximum cloud cover in percent. (Automatically sets –sentinel2) |
--help |
Show help message and exit. |
||
--version |
Show version number and exit. |
Tests
To run the tests on sentinelsat:
git clone https://github.com/sentinelsat/sentinelsat.git
cd sentinelsat
pip install -e .[test]
py.test -vBy default, prerecorded responses to Copernicus Open Access Hub queries are used to not be affected by its downtime. To allow the tests to run actual queries against the Copernicus Open Access Hub set the environment variables
export SENTINEL_USER=<username>
export SENTINEL_PASSWORD=<password>and add --vcr disable to py.test arguments. To update the recordings use either --vcr record_new or --vcr reset.
Documentation
To build the documentation:
git clone https://github.com/sentinelsat/sentinelsat.git
cd sentinelsat
pip install -e .[docs]
cd docs
make htmlThe full documentation is also published at http://sentinelsat.readthedocs.io/.
Changelog
See CHANGELOG.
Contributors
Wille Marcel
Kersten Clauss
Martin Valgur
Jonas Sølvsteen
Luca Delucchi
License
GPLv3+
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sentinelsat-0.11-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4b7023a216022e22e2c26558f5d304f07ab0c46333c9b0b11a0aec92d4610471 |
|
| MD5 | 3f492d4b934f9fd3d30ddda37faf8840 |
|
| BLAKE2b-256 | 48f3240e24446bedb90966b7929efcf76728c1d75cbd24d4cc0d6033921c842a |
