yirgacheffe 1.7.9__py3-none-any.whl → 1.8.1__py3-none-any.whl

yirgacheffe/window.py

@@ -3,7 +3,6 @@ import math
 import sys
 from collections import namedtuple
 from dataclasses import dataclass
-from typing import List, Optional, Tuple
 
 PixelScale = namedtuple('PixelScale', ['xstep', 'ystep'])
 
@@ -13,23 +12,15 @@ class MapProjection:
 
     This superceeeds the old PixelScale class, which will be removed in version 2.0.
 
-    Parameters
-    ----------
-    name : str
-        The map projection used.
-    xstep : float
-        The number of units horizontal distance a step of one pixel makes in the map projection.
-    ystep : float
-        The number of units verticle distance a step of one pixel makes in the map projection.
+    Args:
+        name: The map projection used.
+        xstep: The number of units horizontal distance a step of one pixel makes in the map projection.
+        ystep: The number of units vertical distance a step of one pixel makes in the map projection.
 
-    Attributes
-    ----------
-    name : str
-        The map projection used.
-    xstep : float
-        The number of units horizontal distance a step of one pixel makes in the map projection.
-    ystep : float
-        The number of units verticle distance a step of one pixel makes in the map projection.
+    Attributes:
+        name: The map projection used.
+        xstep: The number of units horizontal distance a step of one pixel makes in the map projection.
+        ystep: The number of units vertical distance a step of one pixel makes in the map projection.
     """
 
     name : str
@@ -52,27 +43,17 @@ class MapProjection:
 class Area:
     """Class to hold a geospatial area of data in the given projection.
 
-    Parameters
-    ----------
-    left : float
-        Left most point in the projection space
-    top : float
-        Top most point in the projection space
-    right : float
-        Right most point in the projection space
-    bottom : float
-        Bottom most point in the projection space
-
-    Attributes
-    ----------
-    left : float
-        Left most point in the projection space
-    top : float
-        Top most point in the projection space
-    right : float
-        Right most point in the projection space
-    bottom : float
-        Bottom most point in the projection space
+    Args:
+        left: Left most point in the projection space.
+        top: Top most point in the projection space.
+        right: Right most point in the projection space.
+        bottom: Bottom most point in the projection space.
+
+    Attributes:
+        left: Left most point in the projection space.
+        top: Top most point in the projection space.
+        right: Right most point in the projection space.
+        bottom: Bottom most point in the projection space.
     """
     left: float
     top: float
@@ -83,9 +64,7 @@ class Area:
     def world() -> Area:
         """Creates an area that covers the entire planet.
 
-        Returns
-        -------
-        Area
+        Returns:
             An area where the extents are nan, but is_world returns true.
         """
         return Area(float("nan"), float("nan"), float("nan"), float("nan"))
@@ -93,27 +72,24 @@ class Area:
     def __hash__(self):
         return (self.left, self.top, self.right, self.bottom).__hash__()
 
-    def __eq__(self, other) -> bool:
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Area):
+            return False
         return math.isclose(self.left, other.left, abs_tol=1e-09) and \
             math.isclose(self.right, other.right, abs_tol=1e-09) and \
             math.isclose(self.top, other.top, abs_tol=1e-09) and \
             math.isclose(self.bottom, other.bottom, abs_tol=1e-09)
 
-    def grow(self, offset: float):
+    def grow(self, offset: float) -> Area:
         """Expand the area in all directions by the given amount.
 
         Generates a new area that is an expanded version of the current area.
 
-        Parameters
-        ----------
-        offset : float
-            The amount by which to grow the area
+        Args:
+            offset: The amount by which to grow the area.
 
-        Returns
-        -------
-        Area
+        Returns:
             A new area of the expanded size.
-
         """
         return Area(
             left=self.left - offset,
@@ -124,26 +100,20 @@ class Area:
 
     @property
     def is_world(self) -> bool:
-        """Returns true if this is a global area, independant of projection.
+        """Returns true if this is a global area, independent of projection.
 
-        Returns
-        -------
-        bool
-            True is the Area was created with `world` otherwise False.
+        Returns:
+            True if the Area was created with `world` otherwise False.
         """
         return math.isnan(self.left)
 
