Skip to main content

MeshKernelPy

PyPI version Quality Gate Status Coverage Downloads

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

Installation

The library can be installed from PyPI by executing

pip install meshkernel

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

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 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.

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 and installing the wheel

Platform-specific build

A setup script is provided for building the wheel. The script is known to work under Windows, Linux and macOS.

To install the dependencies, use

python -m pip install --upgrade pip
python -m pip install wheel numpy matplotlib pytest

The environment variable BACK_END_BRANCH must be set prior to building the wheel. It specifies which MeshKernel branch should be built during the generation of the wheel. If one is on the main branch of MeshKernelPy, BACK_END_BRANCH must be either set to master. If one is an a release branch, BACK_END_BRANCH should be set to release. The version of the MeshKernel release branch is hardcoded in meshkernel/version.py.

While in the project's root directory, to build the wheel use

python setup.py build_ext
python setup.py sdist bdist_wheel

To install use: The wheel is installed

python -m pip install <meshkernel_wheel_name>

where <meshkernel_wheel_name> is the name of the generated wheel.

To test, simply run pytest.

Manylinux Docker image

To deploy Linux wheels to PyPI, we provide a Docker image that is based on manylinux_2_28_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, use:

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

Once the Docker image has been built, build the manylinux wheel using the following command:

docker run -e BACK_END_BRANCH=<meshkernel_back_end_branch_name> -v $(pwd):/root --rm build_linux_library

where <meshkernel_back_end_branch_name> is either master or release, as described in Platform-specific build.

The deployable manylinux wheels will be located in dist/wheelhouse.

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.

Metadata

Release files for meshkernel 8.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for meshkernel 8.4.1
File Actions
meshkernel-8.4.1-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for meshkernel-8.4.1-py3-none-win_amd64.whl
meshkernel-8.4.1-py3-none-manylinux_2_28_x86_64.whl Python 3 none Linux glibc 2.28+ x86-64 Details for meshkernel-8.4.1-py3-none-manylinux_2_28_x86_64.whl
meshkernel-8.4.1-py3-none-macosx_26_0_arm64.whl Python 3 none macOS 26.0+ ARM64 Details for meshkernel-8.4.1-py3-none-macosx_26_0_arm64.whl
meshkernel-8.4.1-py3-none-macosx_15_0_x86_64.whl Python 3 none macOS 15.0+ x86-64 Details for meshkernel-8.4.1-py3-none-macosx_15_0_x86_64.whl
meshkernel-8.4.1-py3-none-macosx_15_0_arm64.whl Python 3 none macOS 15.0+ ARM64 Details for meshkernel-8.4.1-py3-none-macosx_15_0_arm64.whl

Total release size: 6.2 MB

Release files / meshkernel-8.4.1-py3-none-win_amd64.whl

Download URL meshkernel-8.4.1-py3-none-win_amd64.whl
Size 1.1 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
8876463b607468df25fb9a0a42b5986f28130c3577833be23b5b82119054a269
BLAKE2b-256 checksum
How to use checksums
b40c2462313c45ea60eeaf6768fa988dc449a4a0446b9c179ce7d1b4668f9dd6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / meshkernel-8.4.1-py3-none-manylinux_2_28_x86_64.whl

Download URL meshkernel-8.4.1-py3-none-manylinux_2_28_x86_64.whl
Size 1.5 MB
Tags Linux glibc 2.28+ x86-64 Python 3
SHA-256 checksum
How to use checksums
328b3bc340b139e0ad7b265d8a009a34ca8cef3509650ee8cfb39043bd9b20a7
BLAKE2b-256 checksum
How to use checksums
de0780139a508923ffff6e574ee388569fbd846ee66f49b61d15a1c9a84028c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / meshkernel-8.4.1-py3-none-macosx_26_0_arm64.whl

Download URL meshkernel-8.4.1-py3-none-macosx_26_0_arm64.whl
Size 1.2 MB
Tags Python 3 macOS 26.0+ ARM64
SHA-256 checksum
How to use checksums
769d75b81b638ae8549717b6348f570923d8fc0016c27b821fcff58e7c73cff8
BLAKE2b-256 checksum
How to use checksums
bb9fb2999c349300a20642f86f5c2cbc0a2d004da7e53777cd117da5768cb32d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / meshkernel-8.4.1-py3-none-macosx_15_0_x86_64.whl

Download URL meshkernel-8.4.1-py3-none-macosx_15_0_x86_64.whl
Size 1.2 MB
Tags Python 3 macOS 15.0+ x86-64
SHA-256 checksum
How to use checksums
fab291bb3f3f03aa0adc41f28a9ee4c6b3dadc6127c9f26ea713b32dd4d5a31c
BLAKE2b-256 checksum
How to use checksums
3220e22e74f7e81b6ddb8cc65fd5c897bb597ae7f107fc33b94c07a03aad9c70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.18

Release files / meshkernel-8.4.1-py3-none-macosx_15_0_arm64.whl

Download URL meshkernel-8.4.1-py3-none-macosx_15_0_arm64.whl
Size 1.1 MB
Tags Python 3 macOS 15.0+ ARM64
SHA-256 checksum
How to use checksums
6d6e65fba3a58984011e17e6ddb0f66e6d81770601f200493e3f833fc659bbcd
BLAKE2b-256 checksum
How to use checksums
81d5ea236c0fd0bfd4a72bdd2b501359806d4368ca116b0ec0c881e2b44cdf3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for meshkernel 8.4.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page