psy-ugrid

A psyplot plugin for decoding unstructured grids following the UGRID conventions

Installation

Install this package in a dedicated python environment via

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

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

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.

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.

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. If you have any questions on this, please have a look into the contributing guide or contact the maintainers of psy-ugrid.