-    def overlaps(self, other) -> bool:
+    def overlaps(self, other: Area) -> bool:
         """Check if this area overlaps with another area.
 
-        Parameters
-        ----------
-        other : Area
-            The other area to compare this area with
+        Args:
+            other: The other area to compare this area with.
 
-        Returns
-        -------
-        bool
+        Returns:
             True if the two areas intersect, otherwise false.
         """
 
@@ -166,27 +136,17 @@ class Area:
 class Window:
     """Class to hold the pixel dimensions of data in the given projection.
 
-    Parameters
-    ----------
-    xoff : int
-        X axis offset
-    yoff : int
-        Y axis offset
-    xsize : int
-        Width of data in pixels
-    ysize : float
-        Height of data in pixels
-
-    Attributes
-    ----------
-    xoff : int
-        X axis offset
-    yoff : int
-        Y axis offset
-    xsize : int
-        Width of data in pixels
-    ysize : float
-        Height of data in pixels
+    Args:
+        xoff: X axis offset.
+        yoff: Y axis offset.
+        xsize: Width of data in pixels.
+        ysize: Height of data in pixels.
+
+    Attributes:
+        xoff: X axis offset.
+        yoff: Y axis offset.
+        xsize: Width of data in pixels.
+        ysize: Height of data in pixels.
     """
     xoff: int
     yoff: int
@@ -194,7 +154,7 @@ class Window:
     ysize: int
 
     @property
-    def as_array_args(self) -> Tuple[int,...]:
+    def as_array_args(self) -> tuple[int, ...]:
         """A tuple containing xoff, yoff, xsize, and ysize."""
         return (self.xoff, self.yoff, self.xsize, self.ysize)
 
@@ -230,21 +190,16 @@ class Window:
             ((self.xoff + self.xsize) >= (other.xoff + other.xsize)) and \
             ((self.yoff + self.ysize) >= (other.yoff + other.ysize))
 
-    def grow(self, pixels: int):
+    def grow(self, pixels: int) -> Window:
         """Expand the area in all directions by the given amount.
 
         Generates a new window that is an expanded version of the current window.
 
-        Parameters
-        ----------
-        pixels : int
-            The amount by which to grow the window in pixels
+        Args:
+            pixels: The amount by which to grow the window in pixels.
 
-        Returns
-        -------
-        Window
+        Returns:
             A new window of the expanded size.
-
         """
         return Window(
             xoff=self.xoff - pixels,
@@ -254,7 +209,7 @@ class Window:
         )
 
     @staticmethod
-    def find_intersection(windows: List) -> "Window":
+    def find_intersection(windows: list) -> Window:
         if not windows:
             raise ValueError("Expected list of windows")
         # This isn't very pythonic, as it was originally written, but
@@ -277,7 +232,7 @@ class Window:
         )
 
     @staticmethod
-    def find_intersection_no_throw(windows: List) -> Optional["Window"]:
+    def find_intersection_no_throw(windows: list) -> Window | None:
         if not windows:
             raise ValueError("Expected list of windows")
         # This isn't very pythonic, as it was originally written, but

