Add 3d backend table for overview #6370
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As we discussed @larsoner, this PR adds two tables to have an overview of the capabilitiies of each 3d backend available.
As of now, only
MayaviandPyVistaare available but work is in progress to add VisPy and Ipyvolume too.The first table contains all the 3D features supported by the backend and show the level of progression towards a full integration of those features into
mne-python.The second table is a list of the 3D functions currently supported and tested for this backend.
Those tables will be updated as more features will be added and the integration of the backend will improve. As expected, each new backend will add a column to those tables and once enough features are available, the PR for the "candidate" backend could be merged eventually.
For now, the convention used is
'X'for full support,'-'for partial support and' '(space) for not supported.Of course, any suggestion to improve or any feedback is welcome.