Xarray-styled package for reading and directly operating on unstructured grid datasets following UGRID conventions
Project description
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, FESOM2, 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
Gridclass for storing grid information and providing grid-specific functionality- Support for reading UGRID, MPAS, ESMF, ICON, GEOS-CS, SCRIP, and EXODUS grid formats
- Support for reader structured (i.e. latitude longitude) grids
- Extension of xarray's
DataArrayandDatasetclasse to support unstructured grid operationsuxarray.UxDataArrayinheritsxarray.DataArrayand is attached to aGridinstance through the.uxgridaccessoruxarray.UxDatasetinheritsxarray.Datasetand is attached to aGridinstance through the.uxgridaccessor
- Extension of xarray's
open_datasetandopen_mfdatasetmethods to support reading grid and data files - Plotting
- Native visualization of unstructured grids written using the
hvPlotpackage - Support for grid topology visualization (i.e. exploring the geometry of a grid) and data visualization (i.e. data mapped to each face)
- Native visualization of unstructured grids written using the
- 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 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
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. |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file uxarray-2024.11.1.tar.gz.
File metadata
- Download URL: uxarray-2024.11.1.tar.gz
- Upload date:
- Size: 137.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1eb410ca4cbaef1e51b9aa3b91a79c2efc72657adf2637a9c89b70960cd00992 |
|
| MD5 | 47ca976b0778e6ee7b21d0c7af03933b |
|
| BLAKE2b-256 | 970ac52454de5e7782ceeea6d9e940e7385f6a2ab2d7e0c99cde480ee63081ad |
Provenance
The following attestation bundles were made for uxarray-2024.11.1.tar.gz:
Publisher:
pypi.yaml on UXARRAY/uxarray
-
Statement type:
https://in-toto.io/Statement/v1- Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
uxarray-2024.11.1.tar.gz - Subject digest:
1eb410ca4cbaef1e51b9aa3b91a79c2efc72657adf2637a9c89b70960cd00992 - Sigstore transparency entry: 150459992
- Sigstore integration time:
- Predicate type:
File details
Details for the file uxarray-2024.11.1-py3-none-any.whl.
File metadata
- Download URL: uxarray-2024.11.1-py3-none-any.whl
- Upload date:
- Size: 153.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6412a658c098b44e2df601ddc7c6820b089fd67c0bd04844dbf3d6ba3e6c285d |
|
| MD5 | 1b5cda1b2920fe877b09dbfc68bdd345 |
|
| BLAKE2b-256 | b0fe7b87d7b7bcb18fcadd677a554c0b9326532a184e6b02cc6f18b6734954b5 |
Provenance
The following attestation bundles were made for uxarray-2024.11.1-py3-none-any.whl:
Publisher:
pypi.yaml on UXARRAY/uxarray
-
Statement type:
https://in-toto.io/Statement/v1- Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
uxarray-2024.11.1-py3-none-any.whl - Subject digest:
6412a658c098b44e2df601ddc7c6820b089fd67c0bd04844dbf3d6ba3e6c285d - Sigstore transparency entry: 150459994
- Sigstore integration time:
- Predicate type:
