Metadata-Version: 2.1
Name: psy-ugrid
Version: 0.1.0
Summary: A psyplot plugin for decoding unstructured grids following the UGRID conventions
Author-email: "Philipp S. Sommer" <philipp.sommer@hereon.de>
Maintainer-email: "Philipp S. Sommer" <philipp.sommer@hereon.de>
License: LGPL-3.0-only
Project-URL: Homepage, https://codebase.helmholtz.cloud/psyplot/psy-ugrid
Project-URL: Documentation, https://psyplot.github.io/psy-ugrid/
Project-URL: Source, https://codebase.helmholtz.cloud/psyplot/psy-ugrid
Project-URL: Tracker, https://codebase.helmholtz.cloud/psyplot/psy-ugrid/issues/
Keywords: visualization,psyplot,ugrid,unstructured,dual mesh,native,cython
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSES/CC-BY-4.0.txt
License-File: LICENSES/CC0-1.0.txt
License-File: LICENSES/LGPL-3.0-only.txt
Requires-Dist: psyplot
Requires-Dist: scipy
Provides-Extra: testsite
Requires-Dist: tox; extra == "testsite"
Requires-Dist: isort==5.12.0; extra == "testsite"
Requires-Dist: black==23.1.0; extra == "testsite"
Requires-Dist: blackdoc==0.3.8; extra == "testsite"
Requires-Dist: flake8==6.0.0; extra == "testsite"
Requires-Dist: pre-commit; extra == "testsite"
Requires-Dist: mypy; extra == "testsite"
Requires-Dist: pytest-cov; extra == "testsite"
Requires-Dist: reuse; extra == "testsite"
Requires-Dist: cffconvert; extra == "testsite"
Requires-Dist: pytest-xdist; extra == "testsite"
Provides-Extra: docs
Requires-Dist: autodocsumm; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: hereon-netcdf-sphinxext; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: dask; extra == "docs"
Requires-Dist: netCDF4; extra == "docs"
Requires-Dist: psy-simple>=1.5.0; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Requires-Dist: pickleshare; extra == "docs"
Provides-Extra: dev
Requires-Dist: psy-ugrid[testsite]; extra == "dev"
Requires-Dist: psy-ugrid[docs]; extra == "dev"
Requires-Dist: PyYAML; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Requires-Dist: Cython; extra == "dev"

<!--
SPDX-FileCopyrightText: 2024 Helmholtz-Zentrum hereon GmbH

SPDX-License-Identifier: CC-BY-4.0
-->

# psy-ugrid

[![CI](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/badges/main/pipeline.svg)](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/-/pipelines?page=1&scope=all&ref=main)
[![Code coverage](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/badges/main/coverage.svg)](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/-/graphs/main/charts)
[![Latest Release](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/-/badges/release.svg)](https://codebase.helmholtz.cloud/psyplot/psy-ugrid)
[![PyPI version](https://img.shields.io/pypi/v/psy-ugrid.svg)](https://pypi.python.org/pypi/psy-ugrid/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![REUSE status](https://api.reuse.software/badge/codebase.helmholtz.cloud/psyplot/psy-ugrid)](https://api.reuse.software/info/codebase.helmholtz.cloud/psyplot/psy-ugrid)


A psyplot plugin for decoding unstructured grids following the UGRID conventions

## Installation

Install this package in a dedicated python environment via

```bash
python -m venv venv
source venv/bin/activate
pip install psy-ugrid
```

To use this in a development setup, clone the [source code][source code] from
gitlab, start the development server and make your changes::

```bash
git clone https://codebase.helmholtz.cloud/psyplot/psy-ugrid
cd psy-ugrid
python -m venv venv
source venv/bin/activate
make dev-install
```

More detailed installation instructions my be found in the [docs][docs].


[source code]: https://codebase.helmholtz.cloud/psyplot/psy-ugrid
[docs]: https://psyplot.github.io/psy-ugrid/installation.html

## Usage

Once installed, the `UGRIDDecoder` is automatically registered within the
`psyplot` framework. Once you open a UGRID-conform file, the `UGRIDDecoder`
will be automatically used for all variables in the netCDF-file that define a
`mesh`. You do not have to do anything extra.

A :ref:`demo` on how this package works can be found [in the docs][docs].


## Technical note

This package has been generated from the template
https://codebase.helmholtz.cloud/psyplot/psyplot-plugin-template.git.

See the template repository for instructions on how to update the skeleton for
this package.


## License information

Copyright © 2024 Helmholtz-Zentrum hereon GmbH



Code files in this repository are licensed under the
LGPL-3.0-only, if not stated otherwise
in the file.

Documentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.

Supplementary and configuration files in this repository are licensed
under CC0-1.0, if not stated otherwise
in the file.

Please check the header of the individual files for more detailed
information.



### License management

License management is handled with [``reuse``](https://reuse.readthedocs.io/).
If you have any questions on this, please have a look into the
[contributing guide][contributing] or contact the maintainers of
`psy-ugrid`.

[contributing]: https://psyplot.github.io/psy-ugrid/contributing.html
