SimVascular / SimVascular/svOneDSolver
Store reference solutions for test cases
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 22
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Problem
We currently store the results for each test cases in a list, e.g.:
https://github.com/SimVascular/svOneDSolver/blob/d98fd52b4a44ec635c9c6a943a467ce981b3a2a3/Tests/SystemTests/test_integration.py#L198-L212
While it's nice to explicitly see the results we're testing against, it makes it somewhat annoying to add new tests (especially if those are larger).
Solution
Store a reference solution for each case in a dedicated folder and compare every test against the reference.
Additional context
This has been done for svZeroDSolver in https://github.com/SimVascular/svZeroDSolver/commit/ae38e9a888dac953d86c3d5f280f4f45d6fc775a
Code of Conduct
- I agree to follow this project's Code of Conduct and Contributing Guidelines
Contributor guide
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 with Tests/SystemTests/test_integration.py, especially the result lists around lines 198–212, and compare the reference-solution approach in the linked svZeroDSolver commit. Done means each test case has a dedicated reference solution and the integration tests compare their results against those references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- testing
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100