jupyter_backend#
- property MapdlTheme.jupyter_backend: str#
Return or set the jupyter notebook plotting backend.
Jupyter backend to use when plotting. Must be one of the following:
'static'
: Display a single static image within the Jupyterlab environment. Still requires that a virtual framebuffer be set up when displaying on a headless server, but does not require any additional modules to be installed.'client'
: Export/serialize the scene graph to be rendered with VTK.js client-side throughtrame
. Requirestrame
andjupyter-server-proxy
to be installed.'server'
: Render remotely and stream the resulting VTK images back to the client usingtrame
. This replaces the'ipyvtklink'
backend with better performance. Supports the most VTK features, but suffers from minor lag due to remote rendering. Requires that a virtual framebuffer be set up when displaying on a headless server. Must have at leasttrame
andjupyter-server-proxy
installed for cloud/remote Jupyter instances. This mode is also aliased by'trame'
.'trame'
: The full Trame-based backend that combines both'server'
and'client'
into one backend. This requires a virtual frame buffer.'html'
: The'client'
backend, but able to be embedded.'none'
: Do not display any plots within jupyterlab, instead display using dedicated VTK render windows. This will generate nothing on headless servers even with a virtual framebuffer.
Examples
Just show static images.
>>> pv.set_jupyter_backend('static')
Disable all plotting within JupyterLab and display using a standard desktop VTK render window.
>>> pv.set_jupyter_backend(None)