Reorganize titiler-cmr utilities (#7)

maxrjones · web-flow · commit 15f490712eee · 2025-09-11T13:47:32.000-04:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -3,9 +3,8 @@ name: Deploy to GitHub Pages
 on:
   push:
     branches: [main]
-  # Comment out unless for testing
-  # pull_request:
-  #   branches: [main]
+  pull_request:
+    branches: [main]
   workflow_dispatch:
 
 permissions:
@@ -40,12 +39,14 @@ jobs:
 
       - name: Upload artifact
         id: deployment
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
         uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
         with:
           path: ./site
           retention-days: 1
 
   deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
diff --git a/.gitignore b/.gitignore
@@ -90,4 +90,5 @@ tests/.hypothesis
 .hypothesis/
 
 docs/_site
+site
 .mypy_cache
diff --git a/docs/api-reference/datacube-benchmark.md b/docs/api-reference/datacube-benchmark.md
@@ -10,10 +10,4 @@
 
 ::: datacube_benchmark.benchmark_access_patterns
 
-::: datacube_benchmark.benchmark_viewport
-
-::: datacube_benchmark.benchmark_tileset
-
-::: datacube_benchmark.benchmark_statistics
-
 ::: datacube_benchmark.types.TARGET_SHAPES
diff --git a/docs/api-reference/titiler-benchmark.md b/docs/api-reference/titiler-benchmark.md
@@ -1,15 +1,15 @@
 # Dynamic tiling
 
-::: datacube_benchmark.tiling_benchmark_summary
+::: datacube_benchmark.titiler.tiling_benchmark_summary
 
-::: datacube_benchmark.TiTilerCMRBenchmarker
+::: datacube_benchmark.titiler.TiTilerCMRBenchmarker
 
-::: datacube_benchmark.tiling.DatasetParams
+::: datacube_benchmark.titiler.DatasetParams
 
-::: datacube_benchmark.tiling.get_surrounding_tiles
+::: datacube_benchmark.titiler.get_surrounding_tiles
 
-::: datacube_benchmark.tiling.fetch_tile
+::: datacube_benchmark.titiler.fetch_tile
 
-::: datacube_benchmark.tiling.get_tileset_tiles
+::: datacube_benchmark.titiler.get_tileset_tiles
 
-::: datacube_benchmark.tiling.create_bbox_feature
+::: datacube_benchmark.titiler.create_bbox_feature
diff --git a/docs/visualization/titiler/overview.md b/docs/visualization/titiler/overview.md
@@ -37,7 +37,7 @@ Both `titiler-multidim` and `titiler.eopf` are built on `titiler.xarray`, levera
 #### **titiler.core → titiler-cmr application**
 
 `titiler-cmr` is built directly on `titiler.core` rather than `titiler.xarray` due to the development timeline of the two projects. In the future, we anticipate
-`titiler-cmr` will depend on `titiler.xarray`, with progress tracked by [titiler-cmr issue #35](https://github.com/developmentseed/titiler-cmr/issues/35)
+`titiler-cmr` will depend on `titiler.xarray`, with progress tracked by [titiler-cmr issue #35](https://github.com/developmentseed/titiler-cmr/issues/35).
 
 ---
 
diff --git a/docs/visualization/titiler/titiler-cmr/titiler-cmr-benchmark.ipynb b/docs/visualization/titiler/titiler-cmr/titiler-cmr-benchmark.ipynb
@@ -21,15 +21,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "id": "18a0edb6-7220-4910-854d-3b07d4e4f417",
    "metadata": {},
    "outputs": [],
    "source": [
     "import asyncio\n",
     "import pandas as pd\n",
     "\n",
-    "from datacube_benchmark.titiler_cmr_benchmark import (\n",
+    "from datacube_benchmark.titiler import (\n",
     "    DatasetParams,\n",
     "    benchmark_viewport,\n",
     "    tiling_benchmark_summary,\n",
@@ -1791,9 +1791,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "datacube-titiler",
+   "display_name": ".venv",
    "language": "python",
-   "name": "datacube-titiler"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
diff --git a/docs/visualization/titiler/titiler-cmr/titiler-cmr-statistics-benchmark.ipynb b/docs/visualization/titiler/titiler-cmr/titiler-cmr-statistics-benchmark.ipynb
@@ -22,15 +22,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "18a0edb6-7220-4910-854d-3b07d4e4f417",
    "metadata": {},
    "outputs": [],
    "source": [
     "import pandas as pd\n",
     "import json\n",
     "\n",
-    "from datacube_benchmark.titiler_cmr_benchmark import (\n",
+    "from datacube_benchmark.titiler import (\n",
     "    DatasetParams,\n",
     "    benchmark_statistics,\n",
     "    create_bbox_feature,\n",
diff --git a/packages/datacube-benchmark/pyproject.toml b/packages/datacube-benchmark/pyproject.toml
@@ -10,10 +10,14 @@ requires-python = ">=3.12"
 dependencies = [
     "arro3-core>=0.5.1",
     "dask>=2025.5.1",
+    "geojson-pydantic>=2.0.0",
     "hdf5plugin>=5.1.0",
+    "httpx>=0.28.1",
+    "morecantile>=6.2.0",
     "numcodecs>=0.16.1",
     "obstore>=0.6.0",
     "pint>=0.24.4",
+    "psutil>=7.0.0",
     "pyarrow>=20.0.0",
     "rich>=14.0.0",
     "s3fs>=0.4.2",
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/__init__.py b/packages/datacube-benchmark/src/datacube_benchmark/__init__.py
@@ -8,13 +8,6 @@
 from .config import Config
 from .query import benchmark_zarr_array, benchmark_access_patterns
 from .open import benchmark_dataset_open
-from .titiler_cmr_benchmark import (
-    benchmark_viewport,
-    benchmark_tileset,
-    benchmark_statistics,
-    tiling_benchmark_summary,
-    TiTilerCMRBenchmarker,
-)
 
 import numpy as np
 
@@ -27,11 +20,6 @@
     "benchmark_zarr_array",
     "benchmark_access_patterns",
     "benchmark_dataset_open",
-    "TiTilerCMRBenchmarker",
-    "benchmark_viewport",
-    "benchmark_tileset",
-    "benchmark_statistics",
-    "tiling_benchmark_summary",
 ]
 
 
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/tiling/__init__.py b/packages/datacube-benchmark/src/datacube_benchmark/tiling/__init__.py
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/titiler/__init__.py b/packages/datacube-benchmark/src/datacube_benchmark/titiler/__init__.py
@@ -0,0 +1,29 @@
+from .utils import (
+    get_surrounding_tiles,
+    fetch_tile,
+    get_tileset_tiles,
+    create_bbox_feature,
+    BaseBenchmarker,
+)
+from .config import DatasetParams
+from .cmr.benchmark import (
+    benchmark_viewport,
+    benchmark_tileset,
+    benchmark_statistics,
+    tiling_benchmark_summary,
+    TiTilerCMRBenchmarker,
+)
+
+__all__ = [
+    "TiTilerCMRBenchmarker",
+    "benchmark_viewport",
+    "benchmark_tileset",
+    "benchmark_statistics",
+    "tiling_benchmark_summary",
+    "get_surrounding_tiles",
+    "get_tileset_tiles",
+    "fetch_tile",
+    "create_bbox_feature",
+    "DatasetParams",
+    "BaseBenchmarker",
+]
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/titiler/cmr/__init__.py b/packages/datacube-benchmark/src/datacube_benchmark/titiler/cmr/__init__.py
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/titiler/cmr/benchmark.py b/packages/datacube-benchmark/src/datacube_benchmark/titiler/cmr/benchmark.py
@@ -23,7 +23,7 @@
 import psutil
 from geojson_pydantic import Feature
 
-from datacube_benchmark.tiling import (
+from datacube_benchmark.titiler import (
     BaseBenchmarker,
     DatasetParams,
     create_bbox_feature,
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/titiler/config.py b/packages/datacube-benchmark/src/datacube_benchmark/titiler/config.py
diff --git a/packages/datacube-benchmark/src/datacube_benchmark/titiler/utils.py b/packages/datacube-benchmark/src/datacube_benchmark/titiler/utils.py
@@ -4,19 +4,6 @@
 benchmarking or rendering workflow. They are primarily exercised by
 TiTiler-CMR benchmarking code, but are also applicable to other contexts where
 tile math and asynchronous HTTP fetching are needed.
-
-See Also
---------
-get_surrounding_tiles : Compute (x, y) tile coordinates forming a rectangular
-    viewport centered on a given tile index at a specific zoom level.
-get_tileset_tiles : Enumerate all tiles for a complete zoom level within
-    geographic bounds.
-fetch_tile : Asynchronously fetch one or more tiles for a given (z, x, y) from
-    a set of TileJSON templates, returning status, latency, and size metadata.
-create_bbox_feature : Build a GeoJSON Feature representing a bounding box from
-    (minx, miny, maxx, maxy) coordinates.
-BaseBenchmarker : Base class with shared functionality for TiTiler benchmarking
-    (system info, HTTP client setup, and minimal result processing).
 """
 
 from __future__ import annotations
@@ -30,7 +17,7 @@
 import pandas as pd
 from geojson_pydantic import Feature, Polygon
 
-from .titiler_cmr_params import DatasetParams
+from .config import DatasetParams
 
 
 def get_surrounding_tiles(
diff --git a/uv.lock b/uv.lock
