scenex#

scenex is a library for describing and visualizing scenes, with minimal dependencies.

Installation#

Because scenex can run with different visualization and widget backends, it doesn't ship with any backends by default. You can install the backends you'll like to use with extras:

pip install "scenex[pygfx,pyqt6]"

pip install "scenex[pygfx,jupyter]"

See the install istructions for comprehensive installation instructions!

Usage#

import numpy as np
import scenex as snx

# A single node — show() wraps it in a Scene and View for you
data = np.random.rand(100, 100).astype(np.float32)
img  = snx.Image(data=data)

snx.show(img)
snx.run()            # enter the event loop (not needed in Jupyter)

Mutating the model after it is displayed updates the rendered scene immediately:

from cmap import Colormap

img.cmap   = Colormap("viridis")
img.clims  = (0.2, 0.8)
img.opacity = 0.7

Alternatives#

Like any tool, scenex is not a panacea. It aims to be flexible, describing scenes at a high level and abstracting away graphics primitives, animation loops, etc. If you need lower-level access, consider using pygfx, vispy, or datoviz directly.

The primary focus of scenex is rendering scenes. While you can render anything in a scene, you might get more convenience from alternative visualization tools: