Use geozarr-toolkit in examples (#29)

Author: maxrjones

.github/workflows/deploy_mkdocs.yaml

@@ -20,4 +20,4 @@ jobs:
           enable-cache: true
 
       - name: Deploy docs
-        run: uv run mkdocs gh-deploy --force --strict
+        run: uv run --extra docs mkdocs gh-deploy --force --strict

docs/examples/cog-to-zarr.ipynb

@@ -33,7 +33,7 @@
    "source": [
     "import json\n",
     "\n",
-    "from geozarr_examples import (\n",
+    "from geozarr_toolkit import (\n",
     "    MultiscalesConventionMetadata,\n",
     "    ProjConventionMetadata,\n",
     "    SpatialConventionMetadata,\n",
@@ -47,6 +47,17 @@
   {
    "cell_type": "code",
    "execution_count": 2,
+   "id": "4kg0z9ducs",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Set to True to write to S3, False to use a local store\n",
+    "USE_S3 = False"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
    "id": "bzg24fl312w",
    "metadata": {},
    "outputs": [
@@ -100,7 +111,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "build-attrs",
    "metadata": {},
    "outputs": [
@@ -285,12 +296,15 @@
    "source": [
     "### Step 3: Read and write to Zarr V3 with multiscales\n",
     "\n",
-    "We read the full-resolution image and each overview, writing them as separate child arrays in a remote Zarr V3 store on S3. Zarr v3's `ObjectStore` wraps an obstore `S3Store`, so the same obstore backend used to *read* the COG is used to *write* the Zarr."
+    "We read the full-resolution image and each overview, writing them as separate child arrays in a Zarr V3 store. Set `USE_S3` above to control the output destination:\n",
+    "\n",
+    "- **`USE_S3 = True`**: writes to a remote S3 bucket via obstore's `S3Store`\n",
+    "- **`USE_S3 = False`**: writes to a local directory via Zarr's `LocalStore`"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "rc2uzn39va",
    "metadata": {},
    "outputs": [
@@ -304,19 +318,24 @@
       "Level 3 (overview): shape=(3, 1373, 1373)\n",
       "Level 4 (overview): shape=(3, 687, 687)\n",
       "\n",
-      "Wrote Zarr V3 store to s3://us-west-2.opendata.source.coop/pangeo/geozarr-examples/TCI.zarr\n"
+      "Wrote Zarr V3 store to data/TCI.zarr\n"
      ]
     }
    ],
    "source": [
     "import zarr\n",
-    "from zarr.storage import ObjectStore\n",
+    "from zarr.storage import LocalStore, ObjectStore\n",
     "\n",
     "bucket = \"us-west-2.opendata.source.coop\"\n",
     "prefix = \"pangeo/geozarr-examples/TCI.zarr\"\n",
+    "local_path = \"data/TCI.zarr\"\n",
+    "\n",
+    "if USE_S3:\n",
+    "    output_store = S3Store(bucket, prefix=prefix, region=\"us-west-2\")\n",
+    "    zarr_store = ObjectStore(output_store)\n",
+    "else:\n",
+    "    zarr_store = LocalStore(local_path)\n",
     "\n",
-    "output_store = S3Store(bucket, prefix=prefix, region=\"us-west-2\")\n",
-    "zarr_store = ObjectStore(output_store)\n",
     "root: zarr.Group = zarr.open_group(zarr_store, mode=\"w\", zarr_format=3)\n",
     "\n",
     "# Set convention attributes on the group\n",
@@ -333,7 +352,8 @@
     "    root.create_array(str(i + 1), data=ov_array.data, chunks=(3, 512, 512))\n",
     "    print(f\"Level {i+1} (overview): shape={ov_array.data.shape}\")\n",
     "\n",
-    "print(f\"\\nWrote Zarr V3 store to s3://{bucket}/{prefix}\")"
+    "location = f\"s3://{bucket}/{prefix}\" if USE_S3 else local_path\n",
+    "print(f\"\\nWrote Zarr V3 store to {location}\")"
    ]
   },
   {
@@ -348,7 +368,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "rj1mowgsd3j",
    "metadata": {},
    "outputs": [
@@ -385,17 +405,22 @@
        "└── \u001b[1m4\u001b[0m (3, 687, 687) uint8\n"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "from geozarr_examples import detect_conventions, validate_group\n",
+    "from geozarr_toolkit import detect_conventions, validate_group\n",
+    "\n",
+    "# Reopen and validate\n",
+    "if USE_S3:\n",
+    "    read_store = S3Store(bucket, prefix=prefix, region=\"us-west-2\", skip_signature=True)\n",
+    "    zarr_store = ObjectStore(read_store)\n",
+    "else:\n",
+    "    zarr_store = LocalStore(local_path)\n",
     "\n",
-    "# Reopen from S3 and validate\n",
-    "read_store = S3Store(bucket, prefix=prefix, region=\"us-west-2\", skip_signature=True)\n",
-    "root = zarr.open_group(ObjectStore(read_store), mode=\"r\")\n",
+    "root = zarr.open_group(zarr_store, mode=\"r\")\n",
     "\n",
     "detected = detect_conventions(dict(root.attrs))\n",
     "print(f\"Detected conventions: {detected}\")\n",
@@ -432,9 +457,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "geozarr-examples (3.12.0)",
+   "display_name": "project",
    "language": "python",
-   "name": "python3"
+   "name": "project"
   },
   "language_info": {
    "codemirror_mode": {
@@ -446,7 +471,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.0"
+   "version": "3.14.0"
   }
  },
  "nbformat": 4,

docs/examples/composition.ipynb

@@ -23,7 +23,7 @@
    "source": [
     "import json\n",
     "\n",
-    "from geozarr_examples import (\n",
+    "from geozarr_toolkit import (\n",
     "    MultiscalesConventionMetadata,\n",
     "    ProjConventionMetadata,\n",
     "    SpatialConventionMetadata,\n",

docs/examples/inheritance.ipynb

@@ -42,14 +42,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 1,
    "id": "setup",
    "metadata": {},
    "outputs": [],
    "source": [
     "import json\n",
     "\n",
-    "from geozarr_examples import (\n",
+    "from geozarr_toolkit import (\n",
     "    ProjConventionMetadata,\n",
     "    SpatialConventionMetadata,\n",
     "    create_proj_attrs,\n",
@@ -72,7 +72,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 2,
    "id": "inheritance-code",
    "metadata": {},
    "outputs": [
@@ -133,7 +133,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 3,
    "id": "h7q6hb5htp8",
    "metadata": {},
    "outputs": [
@@ -216,7 +216,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 4,
    "id": "override-code",
    "metadata": {},
    "outputs": [

docs/examples/proj-convention.ipynb

@@ -124,7 +124,7 @@
     }
    ],
    "source": [
-    "from geozarr_examples import create_proj_attrs\n",
+    "from geozarr_toolkit import create_proj_attrs\n",
     "\n",
     "# Our Sentinel-2 scene uses UTM zone 12N\n",
     "attrs = create_proj_attrs(code=\"EPSG:32612\")\n",
@@ -439,7 +439,7 @@
     }
    ],
    "source": [
-    "from geozarr_examples import ProjConventionMetadata, create_zarr_conventions\n",
+    "from geozarr_toolkit import ProjConventionMetadata, create_zarr_conventions\n",
     "\n",
     "conventions = create_zarr_conventions(ProjConventionMetadata())\n",
     "print(json.dumps(conventions, indent=2))"
@@ -537,7 +537,7 @@
     }
    ],
    "source": [
-    "from geozarr_examples import validate_proj\n",
+    "from geozarr_toolkit import validate_proj\n",
     "\n",
     "# Valid: our Sentinel-2 scene's CRS\n",
     "is_valid, errors = validate_proj({\"proj:code\": \"EPSG:32612\"})\n",

pyproject.toml

@@ -8,43 +8,27 @@ authors = [
 requires-python = ">=3.12"
 dependencies = [
     "async-geotiff",
-    "cartopy",
-    "cf-xarray",
-    "cftime",
-    "dask",
-    "earthaccess",
     "geozarr-toolkit",
-    "geoviews",
-    "hvplot",
     "jupyter",
+    "obstore",
+    "pyproj>=3.7.0",
+    "rich>=14.3.3",
+    "zarr>=3.0.8",
+]
+license = {text = "MIT License"}
+keywords = ["Python", "geospatial", "zarr", "geozarr", "conventions"]
+
+[project.optional-dependencies]
+docs = [
     "markdown-exec[ansi]>=1.7.0",
-    "matplotlib",
     "mkdocs>=1.5.0",
     "mkdocs-jupyter>=0.24.0",
     "mkdocs-material>=9.0.0",
     "mkdocstrings[python]>=0.24.0",
-    "netcdf4",
-    "obstore",
-    "panel",
-    "pooch>=1.8.2",
-    "pydantic>=2.12",
-    "pydantic-zarr>=0.8.0",
-    "pyproj>=3.7.0",
-    "pystac-client",
-    "rasterio>=1.4.3",
-    "rich",
-    "rio-cogeo",
-    "rio-tiler",
-    "rioxarray",
+]
+dev = [
     "ruff",
-    "structlog>=25.5.0",
-    "typing-extensions>=4.15.0",
-    "xarray",
-    "xproj",
-    "zarr>=3.0.8",
 ]
-license = {text = "MIT License"}
-keywords = ["Python", "geospatial", "zarr", "geozarr", "conventions"]
 
 [tool.ruff]
 line-length = 100
@@ -82,44 +66,3 @@ ignore = [
     "ANN001",  # Missing type annotation for function argument
     "ANN401",  # Dynamically typed Any
 ]
-
-[tool.mypy]
-python_version = "3.11"
-warn_return_any = true
-warn_unused_configs = true
-disallow_untyped_defs = true
-disallow_incomplete_defs = true
-check_untyped_defs = true
-no_implicit_optional = true
-warn_redundant_casts = true
-warn_unused_ignores = true
-strict_equality = true
-
-[[tool.mypy.overrides]]
-module = ["zarr.*", "xarray.*", "rioxarray.*", "cf_xarray.*", "dask.*", "pyproj.*"]
-ignore_missing_imports = true
-
-[tool.pytest.ini_options]
-minversion = "7.0"
-addopts = "-ra -q --strict-markers --strict-config"
-testpaths = ["tests"]
-markers = [
-    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
-    "integration: marks tests as integration tests",
-    "network: marks tests that require network access",
-]
-
-[tool.coverage.run]
-source = ["src"]
-omit = ["tests/*"]
-
-[tool.coverage.report]
-exclude_lines = [
-    "pragma: no cover",
-    "def __repr__",
-    "raise AssertionError",
-    "raise NotImplementedError",
-    "if __name__ == .__main__.:",
-    "class .*\\bProtocol\\):",
-    "@(abc\\.)?abstractmethod",
-]