uxarray 2024.10.0

Xarray-styled package for reading and directly operating on unstructured grid datasets following UGRID conventions

---

Xarray extension for unstructured climate and global weather data

Build Status
Code Coverage
Docs
Benchmarks
Releases
License
Citing

---

What is it?

UXarray aims to address the geoscience community's need for tools that enable standard data analysis techniques to operate directly on unstructured grid data. UXarray provides Xarray-styled functionality to better read in and use unstructured grid datasets that follow standard conventions, including UGRID, MPAS, ICON, SCRIP, ESMF, and Exodus grid formats. This effort is a result of the collaboration between Project Raijin (NSF NCAR and Pennsylvania State University) and the SEATS Project (Argonne National Laboratory, UC Davis, and Lawrence Livermore National Laboratory). The UXarray team welcomes community members to become part of this collaboration at any level of contribution.

UXarray is implemented in pure Python and does not explicitly contain or require any compiled code. This makes UXarray more accessible to the general Python community. Any contributions to this repository in pure Python are welcome and documentation for contribution guidelines can be found when clicking New Issue under the Issues tab in the UXarray repository.

Why is the name "UXarray"?

We have created UXarray based on Xarray (via inheritance of Xarray Dataset and DataArray classes), a Pangeo ecosystem package commonly-used for structured grids recognition, to support reading and recognizing unstructured grid model outputs. We picked the name "UXarray" (pronounced "you-ex-array"), with the "U" representing unstructured grids.

Features

• Grid class for storing grid information and providing grid-specific functionality
  • Support for reading UGRID, MPAS, ESMF, ICON, GEOS-CS, SCRIP, and EXODUS grid formats
• Extension of xarray's DataArray and Dataset classe to support unstructured grid operations
  • uxarray.UxDataArray inherits xarray.DataArray and is attached to a Grid instance through the .uxgrid accessor
  • uxarray.UxDataset inherits xarray.Dataset and is attached to a Grid instance through the .uxgrid accessor
• Extension of xarray's open_dataset and open_mfdataset methods to support reading grid and data files
• Plotting
  • Native visualization of unstructured grids written using the hvPlot package
  • Support for grid topology visualization (i.e. exploring the geometry of a grid) and data visualization (i.e. data mapped to each face)
• Subsetting
  • Ability to select arbitrary regions of a grid using different selection methods (nearest neighbor, bounding circle, bounding box)
• Remapping
  • Support for nearest neighbor and inverse distance weighted unstructured to unstructured remapping
• Topological Aggregations
  • Perform aggregations within different topology elements using connectivity information
• Mathematical Operators
  • Support for Integral, Difference, and Gradient calculations

Intended Features

The following intended features have been inspired by discussions with members of the scientific community, within the SEATS Project and Project Raijin, and on several community platforms such as Xarray GitHub Repository. The UXarray team is receptive to additional functionality requests.

• Support for arbitrary structured and unstructured grids on the sphere, including latitude-longitude grids, grids with only partial coverage of the sphere, and grids with concave faces.
• Support for finite volume and finite element outputs.
• Triangular decompositions.
• Calculation of supermeshes (consisting of grid lines from two input grids).
• Snapshots and composites following particular features.

Documentation

UXarray Documentation

Contributor’s Guide

Installation

Project Raijin Homepage

SEATS Project Homepage

Contributors

Thank you to all of our contributors!

Citing UXarray

If you'd like to cite our work, please follow How to cite UXarray.

Support

Project Raijin, entitled "Collaborative Research: EarthCube Capabilities: Raijin: Community Geoscience Analysis Tools for Unstructured Mesh Data", was awarded by NSF 21-515 EarthCube (Award Number (FAIN): 2126458) on 08/19/2021. The award period of performance has a start date of 09/01/2021 and end date of 08/31/2024.

SEATS is funded by the Regional and Global Modeling and Analysis (RGMA) program area in the U.S. Department of Energy (DOE) Earth and Environmental System Modeling Program which is part of the Earth and Environmental Systems Sciences Division of the Office of Biological and Environmental Research in DOE’s Office of Science.

EarthCube aims to transform the conduct of geosciences research by developing and maintaining a well-connected and facile environment that improves access, sharing, visualization, and analysis of data and related resources.

Pangeo supports collaborative efforts to develop software and infrastructure to enable Big Data geoscience research.