Data

Tools

Indexes

Applications

Experiments

Open Source Science

xugrid

Xarray and unstructured grids

https://github.com/deltares/xugrid

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 13 committers (7.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary

Keywords from Contributors

hydrology earth-science geoscience hydrodynamics groundwater modflow interactive python-virtual-environment package-manager-tool package-management
Last synced: 6 months ago · JSON representation

Repository

Xarray and unstructured grids

Basic Info
Statistics
  • Stars: 86
  • Watchers: 6
  • Forks: 10
  • Open Issues: 62
  • Releases: 15
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme License Zenodo

README.rst 

Xugrid
======

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

**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.

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

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

Install via conda from the conda-forge channel:

.. code:: console

  conda install -c conda-forge xugrid

Or from the Python Package Index:

.. code:: console

  pip install xugrid

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

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

Owner

  • Name: Deltares
  • Login: Deltares
  • Kind: organization
  • Email: oss@deltares.nl
  • Location: Delft, The Netherlands

Deltares is an independent institute for applied research in the field of water and subsurface.

GitHub Events

Total
  • Create event: 36
  • Release event: 6
  • Issues event: 66
  • Watch event: 21
  • Delete event: 32
  • Issue comment event: 78
  • Push event: 155
  • Pull request review comment event: 19
  • Pull request review event: 32
  • Pull request event: 76
  • Fork event: 3
Last Year
  • Create event: 36
  • Release event: 6
  • Issues event: 66
  • Watch event: 21
  • Delete event: 32
  • Issue comment event: 78
  • Push event: 155
  • Pull request review comment event: 19
  • Pull request review event: 32
  • Pull request event: 76
  • Fork event: 3

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 798
  • Total Committers: 13
  • Avg Commits per committer: 61.385
  • Development Distribution Score (DDS): 0.34
Past Year
  • Commits: 199
  • Committers: 9
  • Avg Commits per committer: 22.111
  • Development Distribution Score (DDS): 0.563
Top Committers
Name Email Commits
Huite Bootsma h****a@g****m 527
Joeri van Engelen j****n@h****m 89
Hendrik Kok h****k@d****l 53
veenstrajelmer 6****r 45
Huite h****a@g****m 45
dependabot[bot] 4****] 17
Luit Jan Slooten L****n@d****l 11
GitHub n****y@g****m 4
Sam Vente s****3@p****e 2
Hofer-Julian 3****n 2
drf5n d****f@v****u 1
Martijn Visser m****r@g****m 1
Maarten van Ormondt m****t@d****l 1
Committer Domains (Top 20 + Academic)
deltares.nl: 3 vims.edu: 1 proton.me: 1 github.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 228
  • Total pull requests: 219
  • Average time to close issues: 4 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 23
  • Total pull request authors: 13
  • Average comments per issue: 1.11
  • Average comments per pull request: 0.34
  • Merged pull requests: 189
  • Bot issues: 0
  • Bot pull requests: 58
Past Year
  • Issues: 35
  • Pull requests: 84
  • Average time to close issues: 3 days
  • Average time to close pull requests: 1 day
  • Issue authors: 9
  • Pull request authors: 8
  • Average comments per issue: 1.11
  • Average comments per pull request: 0.26
  • Merged pull requests: 70
  • Bot issues: 0
  • Bot pull requests: 35
View more stats
Top Authors
Issue Authors
  • Huite (110)
  • veenstrajelmer (69)
  • JoerivanEngelen (22)
  • xldeltares (3)
  • hboisgon (3)
  • luitjansl (2)
  • Sonia-Heye (2)
  • HendrikKok (2)
  • savente93 (1)
  • markhegnauer (1)
  • vieirasaulo (1)
  • JMM385 (1)
  • marceloandrioni (1)
  • tessodk (1)
  • Hofer-Julian (1)
Pull Request Authors
  • Huite (87)
  • dependabot[bot] (36)
  • veenstrajelmer (30)
  • JoerivanEngelen (24)
  • github-actions[bot] (22)
  • HendrikKok (6)
  • luitjansl (3)
  • savente93 (2)
  • visr (2)
  • Hofer-Julian (2)
  • wpbonelli (2)
  • maartenvanormondt (2)
  • drf5n (1)
Top Labels
Issue Labels
bug (4) enhancement (1) documentation (1)
Pull Request Labels
dependencies (36) pixi (14) github_actions (9) enhancement (2) bug (2)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 6,981 last-month
  • Total dependent packages: 6
    (may contain duplicates)
  • Total dependent repositories: 4
    (may contain duplicates)
  • Total versions: 45
  • Total maintainers: 4
pypi.org: xugrid

Xarray extension for unstructured grids

  • Versions: 40
  • Dependent Packages: 5
  • Dependent Repositories: 3
  • Downloads: 6,981 Last month
Rankings
Dependent packages count: 1.6%
Downloads: 7.1%
Average: 8.1%
Dependent repos count: 8.9%
Stargazers count: 9.7%
Forks count: 13.3%
Maintainers (4)
Huite JoerivanEngelen visr mydeltares
Last synced: 7 months ago
conda-forge.org: xugrid

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 to extend this ease to unstructured grids.

  • Versions: 5
  • Dependent Packages: 1
  • Dependent Repositories: 1
Rankings
Dependent repos count: 24.4%
Dependent packages count: 29.0%
Average: 41.4%
Stargazers count: 49.7%
Forks count: 62.4%
Last synced: 7 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v1 composite
  • mamba-org/provision-with-micromamba main composite
  • peaceiris/actions-gh-pages v3 composite
  • pre-commit/action v2.0.3 composite
pyproject.toml pypi
  • numba *
  • numba_celltree *
  • numpy *
  • pandas *
  • pooch *
  • scipy *
  • xarray *
environment.yml conda
  • python 3.9.*
.github/workflows/requirements/environment.yml pypi
  • meshkernel *