Xugrid
======

.. image:: https://img.shields.io/github/actions/workflow/status/deltares/xugrid/ci.yml?style=flat-square
   :target: https://github.com/deltares/xugrid/actions?query=workflows%3Aci
.. image:: https://img.shields.io/codecov/c/github/deltares/xugrid.svg?style=flat-square
   :target: https://app.codecov.io/gh/deltares/xugrid
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square
   :target: https://github.com/psf/black

Xarray extension to work with 2D unstructured grids, for data and topology
stored according to `UGRID conventions
<https://ugrid-conventions.github.io/ugrid-conventions>`_.

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

.. code:: python

   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")

.. image:: _static/xugrid-demo.png

Installation
------------

.. code:: console

   pip install xugrid

Documentation
-------------

.. grid:: 1 2 2 2
   :gutter: 3

   .. grid-item-card:: Getting Started
      :link: user_guide
      :link-type: doc

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

   .. grid-item-card:: How-To Guides
      :link: how-to/index
      :link-type: doc

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

   .. grid-item-card:: API Reference
      :link: api
      :link-type: doc

      Complete documentation of all functions, classes, and methods.

   .. grid-item-card:: Developer Guide
      :link: dev_docs
      :link-type: doc

      Contributing guidelines and development setup.

.. toctree::
   :titlesonly:
   :hidden:

   user_guide
   how-to/index
   api
   dev_docs