uxarray 0.0.1

Uxarray looks to implement xarray capabilities with ugrid conventions to facilitate data visualization with unstructured grids

CI
Docs
Package
License

Uxarray aims to address the geoscience community need for utilities that can handle 2D and 3D unstructured grid datasets. These utility functions were inspired by discussion on the Xarray GitHub Repository. Uxarray will provide Xarray styled funtions to better read in and use unstructured grid datasets that follow UGRID conventions. This effort is a result of the collaboration between Project Raijin (NCAR and Pennsylvania State University) and SEATS Project (Argonne National Laboratory, UC Davis, and Lawrence Livermore National Laboratory).

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.

Documentation

Uxarray Documentation

Project Raijin Homepage

SEATS Project Homepage

Project Raijin Contributor's Guide

SEATs Project Contributor's Guide

Installation and build instructions

Please see our documentation for installation and build instructions.

Citing Uxarray

Cite Uxarray using the following text:

UXARRAY Organization. (Year). Uxarray (Uxarray version <version>) [Software]. Project Raijin & Project SEATS. https://uxarray.readthedocs.io/en/latest/.

Update the Uxarray version and year as appropriate. For example:

UXARRAY Organization. (2021). Uxarray (version 0.0.1) [Software]. Project Raijin & Project SEATS. https://uxarray.readthedocs.io/en/latest/.

For further information, please refer to Project Raijin homepage - Citation.