yirgacheffe 1.9.2__tar.gz → 1.9.3__tar.gz

yirgacheffe-1.9.3/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: yirgacheffe
+Version: 1.9.3
+Summary: Abstraction of gdal datasets for doing basic math operations
+Author-email: Michael Dales <mwd24@cam.ac.uk>
+License-Expression: ISC
+Project-URL: Homepage, https://yirgacheffe.org/
+Project-URL: Repository, https://github.com/quantifyearth/yirgacheffe.git
+Project-URL: Issues, https://github.com/quantifyearth/yirgacheffe/issues
+Project-URL: Changelog, https://yirgacheffe.org/latest/changelog/
+Keywords: gdal,gis,geospatial,declarative
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3.0,>=1.24
+Requires-Dist: gdal[numpy]<4.0,>=3.8
+Requires-Dist: scikit-image<1.0,>=0.20
+Requires-Dist: torch
+Requires-Dist: dill
+Requires-Dist: deprecation
+Requires-Dist: tomli
+Requires-Dist: h3
+Requires-Dist: pyproj
+Provides-Extra: mlx
+Requires-Dist: mlx; extra == "mlx"
+Provides-Extra: matplotlib
+Requires-Dist: matplotlib; extra == "matplotlib"
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings-python; extra == "dev"
+Requires-Dist: mike; extra == "dev"
+Requires-Dist: mkdocs-gen-files; extra == "dev"
+Dynamic: license-file
+
+# Yirgacheffe: a declarative geospatial library for Python to make data-science with maps easier
+
+[![CI](https://github.com/quantifyearth/yirgacheffe/actions/workflows/pull-request.yml/badge.svg?branch=main)](https://github.com/quantifyearth/yirgacheffe/actions)
+[![Documentation](https://img.shields.io/badge/docs-yirgacheffe.org-blue)](https://yirgacheffe.org)
+[![PyPI version](https://img.shields.io/pypi/v/yirgacheffe)](https://pypi.org/project/yirgacheffe/)
+
+
+## Overview
+
+Yirgacheffe is a declarative geospatial library, allowing you to operate on both raster and polygon geospatial datasets without having to do all the tedious book keeping around layer alignment or dealing with hardware concerns around memory or parallelism. you can load into memory safely.
+
+Example common use-cases:
+
+* Do the datasets overlap? Yirgacheffe will let you define either the intersection or the union of a set of different datasets, scaling up or down the area as required.
+* Rasterisation of vector layers: if you have a vector dataset then you can add that to your computation and yirgaceffe will rasterize it on demand, so you never need to store more data in memory than necessary.
+* Do the raster layers get big and take up large amounts of memory? Yirgacheffe will let you do simple numerical operations with layers directly and then worry about the memory management behind the scenes for you.
+* Parallelisation of operations over many CPU cores.
+* Built in support for optionally using GPUs via [MLX](https://ml-explore.github.io/mlx/build/html/index.html) support.
+
+## Installation
+
+Yirgacheffe is available via pypi, so can be installed with pip for example:
+
+```SystemShell
+$ pip install yirgacheffe
+```
+
+## Documentation
+
+The documentation can be found on [yirgacheffe.org](https://yirgacheffe.org/)
+
+## Simple examples:
+
+Here is how to do cloud removal from [Sentinel-2 data](https://browser.dataspace.copernicus.eu/?zoom=14&lat=6.15468&lng=38.20581&themeId=DEFAULT-THEME&visualizationUrl=U2FsdGVkX1944lrmeTJcaSsnoxNMp4oucN1AjklGUANHd2cRZWyXnepHvzpaOWzMhH8SrWQo%2BqrOvOnu6f9FeCMrS%2FDZmvjzID%2FoE1tbOCEHK8ohPXjFqYojeR9%2B82ri&datasetId=S2_L2A_CDAS&fromTime=2025-09-09T00%3A00%3A00.000Z&toTime=2025-09-09T23%3A59%3A59.999Z&layerId=1_TRUE_COLOR&demSource3D=%22MAPZEN%22&cloudCoverage=30&dateMode=SINGLE), using the [Scene Classification Layer](https://custom-scripts.sentinel-hub.com/custom-scripts/sentinel-2/scene-classification/) data:
+
+```python
+import yirgaceffe as yg
+
+with (
+  yg.read_raster("T37NCG_20250909T073609_B06_20m.jp2") as vre2,
+  yg.read_raster("T37NCG_20250909T073609_SCL_20m.jp2") as scl,
+):
+  is_cloud = (scl == 8) | (scl == 9) | (scl == 10)  # various cloud types
+  is_shadow = (scl == 3)
+  is_bad = is_cloud | is_shadow
+
+  masked_vre2 = yg.where(is_bad, float("nan"), vre2)
+  masked_vre2.to_geotiff("vre2_cleaned.tif")
+```
+
+or a species' [Area of Habitat](https://www.sciencedirect.com/science/article/pii/S0169534719301892) calculation:
+
+```python
+import yirgaceffe as yg
+
+with (
+    yg.read_raster("habitats.tif") as habitat_map,
+    yg.read_raster('elevation.tif') as elevation_map,
+    yg.read_shape('species123.geojson') as range_map,
+):
+    refined_habitat = habitat_map.isin([...species habitat codes...])
+    refined_elevation = (elevation_map >= species_min) && (elevation_map <= species_max)
+    aoh = refined_habitat * refined_elevation * range_polygon * area_per_pixel_map
+    print(f'Area of habitat: {aoh.sum()}')
+```
+
+## Thanks
+
+Thanks to discussion and feedback from my colleagues, particularly Alison Eyres, Patrick Ferris, Amelia Holcomb, and Anil Madhavapeddy.
+
+Inspired by the work of Daniele Baisero in his AoH library.

yirgacheffe-1.9.3/README.md

@@ -0,0 +1,71 @@
+# Yirgacheffe: a declarative geospatial library for Python to make data-science with maps easier
+
+[![CI](https://github.com/quantifyearth/yirgacheffe/actions/workflows/pull-request.yml/badge.svg?branch=main)](https://github.com/quantifyearth/yirgacheffe/actions)
+[![Documentation](https://img.shields.io/badge/docs-yirgacheffe.org-blue)](https://yirgacheffe.org)
+[![PyPI version](https://img.shields.io/pypi/v/yirgacheffe)](https://pypi.org/project/yirgacheffe/)
+
+
+## Overview
+
+Yirgacheffe is a declarative geospatial library, allowing you to operate on both raster and polygon geospatial datasets without having to do all the tedious book keeping around layer alignment or dealing with hardware concerns around memory or parallelism. you can load into memory safely.
+
+Example common use-cases:
+
+* Do the datasets overlap? Yirgacheffe will let you define either the intersection or the union of a set of different datasets, scaling up or down the area as required.
+* Rasterisation of vector layers: if you have a vector dataset then you can add that to your computation and yirgaceffe will rasterize it on demand, so you never need to store more data in memory than necessary.
+* Do the raster layers get big and take up large amounts of memory? Yirgacheffe will let you do simple numerical operations with layers directly and then worry about the memory management behind the scenes for you.
+* Parallelisation of operations over many CPU cores.
+* Built in support for optionally using GPUs via [MLX](https://ml-explore.github.io/mlx/build/html/index.html) support.
+
+## Installation
+
+Yirgacheffe is available via pypi, so can be installed with pip for example:
+
+```SystemShell
+$ pip install yirgacheffe
+```
+
+## Documentation
+
+The documentation can be found on [yirgacheffe.org](https://yirgacheffe.org/)
+
+## Simple examples:
+
+Here is how to do cloud removal from [Sentinel-2 data](https://browser.dataspace.copernicus.eu/?zoom=14&lat=6.15468&lng=38.20581&themeId=DEFAULT-THEME&visualizationUrl=U2FsdGVkX1944lrmeTJcaSsnoxNMp4oucN1AjklGUANHd2cRZWyXnepHvzpaOWzMhH8SrWQo%2BqrOvOnu6f9FeCMrS%2FDZmvjzID%2FoE1tbOCEHK8ohPXjFqYojeR9%2B82ri&datasetId=S2_L2A_CDAS&fromTime=2025-09-09T00%3A00%3A00.000Z&toTime=2025-09-09T23%3A59%3A59.999Z&layerId=1_TRUE_COLOR&demSource3D=%22MAPZEN%22&cloudCoverage=30&dateMode=SINGLE), using the [Scene Classification Layer](https://custom-scripts.sentinel-hub.com/custom-scripts/sentinel-2/scene-classification/) data:
+
+```python
+import yirgaceffe as yg
+
+with (
+  yg.read_raster("T37NCG_20250909T073609_B06_20m.jp2") as vre2,
+  yg.read_raster("T37NCG_20250909T073609_SCL_20m.jp2") as scl,
+):
+  is_cloud = (scl == 8) | (scl == 9) | (scl == 10)  # various cloud types
+  is_shadow = (scl == 3)
+  is_bad = is_cloud | is_shadow
+
+  masked_vre2 = yg.where(is_bad, float("nan"), vre2)
+  masked_vre2.to_geotiff("vre2_cleaned.tif")
+```
+
+or a species' [Area of Habitat](https://www.sciencedirect.com/science/article/pii/S0169534719301892) calculation:
+
+```python
+import yirgaceffe as yg
+
+with (
+    yg.read_raster("habitats.tif") as habitat_map,
+    yg.read_raster('elevation.tif') as elevation_map,
+    yg.read_shape('species123.geojson') as range_map,
+):
+    refined_habitat = habitat_map.isin([...species habitat codes...])
+    refined_elevation = (elevation_map >= species_min) && (elevation_map <= species_max)
+    aoh = refined_habitat * refined_elevation * range_polygon * area_per_pixel_map
+    print(f'Area of habitat: {aoh.sum()}')
+```
+
+## Thanks
+
+Thanks to discussion and feedback from my colleagues, particularly Alison Eyres, Patrick Ferris, Amelia Holcomb, and Anil Madhavapeddy.
+
+Inspired by the work of Daniele Baisero in his AoH library.

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "yirgacheffe"
-version = "1.9.2"
+version = "1.9.3"
 description = "Abstraction of gdal datasets for doing basic math operations"
 readme = "README.md"
 authors = [{ name = "Michael Dales", email = "mwd24@cam.ac.uk" }]

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_datatypes.py

@@ -62,5 +62,5 @@ def test_float_to_int() -> None:
     comp.save(result)
 
     expected = backend.promote(np.array([[1, 2, 3, 4], [5, 6, 7, 8]]))
-    actual = backend.demote_array(result.read_array(0, 0, 4, 2))
+    actual = result.read_array(0, 0, 4, 2)
     assert (expected == actual).all()

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_intersection.py

@@ -67,7 +67,7 @@ def test_find_intersection_with_vector_unbound() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(left=58, top=74, right=180, bottom=42)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         raster = RasterLayer(gdal_dataset_of_region(Area(left=-180.05, top=90.09, right=180.05, bottom=-90.09), 0.13))
         vector = VectorLayer.layer_from_file(path, None, None, None)
@@ -86,10 +86,10 @@ def test_find_intersection_with_vector_bound() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(left=58, top=74, right=180, bottom=42)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         raster = RasterLayer(gdal_dataset_of_region(Area(left=-180.05, top=90.09, right=180.05, bottom=-90.09), 0.13))
-        vector = VectorLayer.layer_from_file(path, None, raster.map_projection.scale, raster.map_projection.name)
+        vector = VectorLayer.layer_from_file_like(path, raster)
         assert vector.area != area
 
         layers = [raster, vector]
@@ -104,10 +104,10 @@ def test_find_intersection_with_vector_awkward_rounding() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(left=-90, top=45, right=90, bottom=-45)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         raster = RasterLayer(gdal_dataset_of_region(Area(left=-180, top=90, right=180, bottom=-90), 18.0))
-        vector = VectorLayer.layer_from_file(path, None, raster.map_projection.scale, raster.map_projection.name)
+        vector = VectorLayer.layer_from_file_like(path, raster)
 
         rounded_area = Area(left=-90, top=54, right=90, bottom=-54)
         assert vector.area == rounded_area

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_openers.py

@@ -38,7 +38,7 @@ def test_open_raster_file_as_path() -> None:
         area = Area(-10, 10, 10, -10)
         dataset = gdal_dataset_of_region(area, 0.02, filename=path)
         dataset.Close()
-        assert path.exists
+        assert path.exists()
 
         with yg.read_raster(path) as layer:
             assert layer.area == area
@@ -156,7 +156,7 @@ def test_open_shape_like() -> None:
         assert os.path.exists(path)
 
         with yg.read_raster(path) as raster_layer:
-            path = os.path.join(tempdir, "test.gpkg")
+            path = Path(tempdir) / "test.gpkg"
             area = Area(-10.0, 10.0, 10.0, 0.0)
             make_vectors_with_id(42, {area}, path)
 

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_operators.py

@@ -78,18 +78,18 @@ def test_add_byte_layers_with_callback(skip, expected_steps) -> None:
     assert layer1.datatype == DataType.Byte
     assert layer2.datatype == DataType.Byte
 
-    callback_possitions = []
+    callback_positions: list[float] = []
 
     comp = layer1 + layer2
     comp.ystep = skip
-    comp.save(result, callback=callback_possitions.append)
+    comp.save(result, callback=callback_positions.append)
 
     expected = data1 + data2
     actual = result.read_array(0, 0, 4, 2)
 
     assert (expected == actual).all()
 
-    assert callback_possitions == expected_steps
+    assert callback_positions == expected_steps
 
 def test_sub_byte_layers() -> None:
     data1 = np.array([[10, 20, 30, 40], [50, 60, 70, 80]])
@@ -150,7 +150,7 @@ def test_mult_float_layers() -> None:
     comp = layer1 * layer2
     comp.save(result)
 
-    expected = backend.promote(data1) * backend.promote(data2)
+    expected = backend.demote_array(backend.promote(data1) * backend.promote(data2))
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -168,7 +168,7 @@ def test_div_float_layers() -> None:
     comp = layer1 / layer2
     comp.save(result)
 
-    expected = backend.promote(data1) / backend.promote(data2)
+    expected = backend.demote_array(backend.promote(data1) / backend.promote(data2))
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -186,7 +186,7 @@ def test_floor_div_float_layers() -> None:
     comp = layer1 // layer2
     comp.save(result)
 
-    expected = backend.promote(data1) // backend.promote(data2)
+    expected = backend.demote_array(backend.promote(data1) // backend.promote(data2))
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -204,7 +204,7 @@ def test_remainder_float_layers() -> None:
     comp = layer1 % layer2
     comp.save(result)
 
-    expected = backend.promote(data1) % backend.promote(data2)
+    expected = backend.demote_array(backend.promote(data1) % backend.promote(data2))
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -264,7 +264,7 @@ def test_div_float_layer_by_const() -> None:
     comp = layer1 / 2.5
     comp.save(result)
 
-    expected = backend.promote(data1) / 2.5
+    expected = backend.demote_array(backend.promote(data1) / 2.5)
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -279,7 +279,7 @@ def test_floordiv_float_layer_by_const() -> None:
     comp = layer1 // 2.5
     comp.save(result)
 
-    expected = backend.promote(data1) // 2.5
+    expected = backend.demote_array(backend.promote(data1) // 2.5)
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -294,7 +294,7 @@ def test_remainder_float_layer_by_const() -> None:
     comp = layer1 % 2.5
     comp.save(result)
 
-    expected = backend.promote(data1) % 2.5
+    expected = backend.demote_array(backend.promote(data1) % 2.5)
     backend.eval_op(expected)
 
     actual = backend.demote_array(result.read_array(0, 0, 4, 2))
@@ -1546,7 +1546,7 @@ def test_raster_and_vector() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(-5.0, 5.0, 5.0, -5.0)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         vector = VectorLayer.layer_from_file(path, None, PixelScale(1.0, -1.0), yirgacheffe.WGS_84_PROJECTION)
 
@@ -1562,7 +1562,7 @@ def test_raster_and_vector_mixed_projection() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(-5.0, 5.0, 5.0, -5.0)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         vector = VectorLayer.layer_from_file(path, None, PixelScale(1.0, -1.0), yirgacheffe.WGS_84_PROJECTION)
 
@@ -1577,7 +1577,7 @@ def test_raster_and_vector_no_scale_on_vector() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(-5.0, 5.0, 5.0, -5.0)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         vector = VectorLayer.layer_from_file(path, None, None, None)
 

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_parallel_operators.py

@@ -182,18 +182,18 @@ def test_parallel_with_different_skip(monkeypatch, skip, expected_steps) -> None
             layer2 = RasterLayer.layer_from_file(path2)
             result = RasterLayer.empty_raster_layer_like(layer1)
 
-            callback_possitions = []
+            callback_positions: list[float] = []
 
             comp = layer1 + layer2
             comp.ystep = skip
-            comp.parallel_save(result, callback=callback_possitions.append)
+            comp.parallel_save(result, callback=callback_positions.append)
 
             expected = data1 + data2
             actual = result.read_array(0, 0, 4, 4)
 
             assert (expected == actual).all()
 
-            assert callback_possitions == expected_steps
+            assert callback_positions == expected_steps
 
 @pytest.mark.skipif(yirgacheffe._backends.BACKEND != "NUMPY", reason="Only applies for numpy")
 def test_parallel_equality(monkeypatch) -> None:

yirgacheffe-1.9.3/tests/test_reduce.py

@@ -0,0 +1,23 @@
+from functools import reduce
+import operator
+
+import numpy as np
+
+from yirgacheffe.layers import RasterLayer
+from tests.helpers import gdal_dataset_with_data
+
+def test_add_similar_layers() -> None:
+    data = [
+        np.array([[1, 2, 3, 4], [5, 6, 7, 8]]),
+        np.array([[10, 20, 30, 40], [50, 60, 70, 80]]),
+        np.array([[100, 200, 300, 400], [500, 600, 700, 800]]),
+    ]
+
+    layers = [RasterLayer(gdal_dataset_with_data((0,0), 1.0, x)) for x in data]
+
+    summed_layers = reduce(operator.add, layers)
+    actual = summed_layers.read_array(0, 0, 4, 2)
+
+    expected = reduce(operator.add, data)
+
+    assert (expected == actual).all()

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_rescaling.py

@@ -170,6 +170,7 @@ def test_rescaled_up_in_operation() -> None:
     data1[4:8,0:4] = 1
     dataset1 = gdal_dataset_with_data((0, 0), 1.0, data1)
     raster1 = RasterLayer(dataset1)
+    assert raster1.map_projection
 
     data2 = np.zeros((4, 4))
     data2[0:2,0:2] = 1
@@ -198,6 +199,7 @@ def test_rescaled_down_in_operation() -> None:
     data2[2:4,2:4] = 1
     dataset2 = gdal_dataset_with_data((0, 0), 2.0, data2)
     raster2 = RasterLayer(dataset2)
+    assert raster2.map_projection
 
     rescaled = RescaledRasterLayer(raster1, raster2.map_projection)
 

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/tests/test_union.py

@@ -73,7 +73,7 @@ def test_find_union_with_vector_unbound() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(left=58, top=74, right=180, bottom=42)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         raster = RasterLayer(gdal_dataset_of_region(Area(left=59.93, top=70.07, right=170.04, bottom=44.98), 0.13))
         vector = VectorLayer.layer_from_file(path, None, None, None)
@@ -93,10 +93,10 @@ def test_find_union_with_vector_bound() -> None:
         path = Path(tempdir) / "test.gpkg"
         area = Area(left=58, top=74, right=180, bottom=42)
         make_vectors_with_id(42, {area}, path)
-        assert path.exists
+        assert path.exists()
 
         raster = RasterLayer(gdal_dataset_of_region(Area(left=59.93, top=70.07, right=170.04, bottom=44.98), 0.13))
-        vector = VectorLayer.layer_from_file(path, None, raster.map_projection.scale, raster.map_projection.name)
+        vector = VectorLayer.layer_from_file_like(path, raster)
         assert vector.area != area
 
         layers = [raster, vector]
@@ -158,10 +158,10 @@ def test_set_union_superset(left_padding: int, right_padding: int, top_padding:
     superset = Area(-1 - left_padding, 1 + top_padding, 1 + right_padding, -1 - bottom_padding)
     layer.set_window_for_union(superset)
     assert layer.window == Window(
-        (0 - left_padding) / pixel_density,
-        (0 - top_padding) / pixel_density,
-        (2 + left_padding + right_padding) / pixel_density,
-        (2 + top_padding + bottom_padding) / pixel_density,
+        round((0 - left_padding) / pixel_density),
+        round((0 - top_padding) / pixel_density),
+        round((2 + left_padding + right_padding) / pixel_density),
+        round((2 + top_padding + bottom_padding) / pixel_density),
     )
 
     origin_after_pixel = layer.read_array(

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/yirgacheffe/__init__.py

@@ -17,4 +17,8 @@ from .constants import WGS_84_PROJECTION
 from .window import Area, MapProjection, Window
 from ._backends.enumeration import dtype as DataType
 
+from ._operators import where, minumum, maximum, clip, log, log2, log10, exp, exp2, nan_to_num, isin, \
+    floor, ceil # pylint: disable=W0611
+from ._operators import abs, round # pylint: disable=W0611,W0622
+
 gdal.UseExceptions()

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/yirgacheffe/_operators.py

@@ -376,6 +376,7 @@ class LayerMathMixin:
         )
         if max_pixels:
             downsample = max(window.xsize, window.ysize) // max_pixels
+            downsample = max(downsample, 1)
             data = raw_data[::downsample,::downsample]
         else:
             data = raw_data

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/yirgacheffe/rounding.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+from typing import Sequence
 
 import math
 import sys
@@ -40,7 +41,7 @@ def round_down_pixels(value: float, pixelscale: float) -> int:
     else:
         return math.floor(value)
 
-def are_pixel_scales_equal_enough(pixel_scales: list[PixelScale | None]) -> bool:
+def are_pixel_scales_equal_enough(pixel_scales: Sequence[PixelScale | None]) -> bool:
     # some layers (e.g., constant layers) have no scale, and always work, so filter
     # them out first
     cleaned_pixel_scales: list[PixelScale] = [x for x in pixel_scales if x is not None]

yirgacheffe-1.9.3/yirgacheffe.egg-info/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: yirgacheffe
+Version: 1.9.3
+Summary: Abstraction of gdal datasets for doing basic math operations
+Author-email: Michael Dales <mwd24@cam.ac.uk>
+License-Expression: ISC
+Project-URL: Homepage, https://yirgacheffe.org/
+Project-URL: Repository, https://github.com/quantifyearth/yirgacheffe.git
+Project-URL: Issues, https://github.com/quantifyearth/yirgacheffe/issues
+Project-URL: Changelog, https://yirgacheffe.org/latest/changelog/
+Keywords: gdal,gis,geospatial,declarative
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3.0,>=1.24
+Requires-Dist: gdal[numpy]<4.0,>=3.8
+Requires-Dist: scikit-image<1.0,>=0.20
+Requires-Dist: torch
+Requires-Dist: dill
+Requires-Dist: deprecation
+Requires-Dist: tomli
+Requires-Dist: h3
+Requires-Dist: pyproj
+Provides-Extra: mlx
+Requires-Dist: mlx; extra == "mlx"
+Provides-Extra: matplotlib
+Requires-Dist: matplotlib; extra == "matplotlib"
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings-python; extra == "dev"
+Requires-Dist: mike; extra == "dev"
+Requires-Dist: mkdocs-gen-files; extra == "dev"
+Dynamic: license-file
+
+# Yirgacheffe: a declarative geospatial library for Python to make data-science with maps easier
+
+[![CI](https://github.com/quantifyearth/yirgacheffe/actions/workflows/pull-request.yml/badge.svg?branch=main)](https://github.com/quantifyearth/yirgacheffe/actions)
+[![Documentation](https://img.shields.io/badge/docs-yirgacheffe.org-blue)](https://yirgacheffe.org)
+[![PyPI version](https://img.shields.io/pypi/v/yirgacheffe)](https://pypi.org/project/yirgacheffe/)
+
+
+## Overview
+
+Yirgacheffe is a declarative geospatial library, allowing you to operate on both raster and polygon geospatial datasets without having to do all the tedious book keeping around layer alignment or dealing with hardware concerns around memory or parallelism. you can load into memory safely.
+
+Example common use-cases:
+
+* Do the datasets overlap? Yirgacheffe will let you define either the intersection or the union of a set of different datasets, scaling up or down the area as required.
+* Rasterisation of vector layers: if you have a vector dataset then you can add that to your computation and yirgaceffe will rasterize it on demand, so you never need to store more data in memory than necessary.
+* Do the raster layers get big and take up large amounts of memory? Yirgacheffe will let you do simple numerical operations with layers directly and then worry about the memory management behind the scenes for you.
+* Parallelisation of operations over many CPU cores.
+* Built in support for optionally using GPUs via [MLX](https://ml-explore.github.io/mlx/build/html/index.html) support.
+
+## Installation
+
+Yirgacheffe is available via pypi, so can be installed with pip for example:
+
+```SystemShell
+$ pip install yirgacheffe
+```
+
+## Documentation
+
+The documentation can be found on [yirgacheffe.org](https://yirgacheffe.org/)
+
+## Simple examples:
+
+Here is how to do cloud removal from [Sentinel-2 data](https://browser.dataspace.copernicus.eu/?zoom=14&lat=6.15468&lng=38.20581&themeId=DEFAULT-THEME&visualizationUrl=U2FsdGVkX1944lrmeTJcaSsnoxNMp4oucN1AjklGUANHd2cRZWyXnepHvzpaOWzMhH8SrWQo%2BqrOvOnu6f9FeCMrS%2FDZmvjzID%2FoE1tbOCEHK8ohPXjFqYojeR9%2B82ri&datasetId=S2_L2A_CDAS&fromTime=2025-09-09T00%3A00%3A00.000Z&toTime=2025-09-09T23%3A59%3A59.999Z&layerId=1_TRUE_COLOR&demSource3D=%22MAPZEN%22&cloudCoverage=30&dateMode=SINGLE), using the [Scene Classification Layer](https://custom-scripts.sentinel-hub.com/custom-scripts/sentinel-2/scene-classification/) data:
+
+```python
+import yirgaceffe as yg
+
+with (
+  yg.read_raster("T37NCG_20250909T073609_B06_20m.jp2") as vre2,
+  yg.read_raster("T37NCG_20250909T073609_SCL_20m.jp2") as scl,
+):
+  is_cloud = (scl == 8) | (scl == 9) | (scl == 10)  # various cloud types
+  is_shadow = (scl == 3)
+  is_bad = is_cloud | is_shadow
+
+  masked_vre2 = yg.where(is_bad, float("nan"), vre2)
+  masked_vre2.to_geotiff("vre2_cleaned.tif")
+```
+
+or a species' [Area of Habitat](https://www.sciencedirect.com/science/article/pii/S0169534719301892) calculation:
+
+```python
+import yirgaceffe as yg
+
+with (
+    yg.read_raster("habitats.tif") as habitat_map,
+    yg.read_raster('elevation.tif') as elevation_map,
+    yg.read_shape('species123.geojson') as range_map,
+):
+    refined_habitat = habitat_map.isin([...species habitat codes...])
+    refined_elevation = (elevation_map >= species_min) && (elevation_map <= species_max)
+    aoh = refined_habitat * refined_elevation * range_polygon * area_per_pixel_map
+    print(f'Area of habitat: {aoh.sum()}')
+```
+
+## Thanks
+
+Thanks to discussion and feedback from my colleagues, particularly Alison Eyres, Patrick Ferris, Amelia Holcomb, and Anil Madhavapeddy.
+
+Inspired by the work of Daniele Baisero in his AoH library.

{yirgacheffe-1.9.2 → yirgacheffe-1.9.3}/yirgacheffe.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ tests/test_pickle.py
 tests/test_pixel_coord.py
 tests/test_projection.py
 tests/test_raster.py
+tests/test_reduce.py
 tests/test_rescaling.py
 tests/test_rounding.py
 tests/test_save_with_window.py