Documentation of sentinelhub Python package

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.

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.

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:

• Process API in Python

• OGC API in Python

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:

• Upgrading the sentinelhub Python package

• Release of sentinelhub Python Package 2.0

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.

Documentation content:

• Installation
• Configuration
  • Sentinel Hub Configuration
  • Amazon S3 Configuration
  • Other configuration options
• Logging
• Basic examples
  • Sentinel Hub Process API
    • Prerequisites
    • Example 1: True color (PNG) on a specific date
    • Example 2: True color mosaic of least cloudy acquisitions
    • Example 3: All Sentinel-2’s raw band values
    • Example 4: Save downloaded data to disk and read it from disk
    • Example 5: Other Data Collections
    • Example 6 : Multi-response request type
    • Example 7 : Raw dictionary request
    • Example 8 : Multiple timestamps data
  • Data collections
    • Use an existing data collection definition
    • Define a new data collection
    • Data fusion
  • Search for available data
    • Sentinel Hub Catalog API
    • Web Feature Service (WFS)
    • Sentinel Hub Opensearch
  • Sentinel Hub OGC services
    • Web Map Service (WMS) and Web Coverage Service (WCS)
  • Large area utilities
    • Prerequisites
    • Area Splitting
  • Sentinel Hub Batch Processing
    • 1. Create a batch request
    • 2. Analyse a batch request
    • 3. Run a batch request job
  • Sentinel Hub Batch Statistical
    • Overview
    • Imports
    • 1.1 Sentinel Hub credentials
    • 1.2 AWS credentials
    • 1.3 Preparing input
    • 2.1 Defining the request
    • 2.2 Creating the request
  • Bring Your Own COG
    • Prerequisites
    • BYOC collections
    • BYOC tiles (cogs in the collection)
    • Retrieve data from collection
    • Configure collections
  • Sentinel Hub Statistical API
    • Prerequisites
    • Make a Statistical API request
    • Multiple requests for a collection of geometries
    • Reduce service processing costs
  • Sentinel Hub Feature Info Service (FIS)
    • Prerequisites
    • Exploring basic statistics
    • Comparing histograms
  • Accessing satellite data from AWS
    • Warning
    • Accessing satellite data from AWS
  • Downloading satellite data from AWS with command line
    • Sentinel-2 products
    • Sentinel-2 tiles
    • .SAFE format details
• Advanced tutorials
  • Sharing Sentinel Hub authentication session
    • Session mechanism
    • Session sharing
    • Parallelization frameworks
  • Retrieving information about processing units of requests
    • Sentinel Hub Request
    • Sentinel Hub Statistical
• Package content
  • Modules
    • sentinelhub.api
    • sentinelhub.areas
    • sentinelhub.aws
    • sentinelhub.base
    • sentinelhub.config
    • sentinelhub.constants
    • sentinelhub.data_collections
    • sentinelhub.data_collections_bands
    • sentinelhub.data_utils
    • sentinelhub.decoding
    • sentinelhub.exceptions
    • sentinelhub.download
    • sentinelhub.geo_utils
    • sentinelhub.geometry
    • sentinelhub.geopedia
    • sentinelhub.io_utils
    • sentinelhub.os_utils
    • sentinelhub.testing_utils
    • sentinelhub.time_utils
    • sentinelhub.types