precice / precice/python-bindings
Check installed version of preCICE when import precice (python bindings)
Nobody has claimed this yet.
- Dominant language
- Cython
- Stars
- 30
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
I think it would be helpful to raise a warning, if the version of the python bindings does not match the installed preCICE version. Example: User updates preCICE from version 2.3 to version 2.5 but forgets to run pip3 install --upgrade pyprecice. This works, but might lead to strange errors, because the API is not up-to-date.
We could to the following:
>> import precice
<stdin>:1: UserWarning: You are using pyprecice 2.3.0.0, but it looks like you are using preCICE version 2.5.0. Please upgrade your python bindings by running pip3 install --upgrade pyprecice.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the import precice entry point and how the Python bindings and installed preCICE versions are exposed. Reproduce the version-mismatch scenario described in the issue; done means importing emits the specified UserWarning with both versions and the upgrade command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100