bec-widgets 0.53.2__py3-none-any.whl → 0.54.0__py3-none-any.whl

CHANGELOG.md

@@ -2,6 +2,30 @@
 
 
 
+## v0.54.0 (2024-05-24)
+
+### Build
+
+* build: added pyqt6 as sphinx build dependency ([`a47a8ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a47a8ec413934cf7fce8d5b7a5913371d4b3b4a5))
+
+### Feature
+
+* feat(figure): changes to support direct plot functionality ([`fc4d0f3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fc4d0f3bb2a7c2fca9c326d86eb68b305bcd548b))
+
+### Refactor
+
+* refactor(reconstruction): repository structure is changed to separate assets needed for each widget ([`3455c60`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3455c602361d3b5cc3ff9190f9d2870474becf8a))
+
+* refactor(clean-up): 1st generation widgets are removed ([`edc25fb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/edc25fbf9d5a0321e5f0a80b492b6337df807849))
+
+
+## v0.53.3 (2024-05-16)
+
+### Fix
+
+* fix: removed apparently unnecessary sleep while waiting for an rpc response ([`7d64cac`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7d64cac6610b39d3553ff650354f78ead8ee6b55))
+
+
 ## v0.53.2 (2024-05-15)
 
 ### Ci
@@ -146,28 +170,3 @@
 ### Fix
 
 * fix(widgets/editor): qscintilla editor removed ([`ab85374`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ab8537483da6c87cb9a0b0f01706208c964f292d))
-
-
-## v0.49.0 (2024-04-24)
-
-### Feature
-
-* feat(rpc/client_utils): timeout for rpc response ([`6500a00`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6500a00682a2a7ca535a138bd9496ed8470856a8))
-
-### Fix
-
-* fix(rpc/client_utils): close clean up policy for BECFigure ([`9602085`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9602085f82cbc983f89b5bfe48bf35f08438fa87))
-
-
-## v0.48.0 (2024-04-24)
-
-### Feature
-
-* feat(cli): added auto updates plugin support ([`6238693`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6238693ffb44b47a56b969bc4129f2af7a2c04fe))
-
-
-## v0.47.0 (2024-04-23)
-
-### Feature
-
-* feat(utils/thread_checker): util class to check the thread leakage for closeEvent in qt ([`71cb80d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/71cb80d544c5f4ef499379a431ce0c17907c7ce8))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.53.2
+Version: 0.54.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -554,17 +554,17 @@ class BECFigure(RPCBase):
     @rpc_call
     def plot(
         self,
-        x_name: "str" = None,
-        y_name: "str" = None,
-        z_name: "str" = None,
-        x_entry: "str" = None,
-        y_entry: "str" = None,
-        z_entry: "str" = None,
-        x: "list | np.ndarray" = None,
-        y: "list | np.ndarray" = None,
-        color: "Optional[str]" = None,
-        color_map_z: "Optional[str]" = "plasma",
-        label: "Optional[str]" = None,
+        x: "list | np.ndarray | None" = None,
+        y: "list | np.ndarray | None" = None,
+        x_name: "str | None" = None,
+        y_name: "str | None" = None,
+        z_name: "str | None" = None,
+        x_entry: "str | None" = None,
+        y_entry: "str | None" = None,
+        z_entry: "str | None" = None,
+        color: "str | None" = None,
+        color_map_z: "str | None" = "plasma",
+        label: "str | None" = None,
         validate: "bool" = True,
         **axis_kwargs,
     ) -> "BECWaveform":
@@ -572,14 +572,14 @@ class BECFigure(RPCBase):
         Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
 
         Args:
+            x(list | np.ndarray): Custom x data to plot.
+            y(list | np.ndarray): Custom y data to plot.
             x_name(str): The name of the device for the x-axis.
             y_name(str): The name of the device for the y-axis.
             z_name(str): The name of the device for the z-axis.
             x_entry(str): The name of the entry for the x-axis.
             y_entry(str): The name of the entry for the y-axis.
             z_entry(str): The name of the entry for the z-axis.
-            x(list | np.ndarray): Custom x data to plot.
-            y(list | np.ndarray): Custom y data to plot.
             color(str): The color of the curve.
             color_map_z(str): The color map to use for the z-axis.
             label(str): The label of the curve.

bec_widgets/cli/client_utils.py

@@ -13,7 +13,6 @@ from functools import wraps
 from typing import TYPE_CHECKING
 
 from bec_lib.endpoints import MessageEndpoints
-from bec_lib.service_config import ServiceConfig
 from bec_lib.utils.import_utils import isinstance_based_on_class_name, lazy_import, lazy_import_from
 from qtpy.QtCore import QCoreApplication
 
