Fix 5 broken user guide notebooks

- 2_Proximity: cast bool line aggregate to int for proximity()
- 11_Hydrology: fix undefined variable mfd -> mfd_fracs
- 15_Balanced_Allocation: ensure ListedColormap has >= 2 entries
- 27_Stream_Analysis: pass template DataArray to generate_terrain()
- 28_Rasterize: use legend_kwds 'label' instead of removed 'title'

Author: brendancol

examples/user_guide/11_Hydrology.ipynb

@@ -470,7 +470,7 @@
   {
    "cell_type": "code",
    "id": "btr592uiuve",
-   "source": "flow_accum_mfd = xrspatial.flow_accumulation_mfd(mfd)\n\nfig, axes = plt.subplots(1, 2, figsize=(14, 5))\n\n# D8 accumulation (log scale)\nim0 = axes[0].imshow(np.log1p(flow_accum.values), cmap='Blues')\naxes[0].set_title('D8 flow accumulation (log)')\nfig.colorbar(im0, ax=axes[0], shrink=0.6)\n\n# MFD accumulation (log scale)\nim1 = axes[1].imshow(np.log1p(flow_accum_mfd.values), cmap='Blues')\naxes[1].set_title('MFD flow accumulation (log)')\nfig.colorbar(im1, ax=axes[1], shrink=0.6)\n\nplt.tight_layout()\nplt.show()",
+   "source": "flow_accum_mfd = xrspatial.flow_accumulation_mfd(mfd_fracs)\n\nfig, axes = plt.subplots(1, 2, figsize=(14, 5))\n\n# D8 accumulation (log scale)\nim0 = axes[0].imshow(np.log1p(flow_accum.values), cmap='Blues')\naxes[0].set_title('D8 flow accumulation (log)')\nfig.colorbar(im0, ax=axes[0], shrink=0.6)\n\n# MFD accumulation (log scale)\nim1 = axes[1].imshow(np.log1p(flow_accum_mfd.values), cmap='Blues')\naxes[1].set_title('MFD flow accumulation (log)')\nfig.colorbar(im1, ax=axes[1], shrink=0.6)\n\nplt.tight_layout()\nplt.show()",
    "metadata": {},
    "execution_count": null,
    "outputs": []

examples/user_guide/15_Balanced_Allocation.ipynb

@@ -48,50 +48,7 @@
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "def make_raster(data, res=1.0):\n",
-    "    \"\"\"Helper: create a DataArray with y/x coordinates.\"\"\"\n",
-    "    h, w = data.shape\n",
-    "    raster = xr.DataArray(\n",
-    "        data.astype(np.float64),\n",
-    "        dims=['y', 'x'],\n",
-    "        attrs={'res': (res, res)},\n",
-    "    )\n",
-    "    raster['y'] = np.arange(h) * res\n",
-    "    raster['x'] = np.arange(w) * res\n",
-    "    return raster\n",
-    "\n",
-    "\n",
-    "def plot_territories(alloc_arr, title, source_locs=None, ax=None):\n",
-    "    \"\"\"Plot a territory allocation with distinct colours per source.\"\"\"\n",
-    "    if ax is None:\n",
-    "        fig, ax = plt.subplots(figsize=(6, 5))\n",
-    "    data = alloc_arr.values if hasattr(alloc_arr, 'values') else alloc_arr\n",
-    "    ids = np.unique(data[np.isfinite(data)])\n",
-    "    colors = plt.cm.Set2(np.linspace(0, 1, max(len(ids), 3)))\n",
-    "    cmap = ListedColormap(colors[:len(ids)])\n",
-    "    im = ax.imshow(data, cmap=cmap, origin='upper', interpolation='nearest')\n",
-    "    ax.set_title(title)\n",
-    "    if source_locs is not None:\n",
-    "        for r, c in source_locs:\n",
-    "            ax.plot(c, r, 'k*', markersize=12)\n",
-    "    plt.colorbar(im, ax=ax, shrink=0.8)\n",
-    "    return ax\n",
-    "\n",
-    "\n",
-    "def territory_stats(alloc_arr, friction_arr):\n",
-    "    \"\"\"Print cell count and cost-weighted area per territory.\"\"\"\n",
-    "    alloc = alloc_arr.values if hasattr(alloc_arr, 'values') else alloc_arr\n",
-    "    fric = friction_arr.values if hasattr(friction_arr, 'values') else friction_arr\n",
-    "    ids = sorted(np.unique(alloc[np.isfinite(alloc)]))\n",
-    "    print(f\"{'Source':>8}  {'Cells':>6}  {'Cost-weighted area':>18}\")\n",
-    "    print('-' * 38)\n",
-    "    for sid in ids:\n",
-    "        mask = alloc == sid\n",
-    "        n = int(np.sum(mask))\n",
-    "        w = float(np.sum(fric[mask]))\n",
-    "        print(f\"{sid:>8.0f}  {n:>6d}  {w:>18.1f}\")"
-   ]
+   "source": "def make_raster(data, res=1.0):\n    \"\"\"Helper: create a DataArray with y/x coordinates.\"\"\"\n    h, w = data.shape\n    raster = xr.DataArray(\n        data.astype(np.float64),\n        dims=['y', 'x'],\n        attrs={'res': (res, res)},\n    )\n    raster['y'] = np.arange(h) * res\n    raster['x'] = np.arange(w) * res\n    return raster\n\n\ndef plot_territories(alloc_arr, title, source_locs=None, ax=None):\n    \"\"\"Plot a territory allocation with distinct colours per source.\"\"\"\n    if ax is None:\n        fig, ax = plt.subplots(figsize=(6, 5))\n    data = alloc_arr.values if hasattr(alloc_arr, 'values') else alloc_arr\n    ids = np.unique(data[np.isfinite(data)])\n    colors = plt.cm.Set2(np.linspace(0, 1, max(len(ids), 3)))\n    cmap = ListedColormap(colors[:max(len(ids), 2)])\n    im = ax.imshow(data, cmap=cmap, origin='upper', interpolation='nearest')\n    ax.set_title(title)\n    if source_locs is not None:\n        for r, c in source_locs:\n            ax.plot(c, r, 'k*', markersize=12)\n    plt.colorbar(im, ax=ax, shrink=0.8)\n    return ax\n\n\ndef territory_stats(alloc_arr, friction_arr):\n    \"\"\"Print cell count and cost-weighted area per territory.\"\"\"\n    alloc = alloc_arr.values if hasattr(alloc_arr, 'values') else alloc_arr\n    fric = friction_arr.values if hasattr(friction_arr, 'values') else friction_arr\n    ids = sorted(np.unique(alloc[np.isfinite(alloc)]))\n    print(f\"{'Source':>8}  {'Cells':>6}  {'Cost-weighted area':>18}\")\n    print('-' * 38)\n    for sid in ids:\n        mask = alloc == sid\n        n = int(np.sum(mask))\n        w = float(np.sum(fric[mask]))\n        print(f\"{sid:>8.0f}  {n:>6d}  {w:>18.1f}\")"
   },
   {
    "cell_type": "markdown",
@@ -370,4 +327,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

examples/user_guide/27_Stream_Analysis_Dinf_MFD.ipynb

@@ -45,21 +45,7 @@
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "W, H = 400, 400\n",
-    "cvs_x = np.linspace(0, 1000, W)\n",
-    "cvs_y = np.linspace(0, 1000, H)\n",
-    "\n",
-    "terrain = generate_terrain(x_range=(0, 1000), y_range=(0, 1000),\n",
-    "                           width=W, height=H)\n",
-    "\n",
-    "fig, ax = plt.subplots(figsize=(6, 5))\n",
-    "terrain.plot(ax=ax, cmap='terrain')\n",
-    "ax.set_title('Synthetic elevation')\n",
-    "ax.set_aspect('equal')\n",
-    "plt.tight_layout()\n",
-    "plt.show()"
-   ]
+   "source": "W, H = 400, 400\n\ntemplate = xr.DataArray(np.zeros((H, W)), dims=['y', 'x'],\n                        coords={'y': np.linspace(0, 1000, H),\n                                'x': np.linspace(0, 1000, W)})\n\nterrain = generate_terrain(template, x_range=(0, 1000), y_range=(0, 1000))\n\nfig, ax = plt.subplots(figsize=(6, 5))\nterrain.plot(ax=ax, cmap='terrain')\nax.set_title('Synthetic elevation')\nax.set_aspect('equal')\nplt.tight_layout()\nplt.show()"
   },
   {
    "cell_type": "markdown",
@@ -246,4 +232,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

examples/user_guide/28_Rasterize.ipynb

@@ -177,13 +177,7 @@
     }
    },
    "outputs": [],
-   "source": [
-    "line_agg = cvs.line(df, x='x', y='y')\n",
-    "line_shaded = dynspread(shade(line_agg, cmap=['salmon',  'salmon']),\n",
-    "                          threshold=1,\n",
-    "                          max_px=2)\n",
-    "set_background(line_shaded, 'black')"
-   ]
+   "source": "line_agg = cvs.line(df, x='x', y='y')\nline_agg = line_agg.astype(int)\nline_shaded = dynspread(shade(line_agg, cmap=['salmon',  'salmon']),\n                          threshold=1,\n                          max_px=2)\nset_background(line_shaded, 'black')"
   },
   {
    "cell_type": "markdown",