Metadata-Version: 2.4
Name: async-geotiff
Version: 0.2.0
Summary: Async GeoTIFF reader for Python
Keywords: geotiff,tiff,async,cog,raster,gis
Author: Kyle Barron
Author-email: Kyle Barron <kyle@developmentseed.org>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Typing :: Typed
Requires-Dist: affine>=2.4.0
Requires-Dist: async-tiff>=0.6.0b2
Requires-Dist: numpy>=2.0
Requires-Dist: pyproj>=3.3.0
Requires-Dist: morecantile>=7.0,<8.0 ; extra == 'morecantile'
Requires-Python: >=3.11
Project-URL: Changelog, https://github.com/developmentseed/async-geotiff/blob/main/CHANGELOG.md
Project-URL: Documentation, https://developmentseed.github.io/async-geotiff/
Project-URL: Homepage, https://github.com/developmentseed/async-geotiff
Project-URL: Issues, https://github.com/developmentseed/async-geotiff/issues
Project-URL: Repository, https://github.com/developmentseed/async-geotiff
Provides-Extra: morecantile
Description-Content-Type: text/markdown

# async-geotiff

Fast, async GeoTIFF and [Cloud-Optimized GeoTIFF][cogeo] (COG) reader for Python, wrapping the Rust-based [Async-TIFF][async-tiff] library.

[**Documentation website.**][docs] 
[Release post for v0.1][release_01_post]

[release_01_post]: https://developmentseed.org/async-geotiff/latest/blog/2026/02/03/introducing-async-geotiff/

[docs]: https://developmentseed.org/async-geotiff/latest

[async-tiff]: https://github.com/developmentseed/async-tiff
[cogeo]: https://cogeo.org/

## Features

- Asynchronous, read-only support for **GeoTIFF and COG** formats.
- **High-level**, familiar, **easy to use** API.
    - Load from full-resolution or reduced-resolution overviews as 3D [NumPy] arrays.
    - Simplify handling of nodata values and nodata masks with [NumPy] [masked arrays].
    - Interpret Coordinate Reference Systems as [PyProj] CRS objects.
    - Find pixels with geotransforms exposed as [Affine] matrices.
    - Represent internal COG tile grids as [TileMatrixSets][TileMatrixSet] via [Morecantile] integration.
- **Performance-focused**:
    - Rust core ensures compiled performance.
    - CPU-bound image decoding happens in a thread pool, without blocking the async executor.
    - Buffer protocol integration for zero-copy data sharing between Rust and Python.
- Lightweight with **no GDAL dependency**.
- Access data from AWS S3, Google Cloud Storage, and Azure Storage via **integration with [obstore]**.
- **Full type hinting** for all operations.
- **Broad decompression support**: Deflate, JPEG, JPEG2000, LERC, LERC_DEFLATE, LERC_ZSTD, LZMA, LZW, WebP, ZSTD.
- Support for **any arbitrary backend** via [obspec] protocols.

[Affine]: https://affine.readthedocs.io/en/latest/
[masked arrays]: https://numpy.org/doc/stable/reference/maskedarray.generic.html
[Morecantile]: https://github.com/developmentseed/morecantile/
[NumPy]: https://numpy.org/
[PyProj]: https://pyproj4.github.io/pyproj/stable/
[TileMatrixSet]: https://docs.ogc.org/is/17-083r4/17-083r4.html

#### Anti-Features

_Features explicitly not in scope_:

- No pixel resampling.
- No warping/reprojection.
- Automatic resolution/overview selection

Resampling and warping bring significant additional complexity and are out of scope for this library. Consider using Async-GeoTIFF to load data, then [Rasterio]'s [In-Memory Files] to resample or reproject data, if needed.

[obstore]: https://developmentseed.org/obstore/latest/
[obspec]: https://developmentseed.org/obspec/latest/
[In-Memory Files]: https://rasterio.readthedocs.io/en/stable/topics/memory-files.html
[rasterio]: https://rasterio.readthedocs.io/

## Example

First create a "store", such as an [`S3Store`][S3Store], [`GCSStore`][GCSStore], [`AzureStore`][AzureStore], or [`LocalStore`][LocalStore] for reading data from AWS S3, Google Cloud, Azure Storage, or local files. Refer to [obstore] documentation for more information.

[S3Store]: https://developmentseed.org/obstore/latest/api/store/aws/#obstore.store.S3Store
[GCSStore]: https://developmentseed.org/obstore/latest/api/store/gcs/#obstore.store.GCSStore
[AzureStore]: https://developmentseed.org/obstore/latest/api/store/azure/#obstore.store.AzureStore
[LocalStore]: https://developmentseed.org/obstore/latest/api/store/local/#obstore.store.LocalStore

```py
from obstore.store import S3Store

store = S3Store("sentinel-cogs", region="us-west-2", skip_signature=True)
path = "sentinel-s2-l2a-cogs/12/S/UF/2022/6/S2B_12SUF_20220609_0_L2A/TCI.tif"
```

Then open a `GeoTIFF`:

```py
from async_geotiff import GeoTIFF

geotiff = await GeoTIFF.open(path, store=store)
```

On the `GeoTIFF` instance you have metadata about the image, such as its affine transform and Coordinate Reference System:

```py
geotiff.transform
# Affine(10.0, 0.0, 300000.0,
#        0.0, -10.0, 4100040.0)

geotiff.crs
# <Projected CRS: EPSG:32612>
# Name: WGS 84 / UTM zone 12N
```

For a COG, you can access the overviews, or reduced resolution versions, of the image:

```py
# Overviews are ordered from finest to coarsest resolution
# In this case, access the second-coarsest resolution version of the image
overview = geotiff.overviews[-2]
```

Then we can read data from the image. This loads a 512-pixel square from the
upper-left corner of the selected overview.

```py
from async_geotiff import Window

window = Window(col_off=0, row_off=0, width=512, height=512)
array = await overview.read(window=window)
```

This `Array` instance has `data`, `mask`, and some other metadata about the fetched array data.

Plot, using [`rasterio.plot.show`](https://rasterio.readthedocs.io/en/stable/api/rasterio.plot.html#rasterio.plot.show) (requires `matplotlib`):

```py
import rasterio.plot

rasterio.plot.show(array.data)
```

![](assets/sentinel_2_plot.jpg)
