Skip to main content

Xarray extension for unstructured grids

Project description

https://img.shields.io/github/actions/workflow/status/deltares/xugrid/ci.yml https://img.shields.io/codecov/c/github/deltares/xugrid.svg https://img.shields.io/badge/code%20style-black-000000.svg https://zenodo.org/badge/DOI/10.5281/zenodo.10534099.svg

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")
https://raw.githubusercontent.com/Deltares/xugrid/main/docs/_static/xugrid-demo.png

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

https://img.shields.io/github/actions/workflow/status/deltares/xugrid/ci.yml?style=flat-square

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xugrid-0.10.0.tar.gz (147.4 kB view hashes)

Uploaded Source

Built Distribution

xugrid-0.10.0-py3-none-any.whl (122.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page