Deltares / xugrid

Xarray and unstructured grids

Xugrid

This is a work in progress. See documentation.

Xarray extension to work with 2D unstructured grids, for data and topology stored according to UGRID conventions.

Processing structured data with xarray is convenient and efficient. The goal of Xugrid is to extend this ease to unstructured grids.

import matplotlib.pyplot as plt
import xugrid

# Get some sample data as a xugrid UgridDataArray
uda = xugrid.data.elevation_nl()

# Get a cross-section
section_y = 475_000.0
section = uda.ugrid.sel(y=section_y)

# Plot unstructured grid and cross section
fig, (ax0, ax1) = plt.subplots(figsize=(22.6, 10), ncols=2)
uda.ugrid.plot(ax=ax0, vmin=-20, vmax=90, cmap="terrain")
ax0.axhline(y=section_y, color="red")
section.plot(ax=ax1, x="mesh2d_face_x")

Installation

Install via conda from the conda-forge channel:

conda install -c conda-forge xugrid

Or from the Python Package Index:

pip install xugrid

Documentation