- Notifications
You must be signed in to change notification settings - Fork247
Search and download Copernicus Sentinel satellite images
License
sentinelsat/sentinelsat
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
TheCopernicus Open Access Hub (aka SciHub), that Sentinelsat was primarily built for, is permanently closed.
The official successor data distribution system, theCopernicus Data Space Ecosystem (CDSE),uses different API logic that Sentinelsat does not (yet?) support. Contributions are welcome to change that, please check issues and discussionsfor ongoing efforts or alternatives.
Sentinelsat can still be used againstother data hubs powered by theDHuS software.
Please note that examples referencing the old Copernicus Open Access Hub are not working anymore.
Sentinelsat makes searching, downloading and retrieving the metadata ofSentinelsatellite images from theCopernicus Open Access Hub easy.
It offers an easy-to-use command line interface
sentinelsat -u<user> -p<password> --location Berlin --sentinel 2 --cloud 30 --start NOW-1MONTH
and a powerful Python API.
fromsentinelsatimportSentinelAPI,read_geojson,geojson_to_wktapi=SentinelAPI('user','password')footprint=geojson_to_wkt(read_geojson('search_polygon.geojson'))products=api.query(footprint,producttype='SLC',orbitdirection='ASCENDING',limit=10)api.download_all(products)
Documentation is published athttp://sentinelsat.readthedocs.io/.
Installsentinelsat through pip:
pip install sentinelsat
Sentinelsat provides a Python API and a command line interface to search,download and retrieve the metadata for Sentinel products.
fromsentinelsatimportSentinelAPI,read_geojson,geojson_to_wktfromdatetimeimportdate# connect to the APIapi=SentinelAPI('user','password','dhus-hub-url')# download single scene by known product idapi.download(<product_id>)# search by polygon, time, and Hub query keywordsfootprint=geojson_to_wkt(read_geojson('map.geojson'))products=api.query(footprint,date= ('20151219',date(2015,12,29)),platformname='Sentinel-2',cloudcoverpercentage= (0,30))# download all results from the searchapi.download_all(products)# GeoJSON FeatureCollection containing footprints and metadata of the scenesapi.to_geojson(products)# GeoPandas GeoDataFrame with the metadata of the scenes and the footprints as geometriesapi.to_geodataframe(products)# Get basic information about the product: its title, file size, MD5 sum, date, footprint and# its download urlapi.get_product_odata(<product_id>)# Get the product's full metadata available on the serverapi.get_product_odata(<product_id>,full=True)
Valid search query keywords can be found at theCopernicus Open Access Hub documentation.
A basic search query consists of a search area geometry as well as the username andpassword to access the Copernicus Open Access Hub.
sentinelsat -u<user> -p<password> -g<geojson>
Search areas are provided as GeoJSON files, which can be created withQGIS orgeojson.io.If you do not specify a start and end date only products published in the last24 hours will be queried.
Search and download all Sentinel-1 scenes of type SLC, in descendingorbit, for the year 2015.
sentinelsat -u<user> -p<password> -g<search_polygon.geojson> -s 20150101 -e 20151231 -d \--producttype SLC -q"orbitdirection=Descending" \--url"https://apihub.copernicus.eu/apihub"
Username, password and DHuS URL can also be set via environment variables for convenience.
# same result as query aboveexport DHUS_USER="<user>"export DHUS_PASSWORD="<password>"export DHUS_URL="https://apihub.copernicus.eu/apihub"sentinelsat -g<search_polygon.geojson> -s 20150101 -e 20151231 -d \--producttype SLC -q"orbitdirection=Descending"
| -u | --user | TEXT | Username [required] (or environment variable DHUS_USER) |
| -p | --password | TEXT | Password [required] (or environment variable DHUS_PASSWORD) |
| --url | TEXT | Define another API URL. Default URL is 'https://apihub.copernicus.eu/apihub/'. | |
| -s | --start | TEXT | Start date of the query in the format YYYYMMDD or an expression like NOW-1DAY. |
| -e | --end | TEXT | End date of the query. |
| -g | --geometry | PATH | Search area geometry as GeoJSON file. |
| --uuid | TEXT | Select a specific product UUID. Can be set more than once. | |
| --name | TEXT | Select specific product(s) by filename. Supports wildcards. Can be set more than once. | |
| --sentinel | INT | Limit search to a Sentinel satellite (constellation). | |
| --instrument | TEXT | Limit search to a specific instrument on a Sentinel satellite. | |
| --producttype | TEXT | Limit search to a Sentinel product type. | |
| -c | --cloud | INT | Maximum cloud cover in percent. (requires --sentinel to be 2 or 3) |
| -o | --order-by | TEXT | Comma-separated list of keywords to order the result by. Prefix '-' for descending order. |
| -l | --limit | INT | Maximum number of results to return. Defaults to no limit. |
| -d | --download | Download all results of the query. | |
| --fail-fast | Skip all other other downloads if one fails. | ||
| --path | PATH | Set the path where the files will be saved. | |
| -q | --query | TEXT | Extra search keywords you want to use in the query.Example: '-q producttype=GRD -q polarisationmode=HH'.Repeated keywords are interpreted as an "or" expression. |
| -f | --footprints | FILENAME | Create a GeoJSON file at the provided path with footprints and metadata of the returned products. Set to '-' for stdout. |
| --include-pattern | TEXT | Glob pattern to filter files (within each product) to be downloaded. | |
| --exclude-pattern | TEXT | Glob pattern to filter files (within each product) to be excluded from the downloaded. | |
| --timeout | FLOAT | How long to wait for a DataHub response (in seconds, default 60 sec). | |
| --gnss | Query orbit products form the GNSS end-point ("https://scihub.copernicus.eu/gnss"). | ||
| --fmt | TEXT | Specify a custom format to print results. The format string shall be compatible with the Python "Format Specification Mini-Language". | |
| --info | Display DHuS server information. | ||
| --version | Show version number and exit. | ||
| --debug | Print debug log messages. | ||
| -h | --help | Show help message and exit. |
To run the tests onsentinelsat:
git clone https://github.com/sentinelsat/sentinelsat.gitcd sentinelsatpip install -e .[dev]pytest -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 DHUS_USER=<username>export DHUS_PASSWORD=<password>
and add--disable-vcr topytest arguments.To update the recordings use--vcr-record withonce,new_episodes orall. Seevcrpy docs for details.
To build the documentation:
git clone https://github.com/sentinelsat/sentinelsat.gitcd sentinelsatpip install -e .[dev]cd docsmake html
The full documentation is also published athttp://sentinelsat.readthedocs.io/.
SeeCHANGELOG. You can also use GitHub's compare view to see thechanges in the main branch since last release.
We invite anyone to participate by contributing code, reporting bugs, fixing bugs, writing documentation and tutorials and discussing the future of this project. Please checkCONTRIBUTE.rst.
For a list of maintainers and contributors please seeAUTHORS.rst and thecontributor graph.
GPLv3+
About
Search and download Copernicus Sentinel satellite images
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.