precice / precice/python-bindings

Request correct preCICE version

Open
#201 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

usability
Dominant language
Cython
Stars
30
Forks
19
PR merge metrics
No merged PRs in 30d

Description

Currently, the python bindings doesn't check the version of preCICE. It uses whatever version pkg-config finds on the system.

This leads to compile or link issues which could have been handled more gracefully via an error message.

There are two practical ways of tying the bindings version ot the preCICE version:

  • Exact match: bindings 3.1.X matches preCICE 3.1.Y. (what we currently do in the rust bindings)
  • Compatible match: bindings 3.1.X matches preCICE >=3.1 and <4.

The compatible match allows for forwards-compatibility, which is guaranteed due to the semanatic versioning we use (and follow) in preCICE. Meaning we can test newer releases with existing bindings.

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

Start by tracing how the Python bindings use pkg-config to select the preCICE version, then compare the version-matching approach used in the Rust bindings. Resolve whether exact or compatible matching is intended and ensure an incompatible version produces a clear error before compile or link failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.