kuva-reader 1.0.3

Manipulate the Kuva Space image and metadata formats

Reader for Kuva Space images

The reader project allows the reading of Kuva Space products from any part of its processing chain.

The Kuva Space images are in GeoTIFF format. The products consist of an image or multiple images along with its metadata to give all the necessary information to use the products. The metadata lives either in a Kuva Space database, or alternatively in a sidecar JSON file.

This library allows the reading of the image GeoTIFFs into xarray.Dataset objects that allow convenient raster manipulations, along with their kuva-metadata metadata objects.

Installation

pip install kuva-reader

Requirements

Python 3.10 to 3.13, preferably within a virtual environment

Code

Minimal example

This is a minimal example that allows you to read and print the image shape of a L2 product.

The result product is in this case an L2A product (as seen from the folder name). The loaded product is stored in a rioxarray object, which contains extensive GIS functionalities (examples for usage).

from kuva_reader import read_product

l2a_product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
print(l2a_product)  # Will show some main information such as image shape and CRS

This assumes a mostly untouched folder after distributing. Otherwise, you may need to read the product manually based on the product processing level:

from kuva_reader import Level2AProduct

l2a_product = Level2AProduct("your/l2a/folder")

The actual raster image is stored and can be analysed in product.image, while metadata information of the product is in product.metadata.

Processing levels

Currently the reader supports the following processing levels for Kuva products:

• L0: Radiometrically corrected frames as TOA radiance
• L1AB: Band-aligned product formed from multiple L0 products
• L1C: Georeferences and orthorectified L1 product
• L2A: Atmospherically corrected product as BOA reflectance

Special tags

All images generated by Kuva Space should have the following special tags added to the geotiff metadata.

• _KUVA_PRODUCT_LEVEL: A string, e.g, "0" describing the level of the product.
• _KUVA_PRODUCT_ID: The id on the database for the product associated with the geotiff.

This makes it very easy to pinpoint what product we are dealing with and works around the issue that our images are not a monolithic entity but rather just folders that can be messed with.

Contributing

Please follow the guidelines in CONTRIBUTING.md.

Also, please follow our Code of Conduct while discussing in the issues and pull requests.

Contact information

For questions or support, please open an issue. If you have been given a support contact, feel free to send them an email explaining your issue.

License

The kuva-reader project software is under the MIT license.

Status of unit tests