kuva-reader 0.1.4__tar.gz → 1.0.0__tar.gz

{kuva_reader-0.1.4 → kuva_reader-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kuva-reader
-Version: 0.1.4
+Version: 1.0.0
 Summary: Manipulate the Kuva Space image and metadata formats
 License: MIT
 Author: Guillem Ballesteros
@@ -11,8 +11,8 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: kuva-geometry
-Requires-Dist: kuva-metadata
+Requires-Dist: kuva-geometry @ file:///home/olli/projects/kuva-repos/kuva-data-processing/kuva-geometry
+Requires-Dist: kuva-metadata @ file:///home/olli/projects/kuva-repos/kuva-data-processing/kuva-metadata
 Requires-Dist: numpy (>=1.26.4,<2.0.0)
 Requires-Dist: numpy-quaternion (>=2022.4.4,<2023.0.0)
 Requires-Dist: pint (>=0.22,<0.23)
@@ -39,19 +39,6 @@ The metadata lives either in a Kuva Space database, or alternatively in a sideca
 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.
 
-
-# Table of Contents
-
-- [Installation](#installation)
-- [Code](#code)
-  - [Minimal example](#minimal-example)
-  - [Processing levels](#processing-levels)
-  - [Special tags](#special-tags)
-- [Contributing](#contributing)
-- [Configuration](#configuration)
-- [Contact information](#contact-information)
-- [License](#license)
-
 # Installation
 
 ```bash
@@ -73,7 +60,7 @@ The loaded product is stored in a `rioxarray` object, which contains extensive G
 ```python
 from kuva_reader import read_product
 
-l1c_product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
+l2a_product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
 print(product)  # Will show some main information such as image shape and CRS
 ```
 
@@ -111,10 +98,10 @@ be messed with.
 
 # Contributing
 
-Please follow the guidelines in [CONTRIBUTING.md](../CONTRIBUTING.md).
+Please follow the guidelines in [CONTRIBUTING.md](https://github.com/KuvaSpace/kuva-data-processing/blob/main/CONTRIBUTING.md).
 
-Also, please follow our [Code of Conduct](../CODE_OF_CONDUCT.md) while discussing in the 
-issues and pull requests.
+Also, please follow our [Code of Conduct](https://github.com/KuvaSpace/kuva-data-processing/blob/main/CODE_OF_CONDUCT.md)
+while discussing in the issues and pull requests.
 
 # Contact information
 
@@ -123,7 +110,7 @@ feel free to send them an email explaining your issue.
 
 # License
 
-The `kuva-reader` project software is under the [MIT license](../LICENSE.md).
+The `kuva-reader` project software is under the [MIT license](https://github.com/KuvaSpace/kuva-data-processing/blob/main/LICENSE.md).
 
 # Status of unit tests
 

{kuva_reader-0.1.4 → kuva_reader-1.0.0}/README.md

@@ -16,19 +16,6 @@ The metadata lives either in a Kuva Space database, or alternatively in a sideca
 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.
 
-
-# Table of Contents
-
-- [Installation](#installation)
-- [Code](#code)
-  - [Minimal example](#minimal-example)
-  - [Processing levels](#processing-levels)
-  - [Special tags](#special-tags)
-- [Contributing](#contributing)
-- [Configuration](#configuration)
-- [Contact information](#contact-information)
-- [License](#license)
-
 # Installation
 
 ```bash
@@ -50,7 +37,7 @@ The loaded product is stored in a `rioxarray` object, which contains extensive G
 ```python
 from kuva_reader import read_product
 
-l1c_product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
+l2a_product = read_product("my_data_folder/hyperfield1a_L2A_20250105T092548")
 print(product)  # Will show some main information such as image shape and CRS
 ```
 
@@ -88,10 +75,10 @@ be messed with.
 
 # Contributing
 
-Please follow the guidelines in [CONTRIBUTING.md](../CONTRIBUTING.md).
+Please follow the guidelines in [CONTRIBUTING.md](https://github.com/KuvaSpace/kuva-data-processing/blob/main/CONTRIBUTING.md).
 
-Also, please follow our [Code of Conduct](../CODE_OF_CONDUCT.md) while discussing in the 
-issues and pull requests.
+Also, please follow our [Code of Conduct](https://github.com/KuvaSpace/kuva-data-processing/blob/main/CODE_OF_CONDUCT.md)
+while discussing in the issues and pull requests.
 
 # Contact information
 
@@ -100,7 +87,7 @@ feel free to send them an email explaining your issue.
 
 # License
 
-The `kuva-reader` project software is under the [MIT license](../LICENSE.md).
+The `kuva-reader` project software is under the [MIT license](https://github.com/KuvaSpace/kuva-data-processing/blob/main/LICENSE.md).
 
 # Status of unit tests
 

{kuva_reader-0.1.4 → kuva_reader-1.0.0}/kuva_reader/reader/level0.py

@@ -103,14 +103,15 @@ class Level0Product(ProductBase[MetadataLevel0]):
 
     def __repr__(self):
         """Pretty printing of the object with the most important info"""
-        return (
-            f"{self.__class__.__name__}("
-            f"len(self.images)={len(self.images)}, "
-            f"self.images[0].shape={self.images[0].shape}"
-            f"crs={self.images[0].rio.crs}, "
-            f"image_path='{self.image_path}"
-            ")"
-        )
+        if self.images is not None and len(self.images):
+            return (
+                f"{self.__class__.__name__}"
+                f"with {len(self.images)} frames of shape {self.images[0].shape} "
+                f"and CRS '{self.images[0].rio.crs}'. "
+                f"Loaded from: '{self.image_path}'."
+            )
+        else:
+            return f"{self.__class__.__name__} loaded from '{self.image_path}'."
 
     def __getitem__(self, camera: str) -> xarray.DataArray:
         """Return the datarray for the chosen camera."""
@@ -232,15 +233,6 @@ class Level0Product(ProductBase[MetadataLevel0]):
         bad_pixel_filename = f"{camera}_per_frame_cloud_mask.tif"
         return self._read_array(self.image_path / bad_pixel_filename)
 
-    def release_memory(self):
-        """Explicitely releases the memory of the `images` variable.
-
-        NOTE: this function is implemented because of a memory leak inside the Rioxarray
-        library that doesn't release memory properly. Only use it when the image data is
-        not needed anymore.
-        """
-        del self.images
-        self.images = None
 
 def generate_level_0_metafile():
     """Example function for reading a product and generating a metadata file from the

{kuva_reader-0.1.4 → kuva_reader-1.0.0}/kuva_reader/reader/level1.py

@@ -166,13 +166,14 @@ class Level1CProduct(ProductBase[MetadataLevel1C]):
 
     def __repr__(self):
         """Pretty printing of the object with the most important info"""
-        return (
-            f"{self.__class__.__name__}("
-            f"image.shape={self.image.shape}, "
-            f"image.crs={self.image.rio.crs}, "
-            f"wavelengths={self.wavelengths}"
-            f"image_path='{self.image_path})"
-        )
+        if self.image is not None:
+            return (
+                f"{self.__class__.__name__} with shape {self.image.shape} "
+                f"and wavelengths {self.wavelengths} (CRS: '{self.image.rio.crs}'). "
+                f"Loaded from: '{self.image_path}'."
+            )
+        else:
+            return f"{self.__class__.__name__} loaded from '{self.image_path}'"
 
     def _get_data_from_sidecar(
         self, sidecar_path: Path, target_ureg: UnitRegistry | None = None

{kuva_reader-0.1.4 → kuva_reader-1.0.0}/kuva_reader/reader/level2.py

@@ -58,13 +58,14 @@ class Level2AProduct(ProductBase[MetadataLevel2A]):
 
     def __repr__(self):
         """Pretty printing of the object with the most important info"""
-        return (
-            f"{self.__class__.__name__}("
-            f"image.shape={self.image.shape}, "
-            f"image.crs={self.image.rio.crs}, "
-            f"wavelengths={self.wavelengths}"
-            f"image_path='{self.image_path})"
-        )
+        if self.image is not None:
+            return (
+                f"{self.__class__.__name__} with shape {self.image.shape} "
+                f"and wavelengths {self.wavelengths} (CRS: '{self.image.rio.crs}'). "
+                f"Loaded from: '{self.image_path}'."
+            )
+        else:
+            return f"{self.__class__.__name__} loaded from '{self.image_path}'"
 
     def _get_data_from_sidecar(
         self, sidecar_path: Path, target_ureg: UnitRegistry | None = None

{kuva_reader-0.1.4 → kuva_reader-1.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "kuva-reader"
-version = "0.1.4"
+version = "1.0.0"
 description = "Manipulate the Kuva Space image and metadata formats"
 authors = ["Guillem Ballesteros <guillem@kuvaspace.com>" , "Lennert Antson <lennert.antson@kuvaspace.com>", "Arthur Vandenhoeke <arthur.vandenhoeke@kuvaspace.com>", "Olli Eloranta <olli.eloranta@kuvaspace.com>"]
 readme = "README.md"
@@ -30,17 +30,17 @@ pint = "^0.22"
 rasterio = "^1.4.1"
 xarray = "^2022.12.0"
 rioxarray = "^0.12.4"
-kuva-geometry = "*"
-kuva-metadata = "*"
+# kuva-geometry = "*"
+# kuva-metadata = "*"
 
 # Temporarily can replace pypi version with relative dep if doing local development
-# [tool.poetry.dependencies.kuva-geometry]
-# path = "../kuva-geometry"
-# develop = true
+[tool.poetry.dependencies.kuva-geometry]
+path = "../kuva-geometry"
+develop = true
 
-# [tool.poetry.dependencies.kuva-metadata]
-# path = "../kuva-metadata"
-# develop = true
+[tool.poetry.dependencies.kuva-metadata]
+path = "../kuva-metadata"
+develop = true
 
 
 [tool.ruff.lint]