search

mne-tools / mne-bids

MNE-BIDS is a Python package that allows you to read and write BIDS-compatible datasets with the help of MNE-Python.
https://mne.tools/mne-bids/
BSD 3-Clause "New" or "Revised" License
131 stars 85 forks source link

Add 3D figure rendering to documentation #981

Closed hoechenberger closed 1 year ago

hoechenberger commented 2 years ago

we don't support pyvista and 3D plots in the doc of mne-bids... to be done later I guess

Originally posted by @agramfort in https://github.com/mne-tools/mne-bids/pull/980#pullrequestreview-902638616

cc @larsoner

larsoner commented 2 years ago

Adding a scraper for plot_alignment or other things that just use a simple 3D scene is as simple as adding 'image_scrapers': ('pyvista', ...) to sphinx_gallery-conf in principle. In practice you then need to make sure it actually renders properly.

If you want stc.plot or something, you want _BrainScraper or so, but it's still doable.

I'd wait until you had a use case, then I'm happy to help. It sounds like you can't actually use it for #980 because you don't have the right files (?).

sappelhoff commented 2 years ago

Do we still need this? Where are we missing a 3D figure in our docs?

This was the example worked on in #980: https://mne.tools/mne-bids/stable/auto_examples/convert_ieeg_to_bids.html#sphx-glr-auto-examples-convert-ieeg-to-bids-py

looks fine to me? I'd close this issue.