mne-tools / mne-tools/mne-python
Visualization tests with image regression testing
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Describe the new feature or enhancement
PyVista has contract testing with MNE to make sure we don't break anything you all are using. I'm wondering if we want to take this a step further with image regression testing to validate further we aren't changing the visualizations you all create here
AFAIK, that isn't implemented here, but do let me know if I'm not correct.
Describe your proposed implementation
Now that pytest-pyvista is implemented, this should be straightforward to set up for the visualization tests. Though... I looked at the tests here, and it wasn't immediately obvious to me where/how PyVista is used in the tests
https://github.com/pyvista/pytest-pyvista
Describe possible alternatives
Or just leave it as is, which only validates API usage and not actual rendering results.
Additional context
No response
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 by locating the visualization tests mentioned in the issue and reviewing how pytest-pyvista provides image regression testing. Determine where PyVista is used, then define coverage and expected rendered-image comparisons; the work is done when visualization tests validate rendering results rather than API usage alone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization, testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100