Skip to content
Binary file modified docs/_static/examples/grids/cam_se.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/examples/grids/iso_grid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/examples/grids/lat_lon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/getting-started/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://projectpythia.org/unstructured-grid-viz-cookbook>`_
where additional documentation can be found.

Unstructured Grids
==================
Expand Down
4 changes: 3 additions & 1 deletion docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ Tutorials & Videos

Tutorials
---------
* `Project Pythia Unstructured Grid Visualization Cookbook <https://projectpythia.org/unstructured-grid-viz-cookbook>`_
* `Project Pythia Unstructured Grid Visualization Cookbook <https://projectpythia.org/unstructured-grid-viz-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 <https://www.youtube.com/watch?v=sOCMSLZrwQs>`_ - 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 <https://www.youtube.com/watch?v=qwqJeOO8m6A>`_ - A second YouTube video presentation by another one of the lead UXarray developers on UXarray at SciPy 2023.
9 changes: 6 additions & 3 deletions docs/user-guide/data-structures.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down Expand Up @@ -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",
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/grid-formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,13 +256,13 @@ Coordinates

<style>
.yes-cell {
background-color: green;
background-color: #6aa84f; /* Light green color */
Comment thread
Sevans711 marked this conversation as resolved.
color: white;
text-align: center;
}

.no-cell {
background-color: red;
background-color: #e06666; /* Light red color */
color: white;
text-align: center;
}
Expand Down Expand Up @@ -356,13 +356,13 @@ Connectivity

<style>
.yes-cell {
background-color: green;
background-color: #6aa84f; /* Light green color */
color: white;
text-align: center;
}

.no-cell {
background-color: red;
background-color: #e06666; /* Light red color */
color: white;
text-align: center;
}
Expand Down
4 changes: 2 additions & 2 deletions docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ These user guides provide detailed explanations of the core functionality in UXa
Core data structures for working with unstructured grid and data files

`Custom Grid Topology <user-guide/custom-grid.ipynb>`_
Create a Grid from custom Grid topology and convert existing Xarray data structures to UXarray.
Create a Grid from custom Grid topology and convert existing Xarray data structures to UXarray

`Loading Data using Dask <user-guide/parallel-load-ux-with-dask.ipynb>`_
Read data with chunking and/or in parallel
Expand All @@ -50,7 +50,7 @@ These user guides provide detailed explanations of the core functionality in UXa
Select specific regions of a grid

`Spatial Hashing <user-guide/spatial-hashing.ipynb>`_
Use spatial hashing to locate the faces a list of points reside in.
Use spatial hashing to locate the faces a list of points reside in

`Cross-Sections <user-guide/cross-sections.ipynb>`_
Select cross-sections of a grid
Expand Down