---
name: s1bursts
description: >
  Sentinel-1 download, processing and compositing in Python. Use when writing Python code that uses the s1bursts package.
license: MIT
compatibility: Requires Python >=3.12.
---

# s1bursts

Sentinel-1 download, processing and compositing in Python.

## Installation

```bash
pip install s1bursts
```

## API overview

### Searching and downloading

Query the CDSE burst catalog and fetch single bursts over OData or S3.

- `query.SearchQuery`
- `time_range.TimeRange`
- `catalog.BurstCatalog`

### Burst data model

The acquisitions a search returns, and the interferometric pairs built from them.

- `burst.Burst`
- `burst.BurstPair`
- `burst.BurstCollection`
- `burst.BurstPairCollection`

### Processing

Batch SNAP GPT execution and the runtime budget it runs under.

- `processor.BurstProcessor`
- `snap_client.SNAPConfig`
- `snap_client.SNAPClient`

### Graph configuration

The shape of the generated SNAP graph, one config per product type. Every config carries the shared Terrain-Correction tail parameters.

- `snap_graph.RTCConfig`
- `snap_graph.GTCConfig`
- `snap_graph.CoherenceConfig`
- `snap_graph.BackscatterConfig`
- `snap_graph.GeocodingConfig`

### Storage

Deterministic product paths and discovery, on local disk or S3.

- `filemanager.FileManager`

### Compositing

Locally resolution weighted and per-pass composites on the 10 km squares of the MGRS grid, re-exported from freezebase.

- `resolution_weighter.ResolutionWeighter`
- `MGRSGrid`: The 10 km MGRS squares intersecting an area of interest
- `MGRSGeoBox`: A 10 x 10 km MGRS square backed by ``odc.geo.GeoBox``

### Single-burst products

Metadata records returned by the processing services. They describe a product; the pixels live in the GeoTIFF at its `FileManager` path.

- `product.RTCProduct`
- `product.GTCProduct`
- `product.CoherenceProduct`

### Composite products

MGRS grid-square composites. Each holds its measurement and, optionally, its quality-assurance layers.

- `product.RTCLRWComposite`
- `product.CohLRWComposite`
- `product.RTCPassComposite`
- `product.CohPassComposite`
- `product.GTCPassComposite`
- `product.Layer`

### Results and errors

What a batch operation reports, and the exception hierarchy that separates per-item failures from environment-wide ones.

- `summary.OperationSummary`
- `summary.OkResult`
- `summary.ErrorResult`
- `errors.S1BurstsError`
- `errors.OperationFailedError`
- `errors.ConfigurationError`
- `errors.TransformationGridError`
- `errors.BurstMapUnavailableError`
- `errors.CatalogError`
- `errors.TooManyResultsError`
- `errors.BurstNotInMapError`
- `errors.ProductSettingsMismatchError`
- `errors.BurstError`
- `errors.BurstNotFoundError`
- `errors.BurstDownloadError`
- `errors.NoUTMZoneError`
- `errors.SnapProcessingError`
- `errors.CompositeError`
- `errors.EmptyCompositeError`
- `errors.InconsistentInputsError`
- `errors.CompositeInputError`

### Reference data and low-level access

The optional SAR-MPC burst-ID map, external-DEM preparation, and the CDSE clients the high-level services are built on.

- `burstmap.download_burst_map`
- `burstmap.Sentinel1Bursts`
- `dem.prepare_dem_for_snap`
- `cdse.CDSEAuth`
- `cdse.CDSEBurstClient`
- `cdse.CDSEResponse`
- `burst_extractor.extract_burst_from_s3`
- `snap_graph.xml_to_mermaid`
- `snap_graph.build_backscatter_graph`
- `snap_graph.build_coherence_graph`

## Resources

- [Full documentation](https://lqgentner.github.io/s1bursts/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs
- [Source code](https://github.com/lqgentner/s1bursts)