@@ -22,8 +21,6 @@ import bec_widgets.cli.client as client
 if TYPE_CHECKING:
     from bec_lib.device import DeviceBase
 
-    from bec_widgets.cli.client import BECDockArea, BECFigure
-
 messages = lazy_import("bec_lib.messages")
 # from bec_lib.connector import MessageObject
 MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
@@ -302,7 +299,6 @@ class RPCBase:
                 MessageEndpoints.gui_instruction_response(request_id)
             )
             QCoreApplication.processEvents()  # keep UI responsive (and execute signals/slots)
-            time.sleep(0.1)
         if response is None and (time.time() - start_time) >= timeout:
             raise RPCResponseTimeoutError(request_id, timeout)
 

bec_widgets/cli/generate_cli.py

@@ -109,11 +109,13 @@ if __name__ == "__main__":  # pragma: no cover
     import os
 
     from bec_widgets.utils import BECConnector
-    from bec_widgets.widgets.dock import BECDock, BECDockArea
-    from bec_widgets.widgets.figure import BECFigure
-    from bec_widgets.widgets.plots import BECImageShow, BECMotorMap, BECPlotBase, BECWaveform
-    from bec_widgets.widgets.plots.image import BECImageItem
-    from bec_widgets.widgets.plots.waveform import BECCurve
+    from bec_widgets.widgets import BECDock, BECDockArea, BECFigure
+    from bec_widgets.widgets.figure.plots.image.image import BECImageShow
+    from bec_widgets.widgets.figure.plots.image.image_item import BECImageItem
+    from bec_widgets.widgets.figure.plots.motor_map.motor_map import BECMotorMap
+    from bec_widgets.widgets.figure.plots.plot_base import BECPlotBase
+    from bec_widgets.widgets.figure.plots.waveform.waveform import BECWaveform
+    from bec_widgets.widgets.figure.plots.waveform.waveform_curve import BECCurve
 
     current_path = os.path.dirname(__file__)
     client_path = os.path.join(current_path, "client.py")

bec_widgets/cli/server.py

@@ -1,7 +1,5 @@
 import inspect
-import threading
-import time
-from typing import Literal, Union
+from typing import Union
 
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.utils.import_utils import lazy_import
@@ -12,13 +10,11 @@ from bec_widgets.utils import BECDispatcher
 from bec_widgets.utils.bec_connector import BECConnector
 from bec_widgets.widgets.dock.dock_area import BECDockArea
 from bec_widgets.widgets.figure import BECFigure
-from bec_widgets.widgets.plots import BECCurve, BECImageShow, BECWaveform
 
 messages = lazy_import("bec_lib.messages")
 
 
 class BECWidgetsCLIServer:
