precice / precice/python-bindings

Improve error message when preCICE wasn't found

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

Nobody has claimed this yet.

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

Description

Currently, when pkg-config cannot find preCICE it displays a generic error message.

We should instead describe in additional detail what has gone wrong and how to fix it.

We could link to https://precice.org/installation-source-finding.html

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 locating the pkg-config failure path in the Python bindings and reproduce the current generic error. Use the linked preCICE installation guidance to define the actionable details; done means the message explains the failure, suggests a fix, and links to the guide.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.