https://github.com/psyplot/psy-ugrid
A psyplot plugin for decoding unstructured grids following the UGRID conventions
https://github.com/psyplot/psy-ugrid
cf-conventions matplotlib psyplot ugrid unstructured-meshes
Last synced: 4 months ago
JSON representation
A psyplot plugin for decoding unstructured grids following the UGRID conventions
- Host: GitHub
- URL: https://github.com/psyplot/psy-ugrid
- Owner: psyplot
- Created: 2024-04-03T19:27:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-04T12:10:17.000Z (about 1 year ago)
- Last Synced: 2025-01-31T19:08:03.662Z (5 months ago)
- Topics: cf-conventions, matplotlib, psyplot, ugrid, unstructured-meshes
- Language: Python
- Homepage: https://psyplot.github.io/psy-ugrid
- Size: 2.74 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.rst
- License: LICENSES/CC-BY-4.0.txt
- Citation: CITATION.cff
Awesome Lists containing this project
README
# psy-ugrid
[](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/-/pipelines?page=1&scope=all&ref=main)
[](https://codebase.helmholtz.cloud/psyplot/psy-ugrid/-/graphs/main/charts)
[](https://codebase.helmholtz.cloud/psyplot/psy-ugrid)
[](https://pypi.python.org/pypi/psy-ugrid/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://www.python.org/dev/peps/pep-0008/)
[](http://mypy-lang.org/)
[](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 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