-    WIDGETS = [BECWaveform, BECFigure, BECCurve, BECImageShow]
 
     def __init__(
         self,
@@ -127,11 +123,13 @@ if __name__ == "__main__":  # pragma: no cover
     from qtpy.QtGui import QIcon
     from qtpy.QtWidgets import QApplication, QMainWindow
 
+    import bec_widgets
+
     app = QApplication(sys.argv)
     app.setApplicationName("BEC Figure")
-    current_path = os.path.dirname(__file__)
+    module_path = os.path.dirname(bec_widgets.__file__)
     icon = QIcon()
-    icon.addFile(os.path.join(current_path, "bec_widgets_icon.png"), size=QSize(48, 48))
+    icon.addFile(os.path.join(module_path, "assets", "bec_widgets_icon.png"), size=QSize(48, 48))
     app.setWindowIcon(icon)
 
     win = QMainWindow()

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -93,7 +93,7 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.console.set_default_style("linux")
 
     def _init_figure(self):
-        self.figure.plot("samx", "bpm4d")
+        self.figure.plot(x_name="samx", y_name="bpm4d")
         self.figure.motor_map("samx", "samy")
         self.figure.image("eiger", color_map="viridis", vrange=(0, 100))
 
@@ -124,7 +124,7 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.d2 = self.dock.add_dock(widget=self.label_1, position="right")
         self.d3 = self.dock.add_dock(name="figure")
         self.fig_dock3 = BECFigure()
-        self.fig_dock3.plot("samx", "bpm4d")
+        self.fig_dock3.plot(x_name="samx", y_name="bpm4d")
         self.d3.add_widget(self.label_3)
         self.d3.add_widget(self.button_3)
         self.d3.add_widget(self.fig_dock3)
@@ -142,6 +142,10 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
 if __name__ == "__main__":  # pragma: no cover
     import sys
 
+    import bec_widgets
+
+    module_path = os.path.dirname(bec_widgets.__file__)
+
     bec_dispatcher = BECDispatcher()
     client = bec_dispatcher.client
     client.start()
@@ -150,7 +154,7 @@ if __name__ == "__main__":  # pragma: no cover
     app.setApplicationName("Jupyter Console")
     app.setApplicationDisplayName("Jupyter Console")
     icon = QIcon()
-    icon.addFile("terminal_icon.png", size=QSize(48, 48))
+    icon.addFile(os.path.join(module_path, "assets", "terminal_icon.png"), size=QSize(48, 48))
     app.setWindowIcon(icon)
     win = JupyterConsoleWindow()
     win.show()

bec_widgets/examples/motor_movement/motor_control_compilations.py

@@ -5,14 +5,15 @@ from qtpy.QtCore import Qt
 from qtpy.QtWidgets import QApplication, QSplitter, QVBoxLayout, QWidget
 
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
-from bec_widgets.widgets import (
+from bec_widgets.widgets.motor_control.motor_control import MotorThread
+from bec_widgets.widgets.motor_control.motor_table.motor_table import MotorCoordinateTable
+from bec_widgets.widgets.motor_control.movement_absolute.movement_absolute import (
     MotorControlAbsolute,
+)
+from bec_widgets.widgets.motor_control.movement_relative.movement_relative import (
     MotorControlRelative,
-    MotorControlSelection,
-    MotorCoordinateTable,
-    MotorMap,
-    MotorThread,
 )
+from bec_widgets.widgets.motor_control.selection.selection import MotorControlSelection
 
 CONFIG_DEFAULT = {
     "motor_control": {
@@ -58,13 +59,13 @@ class MotorControlApp(QWidget):
         # Widgets
         self.motor_control_panel = MotorControlPanel(client=self.client, config=self.config)
         # Create MotorMap
-        self.motion_map = MotorMap(client=self.client, config=self.config)
+        # self.motion_map = MotorMap(client=self.client, config=self.config)
         # Create MotorCoordinateTable
         self.motor_table = MotorCoordinateTable(client=self.client, config=self.config)
 
         # Create the splitter and add MotorMap and MotorControlPanel
         splitter = QSplitter(Qt.Horizontal)
-        splitter.addWidget(self.motion_map)
+        # splitter.addWidget(self.motion_map)
         splitter.addWidget(self.motor_control_panel)
         splitter.addWidget(self.motor_table)
 
@@ -74,9 +75,9 @@ class MotorControlApp(QWidget):
         self.setLayout(layout)
 
         # Connecting signals and slots
-        self.motor_control_panel.selection_widget.selected_motors_signal.connect(
-            lambda x, y: self.motion_map.change_motors(x, y, 0)
-        )
+        # self.motor_control_panel.selection_widget.selected_motors_signal.connect(
+        #     lambda x, y: self.motion_map.change_motors(x, y, 0)
+        # )
         self.motor_control_panel.absolute_widget.coordinates_signal.connect(
             self.motor_table.add_coordinate
         )
@@ -87,7 +88,7 @@ class MotorControlApp(QWidget):
             self.motor_control_panel.absolute_widget.set_precision
         )
 
-        self.motor_table.plot_coordinates_signal.connect(self.motion_map.plot_saved_coordinates)
+        # self.motor_table.plot_coordinates_signal.connect(self.motion_map.plot_saved_coordinates)
 
 
 class MotorControlMap(QWidget):
@@ -101,11 +102,11 @@ class MotorControlMap(QWidget):
         # Widgets
         self.motor_control_panel = MotorControlPanel(client=self.client, config=self.config)
         # Create MotorMap
-        self.motion_map = MotorMap(client=self.client, config=self.config)
+        # self.motion_map = MotorMap(client=self.client, config=self.config)
 
         # Create the splitter and add MotorMap and MotorControlPanel
         splitter = QSplitter(Qt.Horizontal)
-        splitter.addWidget(self.motion_map)
+        # splitter.addWidget(self.motion_map)
         splitter.addWidget(self.motor_control_panel)
 
         # Set the main layout
@@ -114,9 +115,9 @@ class MotorControlMap(QWidget):
         self.setLayout(layout)
 
         # Connecting signals and slots
-        self.motor_control_panel.selection_widget.selected_motors_signal.connect(
-            lambda x, y: self.motion_map.change_motors(x, y, 0)
-        )
+        # self.motor_control_panel.selection_widget.selected_motors_signal.connect(
+        #     lambda x, y: self.motion_map.change_motors(x, y, 0)
+        # )
 
 
 class MotorControlPanel(QWidget):

bec_widgets/widgets/__init__.py

@@ -1,13 +1,3 @@
 from .dock import BECDock, BECDockArea
 from .figure import BECFigure, FigureConfig
-from .monitor import BECMonitor
-from .motor_control import (
-    MotorControlAbsolute,
-    MotorControlRelative,
-    MotorControlSelection,
-    MotorCoordinateTable,
-    MotorThread,
-)
-from .motor_map import MotorMap
-from .plots import BECCurve, BECMotorMap, BECWaveform
 from .scan_control import ScanControl

bec_widgets/widgets/figure/figure.py

@@ -11,18 +11,13 @@ import qdarktheme
 from pydantic import Field
 from qtpy.QtCore import Signal as pyqtSignal
 from qtpy.QtWidgets import QWidget
+from typeguard import typechecked
 
 from bec_widgets.utils import BECConnector, ConnectionConfig, WidgetContainerUtils
-from bec_widgets.widgets.plots import (
-    BECImageShow,
-    BECMotorMap,
-    BECPlotBase,
-    BECWaveform,
-    SubplotConfig,
-    Waveform1DConfig,
-)
-from bec_widgets.widgets.plots.image import ImageConfig
-from bec_widgets.widgets.plots.motor_map import MotorMapConfig
+from bec_widgets.widgets.figure.plots.image.image import BECImageShow, ImageConfig
+from bec_widgets.widgets.figure.plots.motor_map.motor_map import BECMotorMap, MotorMapConfig
+from bec_widgets.widgets.figure.plots.plot_base import BECPlotBase, SubplotConfig
+from bec_widgets.widgets.figure.plots.waveform.waveform import BECWaveform, Waveform1DConfig
 
 
 class FigureConfig(ConnectionConfig):
@@ -267,19 +262,20 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
         return waveform
 
+    @typechecked
     def plot(
         self,
-        x_name: str = None,
-        y_name: str = None,
-        z_name: str = None,
-        x_entry: str = None,
-        y_entry: str = None,
-        z_entry: str = None,
-        x: list | np.ndarray = None,
-        y: list | np.ndarray = None,
-        color: Optional[str] = None,
-        color_map_z: Optional[str] = "plasma",
-        label: Optional[str] = None,
+        x: list | np.ndarray | None = None,
+        y: list | np.ndarray | None = None,
+        x_name: str | None = None,
+        y_name: str | None = None,
+        z_name: str | None = None,
+        x_entry: str | None = None,
+        y_entry: str | None = None,
+        z_entry: str | None = None,
+        color: str | None = None,
+        color_map_z: str | None = "plasma",
+        label: str | None = None,
         validate: bool = True,
         **axis_kwargs,
     ) -> BECWaveform:
@@ -287,14 +283,14 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
 
         Args:
+            x(list | np.ndarray): Custom x data to plot.
+            y(list | np.ndarray): Custom y data to plot.
             x_name(str): The name of the device for the x-axis.
             y_name(str): The name of the device for the y-axis.
             z_name(str): The name of the device for the z-axis.
             x_entry(str): The name of the entry for the x-axis.
             y_entry(str): The name of the entry for the y-axis.
             z_entry(str): The name of the entry for the z-axis.
-            x(list | np.ndarray): Custom x data to plot.
-            y(list | np.ndarray): Custom y data to plot.
             color(str): The color of the curve.
             color_map_z(str): The color map to use for the z-axis.
             label(str): The label of the curve.
@@ -313,6 +309,27 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         else:
             waveform = self.add_plot(**axis_kwargs)
 
+        if x is not None and y is None:
+            if isinstance(x, np.ndarray):
+                if x.ndim == 1:
+                    y = np.arange(x.size)
+                    waveform.add_curve_custom(x=np.arange(x.size), y=x, color=color, label=label)
+                    return waveform
+                if x.ndim == 2:
+                    waveform.add_curve_custom(x=x[:, 0], y=x[:, 1], color=color, label=label)
+                    return waveform
+            elif isinstance(x, list):
+                y = np.arange(len(x))
+                waveform.add_curve_custom(x=np.arange(len(x)), y=x, color=color, label=label)
+                return waveform
+            else:
+                raise ValueError(
+                    "Invalid input. Provide either device names (x_name, y_name) or custom data."
+                )
+        if x is not None and y is not None:
+            waveform.add_curve_custom(x=x, y=y, color=color, label=label)
+            return waveform
+
         # User wants to add scan curve -> 1D Waveform
         if x_name is not None and y_name is not None and z_name is None and x is None and y is None:
             waveform.add_curve_scan(