Installation

To install the psy-ugrid package, we recommend that you install it from PyPi via:

pip install psy-ugrid

If you are familiar with building a package with Cython, you can also install it directly from the source code repository on Gitlab via:

USE_CYTHON=true pip install git+https://codebase.helmholtz.cloud/psyplot/psy-ugrid.git

The latter should however only be done if you want to access the development versions.

Installation for development

Please head over to our contributing guide for installation instruction for development.

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.

See the Demo section for a quick usage example and demonstration.