fastplotlib · kushalkolar · Mar 31, 2024 · Mar 13, 2024 · Mar 13, 2024 · Mar 13, 2024
@@ -33,39 +33,18 @@ View available GPU

 You can view all GPUs that are available to ``WGPU`` like this::

-    from wgpu.backends.wgpu_native import enumerate_adapters
-    from pprint import pprint
+    import wgpu

-    for adapter in enumerate_adapters():
-        pprint(adapter.request_adapter_info())
+    for adapter in wgpu.gpu.enumerate_adapters():
+        print(adapter.summary)

 For example, on a Thinkpad AMD laptop with a dedicated nvidia GPU this returns::

-    {'adapter_type': 'IntegratedGPU',
-     'architecture': '',
-     'backend_type': 'Vulkan',
-     'description': 'Mesa 22.3.6',
-     'device': 'AMD Radeon Graphics (RADV REMBRANDT)',
-     'vendor': 'radv'}
-    {'adapter_type': 'DiscreteGPU',
-     'architecture': '',
-     'backend_type': 'Vulkan',
-     'description': '535.129.03',
-     'device': 'NVIDIA T1200 Laptop GPU',
-     'vendor': 'NVIDIA'}
-    {'adapter_type': 'CPU',
-     'architecture': '',
-     'backend_type': 'Vulkan',
-     'description': 'Mesa 22.3.6 (LLVM 15.0.6)',
-     'device': 'llvmpipe (LLVM 15.0.6, 256 bits)',
-     'vendor': 'llvmpipe'}
-    {'adapter_type': 'Unknown',
-     'architecture': '',
-     'backend_type': 'OpenGL',
-     'description': '',
-     'device': 'AMD Radeon Graphics (rembrandt, LLVM 15.0.6, DRM 3.52, '
-               '6.4.0-0.deb12.2-amd64)',
-     'vendor': ''}
+    AMD Radeon Graphics (RADV REMBRANDT) (IntegratedGPU) on Vulkan
+    NVIDIA T1200 Laptop GPU (DiscreteGPU) on Vulkan
+    llvmpipe (LLVM 15.0.6, 256 bits) (CPU) on Vulkan
+    AMD Radeon Graphics (rembrandt, LLVM 15.0.6, DRM 3.52, 6.4.0-0.deb12.2-amd64) (Unknown) on OpenGL
+

 GPU currently in use
 --------------------
@@ -78,5 +57,5 @@ If you want to know the GPU that a current plot is using you can check the adapt
    plot.show()

    # GPU that is currently in use by the renderer
-    plot.renderer.device.adapter.request_adapter_info()
+    print(plot.renderer.device.adapter.summary)

@@ -5,21 +5,20 @@
 from .graphics.selectors import *
 from .legends import *
 from .widgets import ImageWidget
-from .utils import _notebook_print_banner, config
+from .utils import config
+from .utils.gui import run

-from wgpu.gui.auto import run
-from wgpu.backends.wgpu_native import enumerate_adapters
+import wgpu


 with open(Path(__file__).parent.joinpath("VERSION"), "r") as f:
    __version__ = f.read().split("\n")[0]

-adapters = [a.request_adapter_info() for a in enumerate_adapters()]
+adapters = [a.summary for a in wgpu.gpu.enumerate_adapters()]

 if len(adapters) < 1:
    raise IndexError("No WGPU adapters found, fastplotlib will not work.")

