morecantile 5.4.2__tar.gz → 6.1.0__tar.gz

{morecantile-5.4.2 → morecantile-6.1.0}/.gitignore

@@ -130,3 +130,7 @@ dmypy.json
 
 # PyCharm:
 .idea
+
+# VSCode
+.vscode
+.vscode/

{morecantile-5.4.2 → morecantile-6.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: morecantile
-Version: 5.4.2
+Version: 6.1.0
 Summary: Construct and use map tile grids (a.k.a TileMatrixSet / TMS).
 Keywords: GIS,TMS,TileMatrixSet,Map Tile
 Author-email: Vincent Sarago <vincent@developmentseed.com>
@@ -18,10 +18,14 @@ Classifier: Topic :: Scientific/Engineering :: GIS
 Requires-Dist: attrs
 Requires-Dist: pyproj~=3.1
 Requires-Dist: pydantic~=2.0
+Requires-Dist: pytest ; extra == "benchmark"
+Requires-Dist: pytest-benchmark ; extra == "benchmark"
 Requires-Dist: pre-commit ; extra == "dev"
 Requires-Dist: bump-my-version ; extra == "dev"
-Requires-Dist: mkdocs ; extra == "docs"
-Requires-Dist: mkdocs-material ; extra == "docs"
+Requires-Dist: mkdocs>=1.4.3 ; extra == "docs"
+Requires-Dist: mkdocs-material[imaging]>=9.5 ; extra == "docs"
+Requires-Dist: griffe-inherited-docstrings>=1.0.0 ; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.25.1 ; extra == "docs"
 Requires-Dist: pygments ; extra == "docs"
 Requires-Dist: rasterio>=1.2.1 ; extra == "rasterio"
 Requires-Dist: mercantile ; extra == "test"
@@ -30,6 +34,7 @@ Requires-Dist: pytest-cov ; extra == "test"
 Requires-Dist: rasterio>=1.2.1 ; extra == "test"
 Project-URL: Documentation, https://developmentseed.org/morecantile/
 Project-URL: Source, https://github.com/developmentseed/morecantile
+Provides-Extra: benchmark
 Provides-Extra: dev
 Provides-Extra: docs
 Provides-Extra: rasterio

morecantile-6.1.0/benchmarks/README.md

@@ -0,0 +1,63 @@
+
+## Benchmark
+
+Compare `mercantile`, `utiles` and `morecantile`
+
+```sh
+python -m pip install -r requirements.txt
+python -m pytest benchmarks.py --benchmark-only --benchmark-columns 'min, max, mean, median' --benchmark-sort 'min'
+```
+
+```
+----------------------------------------------------- benchmark 'bounds': 21 tests ----------------------------------------------------
+Name (time in ns)                                   Min                     Max                   Mean                 Median
+---------------------------------------------------------------------------------------------------------------------------------------
+test_bounds[utiles-(486, 332, 30)]              83.0000 (1.0)       52,000.0000 (52.97)       195.3371 (1.48)        208.0000 (1.60)
+test_bounds[utiles-(0, 0, 0)]                   83.0000 (1.00)      31,167.0000 (31.75)       193.5957 (1.47)        208.0000 (1.60)
+test_bounds[utiles-(1, 0, 1)]                  125.0000 (1.51)         981.6700 (1.0)         132.0177 (1.0)         130.8300 (1.01)
+test_bounds[utiles-(1, 40, 7)]                 125.0000 (1.51)       8,606.2500 (8.77)        132.5298 (1.00)        130.0000 (1.0)
+test_bounds[utiles-(486, 332, 10)]             128.3300 (1.55)       1,600.8300 (1.63)        133.4046 (1.01)        131.6700 (1.01)
+test_bounds[utiles-(1, 1, 1)]                  129.5900 (1.56)      16,846.2500 (17.16)       141.9846 (1.08)        134.1700 (1.03)
+test_bounds[utiles-(486, 332, 20)]             138.3300 (1.67)       1,123.3300 (1.14)        142.5420 (1.08)        141.2500 (1.09)
+test_bounds[mercantile-(1, 40, 7)]           1,000.0000 (12.05)     92,416.0000 (94.14)     1,193.0112 (9.04)      1,167.0000 (8.98)
+test_bounds[mercantile-(1, 1, 1)]            1,075.0000 (12.95)     48,066.8000 (48.96)     1,154.8100 (8.75)      1,141.6000 (8.78)
+test_bounds[mercantile-(0, 0, 0)]            1,083.0000 (13.05)     21,041.0000 (21.43)     1,214.6049 (9.20)      1,208.0000 (9.29)
+test_bounds[mercantile-(1, 0, 1)]            1,083.0000 (13.05)     75,291.0000 (76.70)     1,213.7837 (9.19)      1,208.0000 (9.29)
+test_bounds[mercantile-(486, 332, 10)]       1,083.0000 (13.05)     55,750.0000 (56.79)     1,223.7598 (9.27)      1,208.0000 (9.29)
+test_bounds[mercantile-(486, 332, 20)]       1,083.0000 (13.05)     89,041.0000 (90.70)     1,248.4256 (9.46)      1,209.0000 (9.30)
+test_bounds[mercantile-(486, 332, 30)]       1,083.0000 (13.05)    194,958.0000 (198.60)    1,239.4339 (9.39)      1,209.0000 (9.30)
+test_bounds[morecantile-(1, 0, 1)]          20,083.0000 (241.96)   132,625.0000 (135.10)   20,893.1235 (158.26)   20,667.0000 (158.98)
+test_bounds[morecantile-(0, 0, 0)]          20,166.0000 (242.96)   120,333.0000 (122.58)   20,974.1961 (158.87)   20,708.0000 (159.29)
+test_bounds[morecantile-(1, 1, 1)]          20,334.0000 (244.99)    60,958.0000 (62.10)    21,236.2953 (160.86)   20,750.0000 (159.62)
+test_bounds[morecantile-(1, 40, 7)]         21,667.0000 (261.05)   173,458.0000 (176.70)   22,622.6537 (171.36)   22,333.0000 (171.79)
+test_bounds[morecantile-(486, 332, 10)]     22,166.0000 (267.06)   205,125.0000 (208.96)   23,512.1607 (178.10)   22,875.0000 (175.96)
+test_bounds[morecantile-(486, 332, 20)]     24,708.0000 (297.69)   129,250.0000 (131.66)   25,775.0796 (195.24)   25,375.0000 (195.19)
+test_bounds[morecantile-(486, 332, 30)]     71,292.0000 (858.94)   205,625.0000 (209.46)   73,569.4565 (557.27)   72,667.0000 (558.98)
+---------------------------------------------------------------------------------------------------------------------------------------
+
+---------------------------------------------------- benchmark 'xy_bounds': 21 tests -----------------------------------------------------
+Name (time in ns)                                      Min                     Max                   Mean                 Median
+------------------------------------------------------------------------------------------------------------------------------------------
+test_xy_bounds[utiles-(0, 0, 0)]                   83.0000 (1.0)       57,375.0000 (112.55)      145.9127 (1.57)        125.0000 (1.36)
+test_xy_bounds[utiles-(1, 1, 1)]                   88.3400 (1.06)       1,335.4200 (2.62)         93.1478 (1.00)         92.5000 (1.00)
+test_xy_bounds[utiles-(1, 40, 7)]                  88.7500 (1.07)       1,451.2500 (2.85)         93.1258 (1.0)          92.0900 (1.0)
+test_xy_bounds[utiles-(1, 0, 1)]                   89.5900 (1.08)         861.6600 (1.69)         93.6428 (1.01)         93.3300 (1.01)
+test_xy_bounds[utiles-(486, 332, 10)]              90.0000 (1.08)         509.7950 (1.0)          93.2818 (1.00)         92.9150 (1.01)
+test_xy_bounds[utiles-(486, 332, 20)]              90.4100 (1.09)         864.1700 (1.70)         94.2974 (1.01)         94.1600 (1.02)
+test_xy_bounds[utiles-(486, 332, 30)]              90.4100 (1.09)       1,377.5000 (2.70)         94.7366 (1.02)         94.1600 (1.02)
+test_xy_bounds[mercantile-(0, 0, 0)]              708.0000 (8.53)      42,250.0000 (82.88)       843.2292 (9.05)        833.0000 (9.05)
+test_xy_bounds[mercantile-(486, 332, 10)]         731.2500 (8.81)       5,393.7500 (10.58)       770.8331 (8.28)        764.6000 (8.30)
+test_xy_bounds[mercantile-(486, 332, 30)]         731.2500 (8.81)       7,316.6500 (14.35)       770.2423 (8.27)        764.6000 (8.30)
+test_xy_bounds[mercantile-(1, 0, 1)]              732.1429 (8.82)       9,404.8571 (18.45)       791.7721 (8.50)        785.7143 (8.53)
+test_xy_bounds[mercantile-(1, 40, 7)]             733.3000 (8.83)       5,950.0000 (11.67)       772.3273 (8.29)        766.7000 (8.33)
+test_xy_bounds[mercantile-(486, 332, 20)]         733.3500 (8.84)       7,408.3000 (14.53)       773.4718 (8.31)        768.7500 (8.35)
+test_xy_bounds[mercantile-(1, 1, 1)]              735.4000 (8.86)       4,762.5000 (9.34)        783.2100 (8.41)        777.1000 (8.44)
+test_xy_bounds[morecantile-(0, 0, 0)]           3,042.0000 (36.65)    108,208.0000 (212.26)    3,287.1089 (35.30)     3,250.0000 (35.29)
+test_xy_bounds[morecantile-(1, 0, 1)]           3,291.0000 (39.65)     68,166.0000 (133.71)    3,503.4695 (37.62)     3,459.0000 (37.56)
+test_xy_bounds[morecantile-(1, 1, 1)]           3,291.0000 (39.65)     72,875.0000 (142.95)    3,506.8544 (37.66)     3,500.0000 (38.01)
+test_xy_bounds[morecantile-(1, 40, 7)]          4,375.0000 (52.71)     76,375.0000 (149.82)    4,630.2893 (49.72)     4,584.0000 (49.78)
+test_xy_bounds[morecantile-(486, 332, 10)]      4,875.0000 (58.73)     85,208.0000 (167.14)    5,197.3581 (55.81)     5,125.0000 (55.65)
+test_xy_bounds[morecantile-(486, 332, 20)]      6,916.0000 (83.33)     78,458.0000 (153.90)    7,221.0669 (77.54)     7,166.0000 (77.82)
+test_xy_bounds[morecantile-(486, 332, 30)]     52,667.0000 (634.54)   404,208.0000 (792.88)   54,749.1232 (587.90)   54,333.0000 (590.00)
+------------------------------------------------------------------------------------------------------------------------------------------
+```

morecantile-6.1.0/benchmarks/benchmarks.py

@@ -0,0 +1,96 @@
+"""Morecantile/Mercantile/Utiles comparison benchmark
+
+The benchmark suite is adapted from jessekrubin/utiles
+https://github.com/jessekrubin/utiles/blob/ea58b9a017a2e3528f03cc20f16ef531737b863f/utiles-pyo3/bench/test_bench.py#L17-L25
+"""
+# This file is a modified version of https://github.com/jessekrubin/utiles/blob/ea58b9a017a2e3528f03cc20f16ef531737b863f/utiles-pyo3/bench/test_bench.py.
+#
+# The original license follows.
+#
+# MIT License
+#
+# Copyright (c) 2023 jessekrubin
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from typing import Callable, Tuple
+
+import mercantile
+import pytest
+import utiles
+
+import morecantile
+
+tms = morecantile.tms.get("WebMercatorQuad")
+
+TEST_TILES = (
+    (0, 0, 0),
+    (1, 0, 1),
+    (1, 1, 1),
+    (1, 40, 7),
+    (486, 332, 10),
+    # HIGH ZOOM
+    (486, 332, 20),
+    # OUTSIDE TMS Range
+    (486, 332, 30),
+)
+
+
+@pytest.mark.parametrize(
+    "tile",
+    [pytest.param(t, id=str(t)) for t in TEST_TILES],
+)
+@pytest.mark.parametrize(
+    "func",
+    [
+        pytest.param(mercantile.bounds, id="mercantile"),
+        pytest.param(tms.bounds, id="morecantile"),
+        pytest.param(utiles.bounds, id="utiles"),
+    ],
+)
+@pytest.mark.benchmark(group="bounds")
+def test_bounds(
+    tile: Tuple[int, int, int],
+    func: Callable[[Tuple[int, int, int]], Tuple[float, float]],
+    benchmark,
+) -> None:
+    """Benchmark bounds() method."""
+    _ = benchmark(func, *tile)
+
+
+@pytest.mark.parametrize(
+    "tile",
+    [pytest.param(t, id=str(t)) for t in TEST_TILES],
+)
+@pytest.mark.parametrize(
+    "func",
+    [
+        pytest.param(mercantile.xy_bounds, id="mercantile"),
+        pytest.param(tms.xy_bounds, id="morecantile"),
+        pytest.param(utiles.xy_bounds, id="utiles"),
+    ],
+)
+@pytest.mark.benchmark(group="xy_bounds")
+def test_xy_bounds(
+    tile: Tuple[int, int, int],
+    func: Callable[[Tuple[int, int, int]], Tuple[float, float]],
+    benchmark,
+) -> None:
+    """Benchmark xy_bounds() method."""
+    _ = benchmark(func, *tile)

morecantile-6.1.0/benchmarks/requirements.txt

@@ -0,0 +1,6 @@
+pytest
+pytest-benchmark
+
+morecantile
+mercantile
+utiles

{morecantile-5.4.2 → morecantile-6.1.0}/morecantile/__init__.py

@@ -8,7 +8,7 @@ Refs:
 
 """
 
-__version__ = "5.4.2"
+__version__ = "6.1.0"
 
 from .commons import BoundingBox, Coords, Tile  # noqa
 from .defaults import TileMatrixSets, tms  # noqa

{morecantile-5.4.2 → morecantile-6.1.0}/morecantile/commons.py

@@ -7,10 +7,10 @@ class BoundingBox(NamedTuple):
     """A xmin,ymin,xmax,ymax coordinates tuple.
 
     Args:
-    left (number): min horizontal coordinate.
-    bottom (number):min vertical coordinate.
-    right (number): max horizontal coordinate.
-    top (number): max vertical coordinate.
+        left (number): min horizontal coordinate.
+        bottom (number):min vertical coordinate.
+        right (number): max horizontal coordinate.
+        top (number): max vertical coordinate.
 
     Examples:
         >>> BoundingBox(-180.0, -90.0, 180.0, 90.0)

{morecantile-5.4.2 → morecantile-6.1.0}/morecantile/models.py

@@ -40,7 +40,6 @@ from morecantile.utils import (
 NumType = Union[float, int]
 BoundsType = Tuple[NumType, NumType]
 LL_EPSILON = 1e-11
-WGS84_CRS = pyproj.CRS.from_epsg(4326)
 axesInfo = Annotated[List[str], Field(min_length=2, max_length=2)]
 
 
@@ -486,24 +485,25 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
     ]
 
     # Private attributes
-    _geographic_crs: pyproj.CRS = PrivateAttr(default=WGS84_CRS)
     _to_geographic: pyproj.Transformer = PrivateAttr()
     _from_geographic: pyproj.Transformer = PrivateAttr()
 
+    _tile_matrices_idx: Dict[int, int] = PrivateAttr()
+
     def __init__(self, **data):
         """Set private attributes."""
         super().__init__(**data)
 
-        self._geographic_crs = pyproj.CRS.from_user_input(
-            data.get("_geographic_crs", WGS84_CRS)
-        )
+        self._tile_matrices_idx = {
+            int(mat.id): idx for idx, mat in enumerate(self.tileMatrices)
+        }
 
         try:
             self._to_geographic = pyproj.Transformer.from_crs(
-                self.crs._pyproj_crs, self._geographic_crs, always_xy=True
+                self.crs._pyproj_crs, self.crs._pyproj_crs.geodetic_crs, always_xy=True
             )
             self._from_geographic = pyproj.Transformer.from_crs(
-                self._geographic_crs, self.crs._pyproj_crs, always_xy=True
+                self.crs._pyproj_crs.geodetic_crs, self.crs._pyproj_crs, always_xy=True
             )
         except ProjError:
             warnings.warn(
@@ -555,7 +555,7 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
     @cached_property
     def geographic_crs(self) -> pyproj.CRS:
         """Return the TMS's geographic CRS."""
-        return self._geographic_crs
+        return self.crs._pyproj_crs.geodetic_crs
 
     @cached_property
     def rasterio_crs(self):
@@ -565,7 +565,7 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
     @cached_property
     def rasterio_geographic_crs(self):
         """Return the geographic CRS as a rasterio CRS."""
-        return to_rasterio_crs(self._geographic_crs)
+        return to_rasterio_crs(self.crs._pyproj_crs.geodetic_crs)
 
     @property
     def minzoom(self) -> int:
@@ -656,7 +656,6 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
         title: Optional[str] = None,
         id: Optional[str] = None,
         ordered_axes: Optional[List[str]] = None,
-        geographic_crs: pyproj.CRS = WGS84_CRS,
         screen_pixel_size: float = 0.28e-3,
         decimation_base: int = 2,
         **kwargs: Any,
@@ -689,8 +688,6 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
             Tile Matrix Set title
         id: str, optional
             Tile Matrix Set identifier
-        geographic_crs: pyproj.CRS
-            Geographic (lat,lon) coordinate reference system (default is EPSG:4326)
         ordered_axes: list of str, optional
             Override Axis order (e.g `["N", "S"]`) else default to CRS's metadata
         screen_pixel_size: float, optional
@@ -769,15 +766,13 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
             tileMatrices=tile_matrices,
             id=id,
             title=title,
-            _geographic_crs=geographic_crs,
             **kwargs,
         )
 
     def matrix(self, zoom: int) -> TileMatrix:
         """Return the TileMatrix for a specific zoom."""
-        for m in self.tileMatrices:
-            if m.id == str(zoom):
-                return m
+        if (idx := self._tile_matrices_idx.get(zoom, None)) is not None:
+            return self.tileMatrices[idx]
 
         #######################################################################
         # If user wants a deeper matrix we calculate it
@@ -1103,8 +1098,23 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
         """
         t = _parse_tile_arg(*tile)
 
-        left, top = self._ul(t)
-        right, bottom = self._lr(t)
+        matrix = self.matrix(t.z)
+        origin_x, origin_y = self._matrix_origin(matrix)
+
+        cf = (
+            matrix.get_coalesce_factor(t.y)
+            if matrix.variableMatrixWidths is not None
+            else 1
+        )
+
+        left = origin_x + math.floor(t.x / cf) * matrix.cellSize * cf * matrix.tileWidth
+        top = origin_y - t.y * matrix.cellSize * matrix.tileHeight
+        right = (
+            origin_x
+            + (math.floor(t.x / cf) + 1) * matrix.cellSize * cf * matrix.tileWidth
+        )
+        bottom = origin_y - (t.y + 1) * matrix.cellSize * matrix.tileHeight
+
         return BoundingBox(left, bottom, right, top)
 
     def ul(self, *tile: Tile) -> Coords:
@@ -1156,10 +1166,10 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
         BoundingBox: The bounding box of the input tile.
 
         """
-        t = _parse_tile_arg(*tile)
+        _left, _bottom, _right, _top = self.xy_bounds(*tile)
+        left, top = self.lnglat(_left, _top)
+        right, bottom = self.lnglat(_right, _bottom)
 
-        left, top = self.ul(t)
-        right, bottom = self.lr(t)
         return BoundingBox(left, bottom, right, top)
 
     @property

{morecantile-5.4.2 → morecantile-6.1.0}/pyproject.toml

@@ -36,13 +36,19 @@ test = [
     "pytest-cov",
     "rasterio>=1.2.1",
 ]
+benchmark = [
+    "pytest",
+    "pytest-benchmark",
+]
 dev = [
     "pre-commit",
     "bump-my-version",
 ]
 docs = [
-    "mkdocs",
-    "mkdocs-material",
+    "mkdocs>=1.4.3",
+    "mkdocs-material[imaging]>=9.5",
+    "griffe-inherited-docstrings>=1.0.0",
+    "mkdocstrings[python]>=0.25.1",
     "pygments",
 ]
 
@@ -114,7 +120,7 @@ filterwarnings = [
 ]
 
 [tool.bumpversion]
-current_version = "5.4.2"
+current_version = "6.1.0"
 
 search = "{current_version}"
 replace = "{new_version}"