Skip to content

Commit

Permalink
Revise README, notebooks/01-intro/01 and notebooks/01-intro/02
Browse files Browse the repository at this point in the history
  • Loading branch information
erogluorhan committed Dec 2, 2023
1 parent f826fde commit 18c7ab3
Show file tree
Hide file tree
Showing 3 changed files with 148 additions and 92 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ This Cookbook is a comprehensive showcase of workflows & techniques for visualiz

## Structure

This cookbook is split up into three chapters that provide a comprehensive overview of how to use UXarray to work with and visualuze unstructured grid datasets.
This cookbook is split up into three chapters that provide a detailed overview of how to use UXarray to work with and visualuze unstructured grid datasets:

#### **1. Introduction to UXarray & Unstructured Grids**
**1. Introduction to UXarray & Unstructured Grids**

#### **2. Methods & Libraries for Unstructured Grid Visualization**
**2. Methods & Libraries for Unstructured Grid Visualization**

#### **3. UXarray Visualization**
**3. UXarray Visualization**

## Running the Notebooks

Expand Down
34 changes: 23 additions & 11 deletions notebooks/01-intro/01-unstructured-grid-overview.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The goal of this notebook is to provide a brief overview of unstructured grids and provide a teaser of plotting with the UXarray package.\n",
"The goal of this notebook is to provide a brief overview of unstructured grids and provide a teaser of plotting with the [UXarray](https://uxarray.readthedocs.io/) package.\n",
"\n",
"Contents:\n",
"1. Structured vs. Unstructured Grids\n",
"2. Structured Grids\n",
Expand Down Expand Up @@ -137,6 +138,13 @@
"## Unstructured Grids"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Characteristic features of unstructured grids are:"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -232,7 +240,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"NOTE: This is a very basic example of an unstructured grid with triangles. There are very specialized libraries to create unstructured grids. Often the region of interest is meshed with a finer resolution. The mesh is then coarsened in areas where the resolution is not needed. This is done to reduce the number of elements and improve computational efficiency."
":::{note}\n",
"This is a very basic example of an unstructured grid with triangles. There are very specialized libraries to create unstructured grids. Often the region of interest is meshed with a finer resolution. The mesh is then coarsened in areas where the resolution is not needed. This is done to reduce the number of elements and improve computational efficiency.\n",
":::"
]
},
{
Expand All @@ -241,26 +251,28 @@
"source": [
"## Why UXarray for Unstructured Grids?\n",
"\n",
"- It inherits from Xarray, providing simplified data using familiar (Xarray like) data structures and operations.\n",
" \n",
"- Bring standardization to unstructured mesh support for climate data analysis and visualization.\n",
"UXarray, which stands for \"Unstructured-Xarray\", is a Python package that provides Xarray-styled functionality for working with unstructured grids built around the UGRID conventions. UXarray can simplify working with unstructured grids because it:\n",
"\n",
"- Adherence to the UGRID specification for compatibility across a variety of mesh formats.\n",
"- Enables significant data analysis and visualization functionality to be executed dircetly on unstructured grids\n",
"\n",
"- Inherits from Xarray, providing simplified data using familiar (Xarray-like) data structures and operations\n",
" \n",
"- Brings standardization to unstructured mesh support for climate data analysis and visualization\n",
"\n",
"- Optimized data structures and algorithms for handling large and complex unstructured datasets. \n",
"- Adheres to the UGRID specification for compatibility across a variety of mesh formats\n",
"\n",
"- Enhanced Interoperability and Community Collaboration.\n",
"- Builds on optimized data structures and algorithms for handling large and complex unstructured datasets\n",
"\n",
"- One interface for a variety of unstructured grid formats.\n",
"- Supports enhanced interoperability and community collaboration\n",
"\n",
"There are unstructured grid format such as Exodus, SCRIP, MPAS, UGRID etc. UXarray is a library that can read and write many such unstructured grid formats. The specific focus of UXarray is to provide a common interface to access and operate on unstructured grids in the climate science community."
"- Provides a single interface for supporting a variety of unstructured grid formats including UGRID, MPAS, SCRIP, and Exodus"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
":::{info}\n",
":::{note}\n",
"This notebook serves as an introduction to unstructured grids and UXarray. For more information, please visit the UXarray documentation at https://uxarray.readthedocs.io/en/latest/ and specifically see the example section: https://uxarray.readthedocs.io/en/latest/examples.html\n",
":::"
]
Expand Down
Loading

0 comments on commit 18c7ab3

Please sign in to comment.