diff --git a/docs/_static/examples/grids/cam_se.png b/docs/_static/examples/grids/cam_se.png index d21a77945..8d1d64ce5 100644 Binary files a/docs/_static/examples/grids/cam_se.png and b/docs/_static/examples/grids/cam_se.png differ diff --git a/docs/_static/examples/grids/iso_grid.png b/docs/_static/examples/grids/iso_grid.png new file mode 100644 index 000000000..eefc75e9f Binary files /dev/null and b/docs/_static/examples/grids/iso_grid.png differ diff --git a/docs/_static/examples/grids/lat_lon.png b/docs/_static/examples/grids/lat_lon.png index 7afe1dc64..9fff493af 100644 Binary files a/docs/_static/examples/grids/lat_lon.png and b/docs/_static/examples/grids/lat_lon.png differ diff --git a/docs/getting-started/overview.rst b/docs/getting-started/overview.rst index 5f1e8ef56..e52e084cb 100644 --- a/docs/getting-started/overview.rst +++ b/docs/getting-started/overview.rst @@ -13,6 +13,10 @@ used formats such as UGRID, SCRIP, and Exodus. Furthermore, UXarray provides bas for generating unstructured grid topology from structured grid or point-cloud inputs to enable model intercomparison workflows. +.. note:: + For new users interested in learning from our documented coding examples, notebooks, geospatial + lessons, and more, check out `Project Pythia `_ + where additional documentation can be found. Unstructured Grids ================== diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 9424e8af9..2c99123ce 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -7,4 +7,6 @@ Tutorials & Videos Tutorials --------- -* `Project Pythia Unstructured Grid Visualization Cookbook `_ +* `Project Pythia Unstructured Grid Visualization Cookbook `_ - A series of guides in the form of Jupyter notebooks. Shows code, examples, visualizations for various uses of ``uxarray``. +* `UXarray Tutorial at ESDS 2024 `_ - A YouTube video presentation by one of the lead UXarray developers on the motivation of UXarray, its origins, and uses. +* `UXarray Presentation at SciPy 2023 `_ - A second YouTube video presentation by another one of the lead UXarray developers on UXarray at SciPy 2023. diff --git a/docs/user-guide/data-structures.ipynb b/docs/user-guide/data-structures.ipynb index 15c069008..d3e67815b 100644 --- a/docs/user-guide/data-structures.ipynb +++ b/docs/user-guide/data-structures.ipynb @@ -24,8 +24,8 @@ "The core functionality of UXarray revolves around three data structures, which are used for interacting with unstructured grids and the data variables that reside on them.\n", "\n", "1. **[`uxarray.Grid`](https://uxarray.readthedocs.io/en/latest/generated/uxarray.UxDataArray.html)**: Stores the grid representation (i.e. coordinates, connectivity information, etc.)\n", - "2. **[`uxarray.UxDataset`](https://uxarray.readthedocs.io/en/latest/api.html#uxdataset)**: One or more data variable that resided on a grid.\n", - "3. **[`uxarray.UxDataArray`](https://uxarray.readthedocs.io/en/latest/api.html#uxdataarray)**: A single data variable that resides on a grid\n" + "2. **[`uxarray.UxDataset`](https://uxarray.readthedocs.io/en/latest/api.html#uxdataset)**: One or more data variables that reside on a grid. Each variable is stored in a UxDataArray.\n", + "3. **[`uxarray.UxDataArray`](https://uxarray.readthedocs.io/en/latest/api.html#uxdataarray)**: A single data variable that resides on a grid.\n" ] }, { @@ -486,7 +486,10 @@ } }, "outputs": [], - "source": "uxds = ux.open_dataset(grid_path, data_path)\nuxds" + "source": [ + "uxds = ux.open_dataset(grid_path, data_path)\n", + "uxds" + ] }, { "cell_type": "markdown", diff --git a/docs/user-guide/grid-formats.rst b/docs/user-guide/grid-formats.rst index c4d0ebf58..2899961a8 100644 --- a/docs/user-guide/grid-formats.rst +++ b/docs/user-guide/grid-formats.rst @@ -256,13 +256,13 @@ Coordinates