Dedicated example/tutorial for 3D plotting with pyvista

[m-weigand]

Feature Request

I recently started to do some simple 3D electrical forward modelling and inversions, and thus also was confronted with the pyvista-based 3D plots of pygimli. I am very impressed, thanks for the integration!

However, I keep clicking through examples to find ways to do common tasks regarding 3D plotting, and therefore propose a dedicated tutorial or example notebook for collecting basic 3D plot techniques, and solutions to common problems (for example, it took me a while to figure out how to 3D plot into files).

Again, I wanted to check if I a) missed any corresponding documentation, and b) if you would consider adding such a document.

I am attaching my current sketch of the notebook, and on positive feedback would try to sketch it out and create a merge request.

pg_3d_viewing_pyvista.ipynb

[florian-wagner]

Dear @m-weigand,

thanks for the initiative! A dedicated 3D visualization tutorial would be very useful and is highly welcome. We have foreseen a dedicated chapter on visualization in the new user guide, which is currently work-in-progress in the dev branch. @ninomenzel1 has started something on 3D visualization here: https://dev.pygimli.org/user-guide/visualization.html#plotting-meshes-and-models-in-3d

Feel free to adapt and complement with the content of your notebook (which looks nice and works well by the way). Please note that:

• The user guide will use the mystnb format. There are ways to convert a Jupyter Notebook to mystnb, but we decided that we do not want any Jupyter notebooks in the source code (but rather have them generated on-the-fly for download from the markdown files).
• Currently 2D and 3D visualization is in one markdown file. Feel free to refactor into a folder, e.g. visualization/index.md (with general concepts),visualization/2D.md and visualization/3D.md
• It also looks like the 3D plots are not working. We had them working interactively once with the pyvista Sphinx directive (https://docs.pyvista.org/extras/plot_directive.html). I can look into this. Maybe some server-side dependency missing.
• Please note that the user guide is in a very early stage and more a placeholder right now with missing content, typos, missing references, broken links, etc. We appreciate every fix that you spot along the way.

Cheers,
Florian