Introduction
The sentinelhub Python package is the official Python interface for Sentinel Hub services. It supports most of the services described in the Sentinel Hub documentation and any type of satellite data collections, including Sentinel, Landsat, MODIS, DEM, and custom collections produced by users.
The package also provides a collection of basic tools and utilities for working with geospatial and satellite data. It builds on top of well known packages such as numpy, shapely, pyproj, etc. It is also a core dependency of eo-learn Python package for creating geospatial data-processing workflows.
The main package resources are GitHub repository, documentation page, and Sentinel Hub forum.
Installation
The package requires a Python version >= 3.8. The package is available at the PyPI package index and can be installed with
$ pip install sentinelhub
or with an extension tag for additional functionalities
$ pip install sentinelhub[AWS] # extra dependencies for interacting with Amazon Web Services
Alternatively, the package can be installed with Conda from conda-forge channel
$ conda install -c conda-forge sentinelhub
To install the package manually, clone the repository and run
$ pip install .
Before installing sentinelhub on Windows it is recommended to install shapely package from
Unofficial Windows wheels repository
Once installed the package can be configured according to configuration instructions in documentation.
Content
A high-level overview of the main functionalities:
-
Sentinel Hub services
- Process API,
- Catalog API,
- Batch Processing API,
- BYOC API,
- Statistical API,
- OGC services (WMS/WCS/WFS),
- FIS,
- authentication and rate-limit handling,
-
geospatial utilities
- interface for geospatial objects and transformations,
- large area splitting,
- data collection objects,
- IO tools,
-
download Sentinel-2 data from public AWS S3 buckets (required
[AWS]package extension)- restoration of .SAFE format,
- L1C and L2A data,
- command line interface,
-
Geopedia WMS and REST API.
Documentation
For more information on the package and to access the documentation, visit readthedocs.
Examples
The package has a collection of Jupyter notebooks with examples. They are available in the examples folder on GitHub and converted into documentation under Examples section.
Additionally, some examples are explained in Sentinel Hub webinar videos:
Blog posts
The package played a key role in many projects and use cases described at Sentinel Hub blog. The following blog posts are about the package itself:
Questions and Issues
Feel free to ask questions about the package and its use cases at Sentinel Hub forum or raise an issue on GitHub.
You are welcome to send your feedback to the package authors, Sentinel Hub research team, through any of Sentinel Hub communication channels.
License
See LICENSE.