Deltares / Deltares/MeshKernelPy

Deprecate/remove old APIs for smoothness and orthogonality

Open
#284 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

chore
Dominant language
Python
Stars
27
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Orthogonality can be retrieved with mesh2d_get_orthogonality or with mesh2d_get_property, deprecate the first one. Also deprecate mesh2d_get_smoothness, after merging https://github.com/Deltares/MeshKernel/pull/543 and https://github.com/Deltares/MeshKernelPy/pull/282.

Grideditor/MKNet uses C-methods mkernel_mesh2d_get_smoothness en mkernel_mesh2d_get_orthogonality (as of 11 August 2026), so that would be a breaking change. Therefore, first release meshkernel with the smoothness added to get_property and ask them to update their code.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review mesh2d_get_orthogonality, mesh2d_get_smoothness, and mesh2d_get_property alongside PRs #543 and #282. Check how Grideditor/MKNet uses mkernel_mesh2d_get_smoothness and mkernel_mesh2d_get_orthogonality. Done means smoothness is available through get_property and the old APIs are deprecated only after the dependent release update.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.