{yirgacheffe-1.7.9.dist-info → yirgacheffe-1.8.1.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: yirgacheffe
-Version: 1.7.9
+Version: 1.8.1
 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://github.com/quantifyearth/yirgacheffe
+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://github.com/quantifyearth/yirgacheffe/blob/main/CHANGES.md
+Project-URL: Changelog, https://yirgacheffe.org/latest/changelog/
 Keywords: gdal,gis,geospatial,declarative
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
@@ -36,9 +36,13 @@ 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 gdal wrapper that does the tricky bits
+# Yirgacheffe: a declarative geospatial library for Python to make data-science with maps easier
 
 ## Overview
 

yirgacheffe-1.8.1.dist-info/RECORD

@@ -0,0 +1,27 @@
+yirgacheffe/__init__.py,sha256=OOzfXtafPoDpAsNRC08BXjmwv0hBp-mNFCjwplGs9lY,668
+yirgacheffe/_core.py,sha256=AU6tlqovBV_l1dNZs6AlHSw59Z0U6pStUaQZvJGiLhM,5721
+yirgacheffe/_operators.py,sha256=OiR4pCVILmdXDmG37YILJuYjcxZlRussrJC7DeyoOts,36070
+yirgacheffe/constants.py,sha256=uCWJwec3-ND-zVxYbsk1sdHKANl3ToNCTPg7MZb0j2g,434
+yirgacheffe/operators.py,sha256=nw-BpnAwTjCwFtjosa8wKd2MGUuC0PJR5jACFdLhqCg,412
+yirgacheffe/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+yirgacheffe/rounding.py,sha256=ZNuAaxsWfzYETC_G9H5weY1ZOci2pihEKTVrUiIqfZw,2257
+yirgacheffe/window.py,sha256=WTCqX4Tw24siD0l13Pxl-GPufiC5M1OwZfhrNmJe_Gg,8986
+yirgacheffe/_backends/__init__.py,sha256=jN-2iRrHStnPI6cNL7XhwhsROtI0EaGfIrbF5c-ECV0,334
+yirgacheffe/_backends/enumeration.py,sha256=9bcCXz9Ssrh8Oh1iazodkx6Gm2kQBi9HQ9z9zehS4AE,1806
+yirgacheffe/_backends/mlx.py,sha256=U1gl1lK1mZXLEET6ylF1TNs6WJ0PBEvfSk7ppn28n8w,6203
+yirgacheffe/_backends/numpy.py,sha256=Gxx49JJH79GFEkKIpV6IyjCUcdtN5-qLlzRfylzKhS4,4142
+yirgacheffe/layers/__init__.py,sha256=mYKjw5YTcMNv_hMy7a6K4yRzIuNUbR8WuBTw4WIAmSk,435
+yirgacheffe/layers/area.py,sha256=wJcMHbLJBaXS4BeFbu5rYeKfgu3gvaE9hwQ5j6aw-y4,3976
+yirgacheffe/layers/base.py,sha256=dQQLFKP05QK4C73N1DCDYT8D8eD15HuSQKN5KrABeHg,14289
+yirgacheffe/layers/constant.py,sha256=gtkQ98Z01CYYDgFElswtRZY4ZG3UnS5NIAoIVue5ufk,1481
+yirgacheffe/layers/group.py,sha256=yaqf-ra_Vh59yrWcz7-OvJ1fBnTcBXZd18AfRDN5Ymo,16157
+yirgacheffe/layers/h3layer.py,sha256=Rq1bFo7CApIh5NdBcV7hSj3hm-DszY79nhYsTRAvJ_g,9916
+yirgacheffe/layers/rasters.py,sha256=zBE9uXm6LvAQF2_XdQzcOgJQOQWGmuPflY5JNDrUf3k,13527
+yirgacheffe/layers/rescaled.py,sha256=gEFbXeYxX1nVn7eQYmbGww90_yc5ENmgQrD_WxXxpQE,3352
+yirgacheffe/layers/vectors.py,sha256=A27kuTr0C9BZhHG0-cplNEa7aSNcse37Pm9xTjEzv-c,19990
+yirgacheffe-1.8.1.dist-info/licenses/LICENSE,sha256=dNSHwUCJr6axStTKDEdnJtfmDdFqlE3h1NPCveqPfnY,757
+yirgacheffe-1.8.1.dist-info/METADATA,sha256=iPbaENoRBTey7wYvg3OUTKjkulgoFS0wcwJoRJ2HcYQ,23797
+yirgacheffe-1.8.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+yirgacheffe-1.8.1.dist-info/entry_points.txt,sha256=j4KgHXbVGbGyfTySc1ypBdERpfihO4WNjppvCdE9HjE,52
+yirgacheffe-1.8.1.dist-info/top_level.txt,sha256=9DBFlKO2Ld3hG6TuE3qOTd3Tt8ugTiXil4AN4Wr9_y0,12
+yirgacheffe-1.8.1.dist-info/RECORD,,

yirgacheffe-1.7.9.dist-info/RECORD

@@ -1,27 +0,0 @@
-yirgacheffe/__init__.py,sha256=pY9dqmHHARfY44T-7-7y6Ah97qQHj9_0pgYTItI5TR8,567
-yirgacheffe/_core.py,sha256=hnACrthBI8OFNoi88-Qnj-4aizBGZstFO7kj-5g9MSU,6083
-yirgacheffe/_operators.py,sha256=63KZZKTW-Pz0eOBRZUuolWxNNQvPC_sHruAdyo6J5dc,36238
-yirgacheffe/constants.py,sha256=uCWJwec3-ND-zVxYbsk1sdHKANl3ToNCTPg7MZb0j2g,434
-yirgacheffe/operators.py,sha256=nw-BpnAwTjCwFtjosa8wKd2MGUuC0PJR5jACFdLhqCg,412
-yirgacheffe/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-yirgacheffe/rounding.py,sha256=ggBG4lMyLMtHLW3dBxr3gBCcF2qhRrY5etZiFGlIoqA,2258
-yirgacheffe/window.py,sha256=Oxf8VcslLxNacqjUcDHqZLvdMaTnIwuNwjsm1WEOc0g,9503
-yirgacheffe/_backends/__init__.py,sha256=jN-2iRrHStnPI6cNL7XhwhsROtI0EaGfIrbF5c-ECV0,334
-yirgacheffe/_backends/enumeration.py,sha256=Jrce2p2n4Wlk5tHBkiWntDnpLSD_0H-bnwgsKXHjkwQ,1018
-yirgacheffe/_backends/mlx.py,sha256=6a0S80JCxwiq72hWv-83238NaQykn-vQw_IDRBIBbbw,6173
-yirgacheffe/_backends/numpy.py,sha256=N-Ygpw1lgJJI7xGoRJnB480rR0tst75cOIowubGnSjw,4112
-yirgacheffe/layers/__init__.py,sha256=mYKjw5YTcMNv_hMy7a6K4yRzIuNUbR8WuBTw4WIAmSk,435
-yirgacheffe/layers/area.py,sha256=LeLSinB-z2k4ODSfiNJvQnSnMfa8Gn7VnkJrLt50zVU,3970
-yirgacheffe/layers/base.py,sha256=-7QIfAI3iGlzt-dDLztpRaLrL2sSqB1y2Yw2TdJ9VJM,14426
-yirgacheffe/layers/constant.py,sha256=8wfyw1JOxr5FQv_M9Jzbd6vW2rjK3AJHmoe-ftDmPlM,1457
-yirgacheffe/layers/group.py,sha256=hK84oCAweaX2eQP0DXPd_uHj1aVdTD9F-gaCRPfjxmY,16202
-yirgacheffe/layers/h3layer.py,sha256=t8yC3c8pXU5qbFqsfP76ZX8UHkW9lK4ZgnNm4pwTjls,9886
-yirgacheffe/layers/rasters.py,sha256=M2DG5-UPbhKsCHL5B2LDncqgb7VP6yzeDfXv_U6EaZo,13610
-yirgacheffe/layers/rescaled.py,sha256=jbr2GxFy3I29vudX0oyMaFRTimrbEcAPI6dnHvjWpfU,3377
-yirgacheffe/layers/vectors.py,sha256=c8QWeKF1umBGo5BYyJPl-CN_EfjxdTGNaQJDfAkvTIM,20139
-yirgacheffe-1.7.9.dist-info/licenses/LICENSE,sha256=dNSHwUCJr6axStTKDEdnJtfmDdFqlE3h1NPCveqPfnY,757
-yirgacheffe-1.7.9.dist-info/METADATA,sha256=cfrQwtndmOW5MTb28UoWG73U-1j4ufa1SyqoLACr2SA,23618
-yirgacheffe-1.7.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-yirgacheffe-1.7.9.dist-info/entry_points.txt,sha256=j4KgHXbVGbGyfTySc1ypBdERpfihO4WNjppvCdE9HjE,52
-yirgacheffe-1.7.9.dist-info/top_level.txt,sha256=9DBFlKO2Ld3hG6TuE3qOTd3Tt8ugTiXil4AN4Wr9_y0,12
-yirgacheffe-1.7.9.dist-info/RECORD,,