bec-widgets 0.53.3__py3-none-any.whl → 0.55.0__py3-none-any.whl

CHANGELOG.md

@@ -2,6 +2,30 @@
 
 
 
+## v0.55.0 (2024-05-24)
+
+### Feature
+
+* feat(widgets/progressbar): SpiralProgressBar added with rpc interface ([`76bd0d3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/76bd0d339ac9ae9e8a3baa0d0d4e951ec1d09670))
+
+
+## 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
@@ -145,29 +169,3 @@
 
 
 ## v0.49.1 (2024-04-26)
-
-### Build
-
-* build(pyqt6): fixing PyQt6-Qt6 package to 6.6.3 ([`a222298`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a22229849cbb57c15e4c1bae02d7e52e672f8c4c))
-
-### 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))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.53.3
+Version: 0.55.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.
@@ -1630,3 +1630,255 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
         """
         Get all registered RPC objects.
         """
+
+
+class SpiralProgressBar(RPCBase):
+    @rpc_call
+    def get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+    @property
+    @rpc_call
+    def rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @property
+    @rpc_call
+    def rings(self):
+        """
+        None
+        """
+
+    @rpc_call
+    def update_config(self, config: "SpiralProgressBarConfig | dict"):
+        """
+        Update the configuration of the widget.
+
+        Args:
+            config(SpiralProgressBarConfig|dict): Configuration to update.
+        """
+
+    @rpc_call
+    def add_ring(self, **kwargs) -> "Ring":
+        """
+        Add a new progress bar.
+
+        Args:
+            **kwargs: Keyword arguments for the new progress bar.
+
+        Returns:
+            Ring: Ring object.
+        """
+
+    @rpc_call
+    def remove_ring(self, index: "int"):
+        """
+        Remove a progress bar by index.
+
+        Args:
+            index(int): Index of the progress bar to remove.
+        """
+
+    @rpc_call
+    def set_precision(self, precision: "int", bar_index: "int" = None):
+        """
+        Set the precision for the progress bars. If bar_index is not provide, the precision will be set for all progress bars.
+
+        Args:
+            precision(int): Precision for the progress bars.
+            bar_index(int): Index of the progress bar to set the precision for. If provided, only a single precision can be set.
+        """
+
+    @rpc_call
+    def set_min_max_values(
+        self,
+        min_values: "int | float | list[int | float]",
+        max_values: "int | float | list[int | float]",
+    ):
+        """
+        Set the minimum and maximum values for the progress bars.
+
+        Args:
+            min_values(int|float | list[float]): Minimum value(s) for the progress bars. If multiple progress bars are displayed, provide a list of minimum values for each progress bar.
+            max_values(int|float | list[float]): Maximum value(s) for the progress bars. If multiple progress bars are displayed, provide a list of maximum values for each progress bar.
+        """
+
+    @rpc_call
+    def set_number_of_bars(self, num_bars: "int"):
+        """
+        Set the number of progress bars to display.
+
+        Args:
+            num_bars(int): Number of progress bars to display.
+        """
+
+    @rpc_call
+    def set_value(self, values: "int | list", ring_index: "int" = None):
+        """
+        Set the values for the progress bars.
+
+        Args:
+            values(int | tuple): Value(s) for the progress bars. If multiple progress bars are displayed, provide a tuple of values for each progress bar.
+            ring_index(int): Index of the progress bar to set the value for. If provided, only a single value can be set.
+
+        Examples:
+            >>> SpiralProgressBar.set_value(50)
+            >>> SpiralProgressBar.set_value([30, 40, 50]) # (outer, middle, inner)
+            >>> SpiralProgressBar.set_value(60, bar_index=1) # Set the value for the middle progress bar.
+        """
+
+    @rpc_call
+    def set_colors_from_map(self, colormap, color_format: "Literal['RGB', 'HEX']" = "RGB"):
+        """
+        Set the colors for the progress bars from a colormap.
+
+        Args:
+            colormap(str): Name of the colormap.
+            color_format(Literal["RGB","HEX"]): Format of the returned colors ('RGB', 'HEX').
+        """
+
+    @rpc_call
+    def set_colors_directly(
+        self, colors: "list[str | tuple] | str | tuple", bar_index: "int" = None
+    ):
+        """
+        Set the colors for the progress bars directly.
+
+        Args:
+            colors(list[str | tuple] | str | tuple): Color(s) for the progress bars. If multiple progress bars are displayed, provide a list of colors for each progress bar.
+            bar_index(int): Index of the progress bar to set the color for. If provided, only a single color can be set.
+        """
+
+    @rpc_call
+    def set_line_widths(self, widths: "int | list[int]", bar_index: "int" = None):
+        """
+        Set the line widths for the progress bars.
+
+        Args:
+            widths(int | list[int]): Line width(s) for the progress bars. If multiple progress bars are displayed, provide a list of line widths for each progress bar.
+            bar_index(int): Index of the progress bar to set the line width for. If provided, only a single line width can be set.
+        """
+
+    @rpc_call
+    def set_gap(self, gap: "int"):
+        """
+        Set the gap between the progress bars.
+
+        Args:
+            gap(int): Gap between the progress bars.
+        """
+
+    @rpc_call
+    def set_diameter(self, diameter: "int"):
+        """
+        Set the diameter of the widget.
+
+        Args:
+            diameter(int): Diameter of the widget.
+        """
+
+    @rpc_call
+    def reset_diameter(self):
+        """
+        Reset the fixed size of the widget.
+        """
+
+    @rpc_call
+    def enable_auto_updates(self, enable: "bool" = True):
+        """
+        Enable or disable updates based on scan status. Overrides manual updates.
+        The behaviour of the whole progress bar widget will be driven by the scan queue status.
+
+        Args:
+            enable(bool): True or False.
+
+        Returns:
+            bool: True if scan segment updates are enabled.
+        """
+
+
+class Ring(RPCBase):
+    @rpc_call
+    def get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+    @property
+    @rpc_call
+    def rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def set_value(self, value: "int | float"):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_color(self, color: "str | tuple"):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_background(self, color: "str | tuple"):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_line_width(self, width: "int"):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_min_max_values(self, min_value: "int", max_value: "int"):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_start_angle(self, start_angle: "int"):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_connections(self, slot: "str", endpoint: "str | EndpointInfo"):
+        """
+        None
+        """
+
+    @rpc_call
+    def reset_connection(self):
+        """
+        None
+        """

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",))

bec_widgets/cli/generate_cli.py

@@ -109,11 +109,14 @@ 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, SpiralProgressBar
+    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
+    from bec_widgets.widgets.spiral_progress_bar.ring import Ring
 
     current_path = os.path.dirname(__file__)
     client_path = os.path.join(current_path, "client.py")
@@ -128,6 +131,8 @@ if __name__ == "__main__":  # pragma: no cover
         BECMotorMap,
         BECDock,
         BECDockArea,
+        SpiralProgressBar,
+        Ring,
     ]
     generator = ClientGenerator()
     generator.generate_client(clss)

bec_widgets/cli/rpc_wigdet_handler.py

@@ -1,11 +1,12 @@
 from bec_widgets.utils import BECConnector
 from bec_widgets.widgets.figure import BECFigure
+from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBar
 
 
 class RPCWidgetHandler:
     """Handler class for creating widgets from RPC messages."""
 
-    widget_classes = {"BECFigure": BECFigure}
+    widget_classes = {"BECFigure": BECFigure, "SpiralProgressBar": SpiralProgressBar}
 
     @staticmethod
     def create_widget(widget_type, **kwargs) -> BECConnector:

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

@@ -13,6 +13,7 @@ from bec_widgets.cli.rpc_register import RPCRegister
 from bec_widgets.utils import BECDispatcher
 from bec_widgets.widgets import BECFigure
 from bec_widgets.widgets.dock.dock_area import BECDockArea
+from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBar
 
 
 class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:
@@ -62,6 +63,7 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
                 "d1": self.d1,
                 "d2": self.d2,
                 "d3": self.d3,
+                "bar": self.bar,
                 "b2a": self.button_2_a,
                 "b2b": self.button_2_b,
                 "b2c": self.button_2_c,
@@ -93,7 +95,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))
 
@@ -114,17 +116,17 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.button_2_b = QtWidgets.QPushButton("button after without postions specified")
         self.button_2_c = QtWidgets.QPushButton("button super late")
         self.button_3 = QtWidgets.QPushButton("Button above Figure ")
-        self.label_1 = QtWidgets.QLabel("some scan info label with useful information")
+        self.bar = SpiralProgressBar()
 
         self.label_2 = QtWidgets.QLabel("label which is added separately")
         self.label_3 = QtWidgets.QLabel("Label above figure")
 
         self.d1 = self.dock.add_dock(widget=self.button_1, position="left")
         self.d1.addWidget(self.label_2)
-        self.d2 = self.dock.add_dock(widget=self.label_1, position="right")
+        self.d2 = self.dock.add_dock(widget=self.bar, 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 +144,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 +156,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,4 @@
 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
+from .spiral_progress_bar import SpiralProgressBar