meshkernel 2.0.2

`meshkernel` is a library which can be used to manipulate meshes.

MeshKernelPy

MeshKernelPy is a library for creating and editing meshes. It supports 1D and 2D unstructured meshes. Support for curvilinear meshes is planned. The underlying C++ library MeshKernel can be found here.

Installation

Windows

The library can be installed from PyPI by executing

pip install meshkernel

If you encounter any issues importing the pip wheels on Windows, you may need to install the Visual C++ Redistributable for Visual Studio 2019.

Linux

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

Examples

Creating a triangular mesh inside a polygon

In this example a mesh is created by discretizing the polygon perimeter with the desired edge length.

Mesh orthogonalization

Finite volume staggered flow solvers require the mesh to be as much orthogonal as possible. MeshKernel provides an algorithm to adapt the mesh and achieve a good balance between mesh orthogonality and smoothness.

Mesh refinement

A mesh can be refined in areas based on samples or polygon selections.

License

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

Contributing

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

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

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

Also make sure that your editor is configured to format the code with black and isort. When modifying Jupyter notebooks, the jupyterlab-code-formatter can be used.

Building linux wheels

To deploy Linux wheels to PyPI, we provide a Docker image that is based on manylinux2014_x86_64. This image includes cmake and boost, which are necessary for compiling the native MeshKernel library (written in C++). To build the Docker image, please follow these steps:

cd scripts
docker build --progress=plain ./scripts -t build_linux_library
cd ..

Once the Docker image has been built, build the linux wheels using the following command:

docker run -v %cd%:/root --rm build_linux_library 

The deployable linux wheels will be located in dist/wheelhouse