User Guide#
The User Guide is the primary resource documenting key concepts and functionality within UXarray. For newcomers, a gentle introduction to UXarray can be found in the Getting Started guide and examples of UXarray in action can be found in our Gallery
Introductory Guides#
These user guides provide the necessary background information for understanding concepts in UXarray.
- Terminology
Core concepts and terminology for working with unstructured grids
- Conventions
Overview of the UGRID conventions and how they are used within UXarray
- Supported Models & Grid Formats
Overview of supported models and grid formats
Core Guides#
These user guides provide detailed explanations of the core functionality in UXarray.
- Data Structures
Core data structures for working with unstructured grid and data files
- Custom Grid Topology
Create a Grid from custom Grid topology and convert existing Xarray data structures to UXarray.
- Loading Data using Dask
Read data with chunking and/or in parallel
- Plotting
Visualize unstructured grid datasets using UXarray’s plotting API
- Plotting with Matplotlib
Use Matplotlib for plotting with PolyCollection and LineCollection
- Advanced Plotting Techniques
Deeper dive into getting the most out of UXarray’s plotting functionality
- Subsetting
Select specific regions of a grid
- Spatial Hashing
Use spatial hashing to locate the faces a list of points reside in.
- Cross-Sections
Select cross-sections of a grid
- Zonal Means
Compute the zonal averages across lines of constant latitude
- Remapping
Remap (a.k.a Regrid) between unstructured grids
- Topological Aggregations
Aggregate data across grid dimensions
- Weighted Mean
Compute the weighted average
- Calculus Operators
Apply calculus operators (gradient, integral) on unstructured grid data
- Tree Structures
Data structures for nearest neighbor queries
- Face Area Calculations
Methods for computing the area of each face
- Structured Grids
Loading structured (latitude-longitude) grids
- Representing Point Data
Create grids from unstructured point data
- Dual Mesh Construction
Construct the Dual Mesh of an unstructured grid
Supplementary Guides#
These user guides provide additional details about specific features in UXarray.
- Working with HEALPix Grids
Use UXarray with HEALPix
- Compatibility with HoloViz Tools
Use UXarray with HoloViz tools
- Reading & Working with Geometry Files
Load and work with geometry files (i.e. Shapefile, GeoJSON)