Skip to content
Snippets Groups Projects
Commit 95942a1d authored by Jean-Christophe Fillion-Robin's avatar Jean-Christophe Fillion-Robin Committed by Kitware Robot
Browse files

Merge topic 'doc/pyvista'


e9ea19f7 Add references to PyVista in documentation

Acked-by: default avatarKitware Robot <kwrobot@kitware.com>
Acked-by: default avatarbuildbot <buildbot@kitware.com>
Acked-by: default avatarBerk Geveci <berk.geveci@kitware.com>
Merge-request: !10345
parents 656566c6 e9ea19f7
No related branches found
No related tags found
No related merge requests found
......@@ -3,8 +3,9 @@
There are many VTK-based, free, open-source applications for scientific,
bio-medical and medical image visualization and processing; several of them are
extensible frameworks that can be customized for particular use cases.
[ParaView](https://paraview.org), [Trame](https://kitware.github.io/trame/index.html)
and [3D Slicer](https://www.slicer.org/) are examples. Therefore, it is worth
[ParaView](https://paraview.org), [Trame](https://kitware.github.io/trame/index.html),
[PyVista](https://docs.pyvista.org), and [3D Slicer](https://www.slicer.org/)
are examples. Therefore, it is worth
evaluating if any of these would allow you to address your challenges. This
would save time by avoiding redeveloping everything from scratch and by
capitalizing on large communities with thousands of experts.
......
# Using Jupyter
VTK can be used from within [Jupyter](https://jupyter.org/) by utilizing its
python package. When it comes to rendering it can be combined with the
[itkwidgets](https://itkwidgets.readthedocs.io/en/latest) package.
When it comes to rendering with VTK in Jupyter, there are several options.
For more details, check [this](https://colab.research.google.com/github/InsightSoftwareConsortium/itkwidgets/blob/main/examples/integrations/vtk/vtkImageData.ipynb) example.
To harness the full power of VTK in Jupyter, you may want to leverage
[PyVista](https://docs.pyvista.org/) and [Trame](https://kitware.github.io/trame/index.html).
PyVista exposes a high-level interface to VTK for plotting and when combined
with Trame, empowers users to bring the full power of VTK to a Jupyter
notebook. We have
[a post on the VTK discourse about this](https://discourse.vtk.org/t/pyvista-trame-jupyter-3d-visualization/10610). See PyVista's documentation
for more information on using PyVista's wrappings of VTK in Jupyter.
[itkwidgets](https://itkwidgets.readthedocs.io/en/latest) is one example of
a domain-specific Jupyter viewer built on VTK. To try out itkwidgets, check
[this example](https://colab.research.google.com/github/InsightSoftwareConsortium/itkwidgets/blob/main/examples/integrations/vtk/vtkImageData.ipynb).
# Using Python
VTK is available on [PyPi](https://pypi.org/) for Windows, macOS and Linux.
VTK is available on [PyPI](https://pypi.org/) for Windows, macOS and Linux.
```
pip install vtk
```
......@@ -56,3 +56,7 @@ That's it ! You may now try some of the
[tutorials](https://kitware.github.io/vtk-examples/site/Python/#tutorial),
[how to guides](https://kitware.github.io/vtk-examples/site/PythonHowTo) or
[examples](https://kitware.github.io/vtk-examples/site/Python).
If you are looking for a higher-level interface to VTK in Python, you may want
to explore using [PyVista](https://docs.pyvista.org) as it exposes VTK in a
"Pythonic" manner.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment