| Name | xugrid JSON |
| Version |
0.12.1
JSON |
| download |
| home_page | None |
| Summary | Xarray extension for unstructured grids |
| upload_time | 2024-09-09 08:36:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
mesh
ugrid
unstructured grid
xarray
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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 <https://deltares.github.io/xugrid/>`_.
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:: 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/
Raw data
{
"_id": null,
"home_page": null,
"name": "xugrid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Huite Bootsma <huite.bootsma@deltares.nl>",
"keywords": "mesh, ugrid, unstructured grid, xarray",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b7/6c/ce0746881007f244d830db55979a29a2c57764ed8b585efa429241b5ef3a/xugrid-0.12.1.tar.gz",
"platform": null,
"description": "Xugrid\n======\n\n.. image:: https://img.shields.io/github/actions/workflow/status/deltares/xugrid/ci.yml\n :target: https://github.com/deltares/xugrid/actions?query=workflows%3Aci\n.. image:: https://img.shields.io/codecov/c/github/deltares/xugrid.svg\n :target: https://app.codecov.io/gh/deltares/xugrid\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10534099.svg\n :target: https://doi.org/10.5281/zenodo.10534099\n\n**This is a work in progress.** `See documentation <https://deltares.github.io/xugrid/>`_.\n\nXarray extension to work with 2D unstructured grids, for data and topology\nstored according to `UGRID conventions\n<https://ugrid-conventions.github.io/ugrid-conventions>`_.\n\nProcessing structured data with xarray is convenient and efficient. The goal of\nXugrid is to extend this ease to unstructured grids.\n\n.. code:: python\n\n import matplotlib.pyplot as plt\n import xugrid\n\n # Get some sample data as a xugrid UgridDataArray\n uda = xugrid.data.elevation_nl()\n\n # Get a cross-section\n section_y = 475_000.0\n section = uda.ugrid.sel(y=section_y)\n\n # Plot unstructured grid and cross section\n fig, (ax0, ax1) = plt.subplots(figsize=(22.6, 10), ncols=2)\n uda.ugrid.plot(ax=ax0, vmin=-20, vmax=90, cmap=\"terrain\")\n ax0.axhline(y=section_y, color=\"red\")\n section.plot(ax=ax1, x=\"mesh2d_face_x\")\n\n.. image:: https://raw.githubusercontent.com/Deltares/xugrid/main/docs/_static/xugrid-demo.png\n :target: https://github.com/deltares/xugrid\n\nInstallation\n------------\n\nInstall via conda from the conda-forge channel:\n\n.. code:: console\n\n conda install -c conda-forge xugrid\n\nOr from the Python Package Index:\n\n.. code:: console\n\n pip install xugrid\n\nDocumentation\n-------------\n\n.. image:: https://img.shields.io/github/actions/workflow/status/deltares/xugrid/ci.yml?style=flat-square\n :target: https://deltares.github.io/xugrid/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Xarray extension for unstructured grids",
"version": "0.12.1",
"project_urls": {
"Code": "https://github.com/deltares/xugrid",
"Home": "https://github.com/deltares/xugrid",
"Issues": "https://github.com/deltares/xugrid/issues"
},
"split_keywords": [
"mesh",
" ugrid",
" unstructured grid",
" xarray"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "409360ebc65badf7024630d887f6aa9bd4f334716167ac6ee03a085bf936a4a1",
"md5": "61433a0bfb022523e30acb3bfbd775cc",
"sha256": "356eaf68698f0149fc44b7de6c25815cde815fecd81590db86afb9f7db6d4bcc"
},
"downloads": -1,
"filename": "xugrid-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61433a0bfb022523e30acb3bfbd775cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 132534,
"upload_time": "2024-09-09T08:36:22",
"upload_time_iso_8601": "2024-09-09T08:36:22.890066Z",
"url": "https://files.pythonhosted.org/packages/40/93/60ebc65badf7024630d887f6aa9bd4f334716167ac6ee03a085bf936a4a1/xugrid-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b76cce0746881007f244d830db55979a29a2c57764ed8b585efa429241b5ef3a",
"md5": "86a5656a23d053b79ca83031f3714892",
"sha256": "50b05e42dc6842a2a474cea685b04fec5a0c92fed0337fa22d4666d5e44dfb10"
},
"downloads": -1,
"filename": "xugrid-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "86a5656a23d053b79ca83031f3714892",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 162214,
"upload_time": "2024-09-09T08:36:24",
"upload_time_iso_8601": "2024-09-09T08:36:24.665936Z",
"url": "https://files.pythonhosted.org/packages/b7/6c/ce0746881007f244d830db55979a29a2c57764ed8b585efa429241b5ef3a/xugrid-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 08:36:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deltares",
"github_project": "xugrid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xugrid"
}
