show
#
- biotite.interface.pymol.show(size=None, use_ray=False, timeout=60.0, pymol_instance=None)[source]#
Render an image of the PyMOL session and display it in the current Jupyter notebook.
Note that this function works only in a Jupyter notebook.
- Parameters:
- sizetuple of (int, int), optional
The width and height of the rendered image in pixels. By default, the size of the current PyMOL viewport is used.
- use_raybool, optional
If set to true, the a ray-traced image is created. This will also increase the rendering time.
- timeoutfloat
The number of seconds to wait for image output from PyMOL.
- pymol_instancemodule or SingletonPyMOL or PyMOL, optional
If PyMOL is used in library mode, the
PyMOL
orSingletonPyMOL
object is given here. If otherwise PyMOL is used in GUI mode, thepymol
module is given. By default the currently active PyMOL instance is used. If no PyMOL instance is currently running, PyMOL is started in library mode.
- Raises:
- TimeoutError
If no image was created after expiry of the timeout limit.
Notes
Internally uses the PyMOL
png
command.
Gallery#

Searching for structural homologs in a protein structure database