update notebook

Author: philipc2

docs/user-guide/cross-sections.ipynb

@@ -7,29 +7,28 @@
    "source": [
     "# Cross-Sections\n",
     "\n",
+    "UXarray allows for cross‑sections to be performed along arbitrary great‑circle arcs (GCAs) and lines of constant latitude or longitude. This enables workflows such as vertical or temporal cross-section visualizations.\n",
     "\n",
-    "UXarray allows for cross-sections to be performed along arbitrary great-circle arcs (GCAs) and lines of constant latitude or longitude. This enables workflows such as vertical or temporal cross-section visualizations\n"
+    "The data variable is sampled along the cross‑section, and the result is an `xarray.DataArray` (no longer a `uxarray.UxDataArray`) since the output is detached from the original unstructured grid.\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "16db9f880115ac2b",
    "metadata": {},
-   "outputs": [],
    "source": [
     "import matplotlib.pyplot as plt\n",
     "import numpy as np\n",
     "\n",
     "import uxarray as ux"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "720c4a345d659fd3",
    "metadata": {},
-   "outputs": [],
    "source": [
     "def set_lon_lat_xticks(ax, cross_section, n_ticks=6):\n",
     "    \"\"\"Utility function to draw stacked lat/lon points along the sampled cross-section\"\"\"\n",
@@ -53,121 +52,135 @@
     "    plt.tight_layout()\n",
     "\n",
     "    return fig, ax"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "2a42a1aa9249a94f",
    "metadata": {},
-   "outputs": [],
    "source": [
     "grid_path = \"../../test/meshfiles/scrip/ne30pg2/grid.nc\"\n",
     "data_path = \"../../test/meshfiles/scrip/ne30pg2/data.nc\"\n",
     "\n",
     "uxds = ux.open_dataset(grid_path, data_path)\n",
     "uxds[\"RELHUM\"]"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
    "id": "637eaeb7670eea9b",
    "metadata": {},
-   "source": "## Arbitrary Great Circle Arc (GCA)"
+   "source": [
+    "## Arbitrary Great Circle Arc (GCA)\n",
+    "\n",
+    "A cross‑section can be performed between two **arbitrary** (lon,lat) points, which will form a geodesic arc."
+   ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "11d2b717ba274d79",
    "metadata": {},
-   "outputs": [],
    "source": [
     "start_point = (-45, -45)\n",
     "end_point = (45, 45)\n",
     "\n",
     "cross_section_gca = uxds[\"RELHUM\"].cross_section(\n",
     "    start=start_point, end=end_point, steps=100\n",
     ")"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "cf73e86a3ddd57d9",
    "metadata": {},
-   "outputs": [],
    "source": [
     "fig, ax = plt.subplots()\n",
     "cross_section_gca.plot(ax=ax)\n",
     "\n",
     "set_lon_lat_xticks(ax, cross_section_gca)\n",
     "ax.set_title(f\"Cross Section between {start_point} and {end_point}\")\n",
     "ax.invert_yaxis()"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
    "id": "c2f3ff22dc82d6ce",
    "metadata": {},
-   "source": "## Constant Latitude"
+   "source": [
+    "## Constant Latitude\n",
+    "\n",
+    "A constant‐latitude cross‐section samples data along a horizontal line at a fixed latitude.\n"
+   ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "5a7415fa56f86071",
    "metadata": {},
-   "outputs": [],
    "source": [
     "lat = 45\n",
     "cross_section_const_lat = uxds[\"RELHUM\"].cross_section(lat=lat, steps=100)"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "b8cfda1b537a059e",
    "metadata": {},
-   "outputs": [],
    "source": [
     "fig, ax = plt.subplots()\n",
     "cross_section_const_lat.plot(ax=ax)\n",
     "\n",
     "set_lon_lat_xticks(ax, cross_section_const_lat)\n",
     "ax.set_title(f\"Cross Section at {lat}° latitude.\")\n",
     "ax.invert_yaxis()"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
    "id": "b6ab076677f11637",
    "metadata": {},
-   "source": "## Constant Longitude"
+   "source": [
+    "## Constant Longitude\n",
+    "\n",
+    "A constant‐longitude cross‐section samples data along a vertical line at a fixed longitude"
+   ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "add5646acb68496e",
    "metadata": {},
-   "outputs": [],
    "source": [
     "lon = 0\n",
     "cross_section_const_lon = uxds[\"RELHUM\"].cross_section(lon=lon, steps=100)"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "id": "1999ff933ce37f4e",
    "metadata": {},
-   "outputs": [],
    "source": [
     "fig, ax = plt.subplots()\n",
     "cross_section_const_lon.plot(ax=ax)\n",
     "\n",
     "set_lon_lat_xticks(ax, cross_section_const_lon)\n",
     "ax.set_title(f\"Cross Section at {lon}° longitude.\")\n",
     "ax.invert_yaxis()"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   }
  ],
  "metadata": {