-_notebook_print_banner()

 __all__ = [
    "Plot",

@@ -3,21 +3,19 @@
 from numbers import Real

 import numpy as np
-
 import pygfx

-try:
-    import ipywidgets
-
-    HAS_IPYWIDGETS = True
-except (ImportError, ModuleNotFoundError):
-    HAS_IPYWIDGETS = False
-
+from ...utils.gui import IS_JUPYTER
 from .._base import Graphic, GraphicCollection
 from .._features._selection_features import LinearSelectionFeature
 from ._base_selector import BaseSelector


+if IS_JUPYTER:
+    # If using the jupyter backend, user has jupyter_rfb, and thus also ipywidgets
+    import ipywidgets
+
+
 class LinearSelector(BaseSelector):
    @property
    def limits(self) -> Tuple[float, float]:
@@ -240,7 +238,7 @@ def make_ipywidget_slider(self, kind: str = "IntSlider", **kwargs):

        """

-        if not HAS_IPYWIDGETS:
+        if not IS_JUPYTER:
            raise ImportError(
                "Must installed `ipywidgets` to use `make_ipywidget_slider()`"
            )

@@ -1,20 +1,18 @@
 from typing import *
 from numbers import Real

-try:
-    import ipywidgets
-
-    HAS_IPYWIDGETS = True
-except (ImportError, ModuleNotFoundError):
-    HAS_IPYWIDGETS = False
-
 import numpy as np
-
 import pygfx

+from ...utils.gui import IS_JUPYTER
 from .._base import Graphic, GraphicCollection
-from ._base_selector import BaseSelector
 from .._features._selection_features import LinearRegionSelectionFeature
+from ._base_selector import BaseSelector
+
+
+if IS_JUPYTER:
+    # If using the jupyter backend, user has jupyter_rfb, and thus also ipywidgets
+    import ipywidgets


 class LinearRegionSelector(BaseSelector):
@@ -390,7 +388,7 @@ def make_ipywidget_slider(self, kind: str = "IntRangeSlider", **kwargs):

        """

-        if not HAS_IPYWIDGETS:
+        if not IS_JUPYTER:
            raise ImportError(
                "Must installed `ipywidgets` to use `make_ipywidget_slider()`"
            )

@@ -1,41 +1,7 @@
 import os

-from ._toolbar import ToolBar
-
 from ...graphics import ImageGraphic
-
-from .._utils import CANVAS_OPTIONS_AVAILABLE
-
-
-class UnavailableOutputContext:
-    # called when a requested output context is not available
-    # ex: if trying to force jupyter_rfb canvas but jupyter_rfb is not installed
-    def __init__(self, context_name, msg):
-        self.context_name = context_name
-        self.msg = msg
-
-    def __call__(self, *args, **kwargs):
-        raise ModuleNotFoundError(
-            f"The following output context is not available: {self.context_name}\n{self.msg}"
-        )
-
-
-# TODO: potentially put all output context and toolbars in their own module and have this determination done at import
-if CANVAS_OPTIONS_AVAILABLE["jupyter"]:
-    from ._jupyter_output import JupyterOutputContext
-else:
-    JupyterOutputContext = UnavailableOutputContext(
-        "Jupyter",
-        "You must install fastplotlib using the `'notebook'` option to use this context:\n"
-        'pip install "fastplotlib[notebook]"',
-    )
-
-if CANVAS_OPTIONS_AVAILABLE["qt"]:
-    from ._qt_output import QOutputContext
-else:
-    QtOutput = UnavailableOutputContext(
-        "Qt", "You must install `PyQt6` to use this output context"
-    )
+from ._toolbar import ToolBar


 class Frame:
@@ -158,6 +124,8 @@ def show(

        # return the appropriate OutputContext based on the current canvas
        if self.canvas.__class__.__name__ == "JupyterWgpuCanvas":
+            from ._jupyter_output import JupyterOutputContext  # noqa - inline import
+
            self._output = JupyterOutputContext(
                frame=self,
                make_toolbar=toolbar,
@@ -167,6 +135,8 @@ def show(
            )

        elif self.canvas.__class__.__name__ == "QWgpuCanvas":
+            from ._qt_output import QOutputContext  # noqa - inline import
+
            self._output = QOutputContext(
                frame=self, make_toolbar=toolbar, add_widgets=add_widgets
            )

@@ -1,5 +1,4 @@
-from PyQt6 import QtWidgets
-
+from ...utils.gui import QtWidgets
 from ._qt_toolbar import QToolbar



@@ -4,8 +4,7 @@
 import traceback
 from typing import *

-from PyQt6 import QtWidgets, QtCore
-
+from ...utils.gui import QtCore, QtWidgets
 from ...graphics.selectors import PolygonSelector
 from ._toolbar import ToolBar
 from ._qtoolbar_template import Ui_QToolbar

@@ -5,8 +5,7 @@
 # WARNING: Any manual changes made to this file will be lost when pyuic6 is
 # run again.  Do not edit this file unless you know what you are doing.

-
-from PyQt6 import QtCore, QtGui, QtWidgets
+from ...utils.gui import QtGui, QtCore, QtWidgets


 class Ui_QToolbar(object):
@@ -30,7 +29,7 @@ def setupUi(self, QToolbar):
        self.maintain_aspect_button = QtWidgets.QPushButton(parent=QToolbar)
        font = QtGui.QFont()
        font.setBold(True)
-        font.setWeight(75)
+        font.setWeight(QtGui.QFont.Weight.Bold)
        self.maintain_aspect_button.setFont(font)
        self.maintain_aspect_button.setCheckable(True)
        self.maintain_aspect_button.setObjectName("maintain_aspect_button")

@@ -6,7 +6,7 @@

 import pygfx

-from wgpu.gui.auto import WgpuCanvas
+from wgpu.gui import WgpuCanvasBase

 from ._frame import Frame
 from ._utils import make_canvas_and_renderer, create_controller, create_camera
@@ -22,7 +22,7 @@ def __init__(
        cameras: Union[str, list, np.ndarray] = "2d",
        controller_types: Union[str, list, np.ndarray] = None,
        controller_ids: Union[str, list, np.ndarray] = None,
-        canvas: Union[str, WgpuCanvas, pygfx.Texture] = None,
+        canvas: Union[str, WgpuCanvasBase, pygfx.Texture] = None,
        renderer: pygfx.WgpuRenderer = None,
        size: Tuple[int, int] = (500, 300),
        names: Union[list, np.ndarray] = None,
@@ -219,12 +219,6 @@ def __init__(
                for cam in cams[1:]:
                    _controller.add_camera(cam)

-        if canvas is None:
-            canvas = WgpuCanvas()
-
-        if renderer is None:
-            renderer = pygfx.renderers.WgpuRenderer(canvas)
-
        self._canvas = canvas
        self._renderer = renderer

@@ -266,7 +260,7 @@ def __init__(
        Frame.__init__(self)

    @property
-    def canvas(self) -> WgpuCanvas:
+    def canvas(self) -> WgpuCanvasBase:
        """The canvas associated to this GridPlot"""
        return self._canvas


@@ -1,7 +1,7 @@
 from typing import *

 import pygfx
-from wgpu.gui.auto import WgpuCanvas
+from wgpu.gui import WgpuCanvasBase

 from ._subplot import Subplot
 from ._frame import Frame
@@ -11,7 +11,7 @@
 class Plot(Subplot, Frame, RecordMixin):
    def __init__(
        self,
-        canvas: Union[str, WgpuCanvas] = None,
+        canvas: Union[str, WgpuCanvasBase] = None,
        renderer: pygfx.WgpuRenderer = None,
        camera: Union[str, pygfx.PerspectiveCamera] = "2d",
        controller: Union[str, pygfx.Controller] = None,

@@ -7,7 +7,7 @@

 import pygfx
 from pylinalg import vec_transform, vec_unproject
-from wgpu.gui.auto import WgpuCanvas
+from wgpu.gui import WgpuCanvasBase

 from ._utils import create_camera, create_controller
 from ..graphics._base import Graphic
@@ -29,7 +29,7 @@ def __init__(
        camera: Union[pygfx.PerspectiveCamera],
        controller: Union[pygfx.Controller],
        scene: pygfx.Scene,
-        canvas: WgpuCanvas,
+        canvas: WgpuCanvasBase,
        renderer: pygfx.WgpuRenderer,
        name: str = None,
    ):
@@ -122,7 +122,7 @@ def scene(self) -> pygfx.Scene:
        return self._scene

    @property
-    def canvas(self) -> WgpuCanvas:
+    def canvas(self) -> WgpuCanvasBase:
        """Canvas associated to the plot area"""
        return self._canvas


@@ -4,7 +4,7 @@

 import pygfx

-from wgpu.gui.auto import WgpuCanvas
+from wgpu.gui import WgpuCanvasBase

 from ..graphics import TextGraphic
 from ._utils import make_canvas_and_renderer, create_camera, create_controller
@@ -20,7 +20,7 @@ def __init__(
        parent_dims: Tuple[int, int] = None,
        camera: Union[str, pygfx.PerspectiveCamera] = "2d",
        controller: Union[str, pygfx.Controller] = None,
-        canvas: Union[str, WgpuCanvas, pygfx.Texture] = None,
+        canvas: Union[str, WgpuCanvasBase, pygfx.Texture] = None,
        renderer: pygfx.WgpuRenderer = None,
        name: str = None,
    ):