Merge remote-tracking branch 'origin/main' into rajeeja/yac_structured_mesh

Author: rajeeja

docs/api.rst

@@ -23,6 +23,19 @@ Top Level Functions
    open_mfdataset
    concat
 
+Tutorial
+--------
+
+.. autosummary::
+   :toctree: generated/
+
+   tutorial.available_datasets
+   tutorial.describe_dataset
+   tutorial.file_path
+   tutorial.file_paths
+   tutorial.open_grid
+   tutorial.open_dataset
+   tutorial.open_mfdataset
 
 Grid
 ----

docs/conf.py

@@ -17,6 +17,12 @@
 from sphinx.application import Sphinx
 from sphinx.util import logging
 
+PROJECT_ROOT = pathlib.Path(__file__).resolve().parents[1]
+os.environ.setdefault(
+    "UXARRAY_DATA_DIR",
+    str(PROJECT_ROOT / "test" / "meshfiles"),
+)
+
 import uxarray
 
 __all__ = (uxarray, matplotlib.pyplot)

docs/getting-started/quick-overview.ipynb

@@ -50,7 +50,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We will be using the `outCSne30.ug` grid file, which is encoded in the UGRID convention."
+    "We will be using the `outCSne30.ug` grid file, which is encoded in the UGRID convention. In the user guide, this file is loaded through `ux.tutorial.open_grid(\"outCSne30\")` for convenience, and its underlying path can be resolved with `ux.tutorial.file_path(\"outCSne30\", \"grid\")`."
    ]
   },
   {
@@ -64,11 +64,7 @@
    },
    "outputs": [],
    "source": [
-    "base_path = \"../../test/meshfiles/\"\n",
-    "grid_path = base_path + \"/ugrid/outCSne30/outCSne30.ug\"\n",
-    "\n",
-    "ugrid = ux.open_grid(grid_path)\n",
-    "ugrid"
+    "ugrid = ux.tutorial.open_grid(\"outCSne30\")"
    ]
   },
   {
@@ -766,7 +762,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -780,7 +776,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.14.4"
   }
  },
  "nbformat": 4,

docs/user-guide/area_calc.ipynb

@@ -49,10 +49,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "uxds = ux.open_dataset(\n",
-    "    \"../../test/meshfiles/ugrid/outCSne30/outCSne30.ug\",\n",
-    "    \"../../test/meshfiles/ugrid/outCSne30/outCSne30_vortex.nc\",\n",
-    ")"
+    "uxds = ux.tutorial.open_dataset(\"outCSne30-vortex\")"
    ]
   },
   {
@@ -202,10 +199,7 @@
    "outputs": [],
    "source": [
     "clon, clat = 114.54, -17.66\n",
-    "tcds = ux.open_dataset(\n",
-    "    \"../../test/meshfiles/ugrid/ne120_TCsubset/ne120_TCsubset.ug\",\n",
-    "    \"../../test/meshfiles/ugrid/ne120_TCsubset/ne120_TCsubset.nc\",\n",
-    ").squeeze()"
+    "tcds = ux.tutorial.open_dataset(\"ne120-tcsubset\").squeeze()"
    ]
   },
   {
@@ -296,7 +290,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -310,7 +304,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.14.3"
+   "version": "3.14.4"
   }
  },
  "nbformat": 4,