UGrid 0.13.0

`UGrid` is a library to write and read UGrid files.

UGridPy

UGridPy is a library for writing/reading UGrid files. It supports writing 1D networks, 1D mesh, 2D meshes and 1D-2D contacts in UGrid Format. The underlying C++ library UGrid can be found here.

Installation

Windows

The library can be installed from PyPI by executing

pip install ugrid

Linux

Currently, we only offer wheels specific to Deltares' CentOS machines. We plan to release a manylinux wheel at PyPI in the future.

Examples

To be detailed

License

UGridPy uses the MIT license. However, the wheels on PyPI bundle the LGPL licensed UGrid. Please make sure that this fits your needs before depending on it.

Contributing

In order to install UGridPy locally, please execute the following line inside your virtual environment

pip install -e ".[tests, lint, docs]"

Then add a compiled UGridApi.dll into your src folder.

Also make sure that your editor is configured to format the code with black and isort.