Package: sentinelsat
sentinelsatSentinelsat makes searching, downloading and retrieving the metadata ofSentinelsatellite images from theCopernicus Open Access Hubeasy.It offers an easy-to-use command line interfacesentinelsat-u<user>-p<password>--locationBerlin--sentinel2--cloud30--startNOW-1MONTHand 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/.InstallationInstallsentinelsatthrough pip:pipinstallsentinelsatUsageSentinelsat provides a Python API and a command line interface to search,
download and retrieve the metadata for Sentinel products.Python LibraryfromsentinelsatimportSentinelAPI,read_geojson,geojson_to_wktfromdatetimeimportdate# connect to the APIapi=SentinelAPI('user','password','https://apihub.copernicus.eu/apihub')# 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.Command Line InterfaceA basic search query consists of a search area geometry as well as the username and
password 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 withQGISorgeojson.io.
If you do not specify a start and end date only products published in the last
24 hours will be queried.ExampleSearch and download all Sentinel-1 scenes of type SLC, in descending
orbit, for the year 2015.sentinelsat-u<user>-p<password>-g<search_polygon.geojson>-s20150101-e20151231-d\--producttypeSLC-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 aboveexportDHUS_USER="<user>"exportDHUS_PASSWORD="<password>"exportDHUS_URL="https://apihub.copernicus.eu/apihub"sentinelsat-g<search_polygon.geojson>-s20150101-e20151231-d\--producttypeSLC-q"orbitdirection=Descending"Options-u–userTEXTUsername [required] (or environment variable DHUS_USER)-p–passwordTEXTPassword [required] (or environment variable DHUS_PASSWORD)–urlTEXTDefine another API URL. Default URL is ‘https://apihub.copernicus.eu/apihub/’.-s–startTEXTStart date of the query in the format YYYYMMDD or an expression like NOW-1DAY.-e–endTEXTEnd date of the query.-g–geometryPATHSearch area geometry as GeoJSON file.–uuidTEXTSelect a specific product UUID. Can be set more than once.–nameTEXTSelect specific product(s) by filename. Supports wildcards. Can be set more than once.–sentinelINTLimit search to a Sentinel satellite (constellation).–instrumentTEXTLimit search to a specific instrument on a Sentinel satellite.–producttypeTEXTLimit search to a Sentinel product type.-c–cloudINTMaximum cloud cover in percent. (requires –sentinel to be 2 or 3)-o–order-byTEXTComma-separated list of keywords to order the result by. Prefix ‘-’ for descending order.-l–limitINTMaximum number of results to return. Defaults to no limit.-d–downloadDownload all results of the query.–fail-fastSkip all other other downloads if one fails.–pathPATHSet the path where the files will be saved.-q–queryTEXTExtra 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–footprintsFILENAMECreate a GeoJSON file at the provided path with footprints and metadata of the returned products. Set to ‘-’ for stdout.–include-patternTEXTGlob pattern to filter files (within each product) to be downloaded.–exclude-patternTEXTGlob pattern to filter files (within each product) to be excluded from the downloaded.–timeoutFLOATHow long to wait for a DataHub response (in seconds, default 60 sec).–gnssQuery orbit products form the GNSS end-point (”https://scihub.copernicus.eu/gnss”).–fmtTEXTSpecify a custom format to print results. The format string shall be compatible with the Python “Format Specification Mini-Language”.–infoDisplay DHuS server information.–versionShow version number and exit.–debugPrint debug log messages.-h–helpShow help message and exit.TestsTo run the tests onsentinelsat:gitclonehttps://github.com/sentinelsat/sentinelsat.gitcdsentinelsatpipinstall-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 variablesexportDHUS_USER=<username>exportDHUS_PASSWORD=<password>and add--disable-vcrtopytestarguments.
To update the recordings use--vcr-recordwithonce,new_episodesorall. Seevcrpy docsfor details.DocumentationTo build the documentation:gitclonehttps://github.com/sentinelsat/sentinelsat.gitcdsentinelsatpipinstall-e.[dev]cddocsmakehtmlThe full documentation is also published athttp://sentinelsat.readthedocs.io/.ChangelogSeeCHANGELOG. You can also use GitHub’s compare view to see thechanges in the main branch since last release.ContributorsWe 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.rstand thecontributor graph.LicenseGPLv3+