Xugrid#

https://img.shields.io/github/actions/workflow/status/deltares/xugrid/ci.yml?style=flat-square https://img.shields.io/codecov/c/github/deltares/xugrid.svg?style=flat-square https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square

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")
_images/xugrid-demo.png

Installation#

pip install xugrid

Documentation#

Getting Started

Learn xugrid fundamentals: loading data, basic operations, and plotting unstructured grids.

User Guide
How-To Guides

Step-by-step instructions for common tasks: regridding, Dask integration, format conversion.

How-To Guides
API Reference

Complete documentation of all functions, classes, and methods.

API Reference
Developer Guide

Contributing guidelines and development setup.

Development