bec-widgets 0.56.3__py3-none-any.whl → 0.57.1__py3-none-any.whl

CHANGELOG.md

@@ -2,6 +2,30 @@
 
 
 
+## v0.57.1 (2024-06-06)
+
+### Documentation
+
+* docs: docs refactored from add_widget_bec to add_widget ([`c3f4845`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c3f4845b4f95005ff737fed5542600b0b9a9cc2b))
+
+### Fix
+
+* fix: tests references to add_widget_bec refactored ([`f51b25f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f51b25f0af4ab8b0a75ee48a40bfbb079c16e9d1))
+
+* fix(dock): add_widget and add_widget_bec consolidated ([`8ae323f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8ae323f5c3c0d9d0f202d31d5e8374a272a26be2))
+
+
+## v0.57.0 (2024-06-05)
+
+### Documentation
+
+* docs: extend user documentation for BEC Widgets ([`4160f3d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4160f3d6d7ec1122785b5e3fdfc4afe67a95e9a1))
+
+### Feature
+
+* feat(widgets/console): BECJupyterConsole added ([`8c03034`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8c03034acf6b3ed1e346ebf1b785d41068513cc5))
+
+
 ## v0.56.3 (2024-06-05)
 
 ### Ci
@@ -149,27 +173,3 @@
 ### Fix
 
 * fix(docstrings): docstrings formating fixed for sphinx to properly format readdocs ([`7f2f7cd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7f2f7cd07a14876617cd83cedde8c281fdc52c3a))
-
-
-## v0.52.0 (2024-05-07)
-
-### Ci
-
-* ci: fixed support for child pipelines ([`e65c7f3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e65c7f3be895ada407bd358edf67d569d2cab08e))
-
-### Feature
-
-* feat(utils/layout_manager): added GridLayoutManager to extend functionalities of native QGridLayout ([`fcd6ef0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fcd6ef0975dc872f69c9d6fb2b8a1ad04a423aae))
-
-* feat(widget/dock): BECDock and BECDock area for dockable windows ([`d8ff8af`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d8ff8afcd474660a6069bbdab05f10a65f221727))
-
-### Fix
-
-* fix(widgets/dock): BECDockArea close overwrites the default pyqtgraph Container close + minor improvements ([`ceae979`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ceae979f375ecc33c5c97148f197655c1ca57b6c))
-
-### Refactor
-
-* refactor(widget/plots): WidgetConfig changed to SubplotConfig ([`03fa1f2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/03fa1f26d0fa6b58ed05556fb2438d1e62f6c107))
-
-
-## v0.51.0 (2024-05-07)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.56.3
+Version: 0.57.1
 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/auto_updates.py

@@ -30,7 +30,7 @@ class AutoUpdates:
         Create a default dock for the auto updates.
         """
         dock = self.gui.add_dock("default_figure")
-        dock.add_widget_bec("BECFigure")
+        dock.add_widget("BECFigure")
         self.dock_name = "default_figure"
 
     @staticmethod

bec_widgets/cli/client.py

@@ -1468,20 +1468,20 @@ class BECDock(RPCBase):
         """
 
     @rpc_call
-    def add_widget_bec(
+    def add_widget(
         self,
-        widget_type: "str",
+        widget: "BECConnector | str",
         row=None,
         col=0,
         rowspan=1,
         colspan=1,
         shift: "Literal['down', 'up', 'left', 'right']" = "down",
-    ):
+    ) -> "BECConnector":
         """
         Add a widget to the dock.
 
         Args:
-            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+            widget(QWidget): The widget to add.
             row(int): The row to add the widget to. If None, the widget will be added to the next available row.
             col(int): The column to add the widget to.
             rowspan(int): The number of rows the widget should span.

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -12,22 +12,22 @@ from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
 from bec_widgets.utils import BECDispatcher, UILoader
 from bec_widgets.widgets import BECFigure
 from bec_widgets.widgets.dock.dock_area import BECDockArea
-
-
-class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:
-    def __init__(self):
-        super().__init__()
-
-        self.kernel_manager = QtInProcessKernelManager()
-        self.kernel_manager.start_kernel(show_banner=False)
-        self.kernel_client = self.kernel_manager.client()
-        self.kernel_client.start_channels()
-
-        self.kernel_manager.kernel.shell.push({"np": np, "pg": pg})
-
-    def shutdown_kernel(self):
-        self.kernel_client.stop_channels()
-        self.kernel_manager.shutdown_kernel()
+from bec_widgets.widgets.jupyter_console.jupyter_console import BECJupyterConsole
+
+# class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:
+#     def __init__(self):
+#         super().__init__()
+#
+#         self.kernel_manager = QtInProcessKernelManager()
+#         self.kernel_manager.start_kernel(show_banner=False)
+#         self.kernel_client = self.kernel_manager.client()
+#         self.kernel_client.start_channels()
+#
+#         self.kernel_manager.kernel.shell.push({"np": np, "pg": pg})
+#
+#     def shutdown_kernel(self):
+#         self.kernel_client.stop_channels()
+#         self.kernel_manager.shutdown_kernel()
 
 
 class JupyterConsoleWindow(QWidget):  # pragma: no cover:
@@ -45,25 +45,25 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.safe_close = False
 
         # console push
-        self.console.kernel_manager.kernel.shell.push(
-            {
-                "fig": self.figure,
-                "dock": self.dock,
-                "w1": self.w1,
-                "w2": self.w2,
-                "w3": self.w3,
-                "d0": self.d0,
-                "d1": self.d1,
-                "d2": self.d2,
-                "fig0": self.fig0,
-                "fig1": self.fig1,
-                "fig2": self.fig2,
-                "bar": self.bar,
-                "bec": self.figure.client,
-                "scans": self.figure.client.scans,
-                "dev": self.figure.client.device_manager.devices,
-            }
-        )
+        if self.console.inprocess is True:
+            self.console.kernel_manager.kernel.shell.push(
+                {
+                    "np": np,
+                    "pg": pg,
+                    "fig": self.figure,
+                    "dock": self.dock,
+                    "w1": self.w1,
+                    "w2": self.w2,
+                    "w3": self.w3,
+                    "d0": self.d0,
+                    "d1": self.d1,
+                    "d2": self.d2,
+                    "fig0": self.fig0,
+                    "fig1": self.fig1,
+                    "fig2": self.fig2,
+                    "bar": self.bar,
+                }
+            )
 
     def _init_ui(self):
         # Plotting window
@@ -82,9 +82,8 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self._init_dock()
 
         self.console_layout = QVBoxLayout(self.ui.widget_console)
-        self.console = JupyterConsoleWidget()
+        self.console = BECJupyterConsole(inprocess=True)
         self.console_layout.addWidget(self.console)
-        self.console.set_default_style("linux")
 
     def _init_figure(self):
         self.figure.plot(x_name="samx", y_name="bpm4d")
@@ -105,19 +104,19 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
     def _init_dock(self):
 
         self.d0 = self.dock.add_dock(name="dock_0")
-        self.fig0 = self.d0.add_widget_bec("BECFigure")
+        self.fig0 = self.d0.add_widget("BECFigure")
         self.fig0.image("eiger", vrange=(0, 100))
 
         self.d1 = self.dock.add_dock(name="dock_1", position="right")
-        self.fig1 = self.d1.add_widget_bec("BECFigure")
+        self.fig1 = self.d1.add_widget("BECFigure")
         self.fig1.plot(x_name="samx", y_name="bpm4i")
         self.fig1.plot(x_name="samx", y_name="bpm3a")
 
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
-        self.fig2 = self.d2.add_widget_bec("BECFigure", row=0, col=0)
+        self.fig2 = self.d2.add_widget("BECFigure", row=0, col=0)
         self.fig2.motor_map(x_name="samx", y_name="samy")
         self.fig2.plot(x_name="samx", y_name="bpm4i")
-        self.bar = self.d2.add_widget_bec("SpiralProgressBar", row=0, col=1)
+        self.bar = self.d2.add_widget("SpiralProgressBar", row=0, col=1)
         self.bar.set_diameter(200)
 
         self.dock.save_state()
@@ -144,7 +143,7 @@ if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)
     app.setApplicationName("Jupyter Console")
     app.setApplicationDisplayName("Jupyter Console")
-    qdarktheme.setup_theme("auto")
+    # qdarktheme.setup_theme("auto")
     icon = QIcon()
     icon.addFile(os.path.join(module_path, "assets", "terminal_icon.png"), size=QSize(48, 48))
     app.setWindowIcon(icon)

bec_widgets/widgets/dock/dock.py

@@ -33,7 +33,7 @@ class BECDock(BECConnector, Dock):
         "hide_title_bar",
         "get_widgets_positions",
         "set_title",
-        "add_widget_bec",
+        "add_widget",
         "list_eligible_widgets",
         "move_widget",
         "remove_widget",
@@ -152,47 +152,47 @@ class BECDock(BECConnector, Dock):
         """
         return list(RPCWidgetHandler.widget_classes.keys())
 
-    def add_widget_bec(
-        self,
-        widget_type: str,
-        row=None,
-        col=0,
-        rowspan=1,
-        colspan=1,
-        shift: Literal["down", "up", "left", "right"] = "down",
-    ):
-        """
-        Add a widget to the dock.
-
-        Args:
-            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
-            row(int): The row to add the widget to. If None, the widget will be added to the next available row.
-            col(int): The column to add the widget to.
-            rowspan(int): The number of rows the widget should span.
-            colspan(int): The number of columns the widget should span.
-            shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
-        """
-        if row is None:
-            row = self.layout.rowCount()
-
-        if self.layout_manager.is_position_occupied(row, col):
-            self.layout_manager.shift_widgets(shift, start_row=row)
-
-        widget = RPCWidgetHandler.create_widget(widget_type)
-        self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        self.config.widgets[widget.gui_id] = widget.config
-
-        return widget
+    # def add_widget_bec(
+    #     self,
+    #     widget_type: str,
+    #     row=None,
+    #     col=0,
+    #     rowspan=1,
+    #     colspan=1,
+    #     shift: Literal["down", "up", "left", "right"] = "down",
+    # ):
+    #     """
+    #     Add a widget to the dock.
+    #
+    #     Args:
+    #         widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+    #         row(int): The row to add the widget to. If None, the widget will be added to the next available row.
+    #         col(int): The column to add the widget to.
+    #         rowspan(int): The number of rows the widget should span.
+    #         colspan(int): The number of columns the widget should span.
+    #         shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
+    #     """
+    #     if row is None:
+    #         row = self.layout.rowCount()
+    #
+    #     if self.layout_manager.is_position_occupied(row, col):
+    #         self.layout_manager.shift_widgets(shift, start_row=row)
+    #
+    #     widget = RPCWidgetHandler.create_widget(widget_type)
+    #     self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
+    #     self.config.widgets[widget.gui_id] = widget.config
+    #
+    #     return widget
 
     def add_widget(
         self,
-        widget: QWidget,
+        widget: BECConnector | str,
         row=None,
         col=0,
         rowspan=1,
         colspan=1,
         shift: Literal["down", "up", "left", "right"] = "down",
-    ):
+    ) -> BECConnector:
         """
         Add a widget to the dock.
 
@@ -210,8 +210,17 @@ class BECDock(BECConnector, Dock):
         if self.layout_manager.is_position_occupied(row, col):
             self.layout_manager.shift_widgets(shift, start_row=row)
 
+        if isinstance(widget, str):
+            widget = RPCWidgetHandler.create_widget(widget)
+        else:
+            widget = widget
+
         self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        self.config.widgets[widget.gui_id] = widget.config
+
+        if hasattr(widget, "config"):
+            self.config.widgets[widget.gui_id] = widget.config
+
+        return widget
 
     def move_widget(self, widget: QWidget, new_row: int, new_col: int):
         """

bec_widgets/widgets/dock/dock_area.py

@@ -171,9 +171,7 @@ class BECDockArea(BECConnector, DockArea):
                 dock.show_title_bar()
 
         if widget is not None and isinstance(widget, str):
-            dock.add_widget_bec(
-                widget_type=widget, row=row, col=col, rowspan=rowspan, colspan=colspan
-            )
+            dock.add_widget(widget=widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         elif widget is not None and isinstance(widget, QWidget):
             dock.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         if self._instructions_visible:

bec_widgets/widgets/jupyter_console/jupyter_console.py

@@ -0,0 +1,72 @@
+from bec_ipython_client.main import BECIPythonClient
+from qtconsole.inprocess import QtInProcessKernelManager
+from qtconsole.manager import QtKernelManager
+from qtconsole.rich_jupyter_widget import RichJupyterWidget
+from qtpy.QtWidgets import QApplication, QMainWindow
+
+
+class BECJupyterConsole(RichJupyterWidget):  # pragma: no cover:
+    def __init__(self, inprocess: bool = False):
+        super().__init__()
+
+        self.inprocess = None
+
+        self.kernel_manager, self.kernel_client = self._init_kernel(inprocess=inprocess)
+        self.set_default_style("linux")
+        self._init_bec()
+
+    def _init_kernel(self, inprocess: bool = False, kernel_name: str = "python3"):
+        self.inprocess = inprocess
+        if inprocess is True:
+            print("starting inprocess kernel")
+            kernel_manager = QtInProcessKernelManager()
+        else:
+            kernel_manager = QtKernelManager(kernel_name=kernel_name)
+        kernel_manager.start_kernel()
+        kernel_client = kernel_manager.client()
+        kernel_client.start_channels()
+        return kernel_manager, kernel_client
+
+    def _init_bec(self):
+        if self.inprocess is True:
+            self._init_bec_inprocess()
+        else:
+            self._init_bec_kernel()
+
+    def _init_bec_inprocess(self):
+        self.client = BECIPythonClient()
+        self.client.start()
+
+        self.kernel_manager.kernel.shell.push(
+            {
+                "bec": self.client,
+                "dev": self.client.device_manager.devices,
+                "scans": self.client.scans,
+            }
+        )
+
+    def _init_bec_kernel(self):
+        self.execute(
+            """
+            from bec_ipython_client.main import BECIPythonClient
+            bec = BECIPythonClient()
+            bec.start()
+            dev = bec.device_manager.devices if bec else None
+            scans = bec.scans if bec else None
+            """
+        )
+
+    def shutdown_kernel(self):
+        self.kernel_client.stop_channels()
+        self.kernel_manager.shutdown_kernel()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    app = QApplication(sys.argv)
+    win = QMainWindow()
+    win.setCentralWidget(BECJupyterConsole(True))
+    win.show()
+
+    sys.exit(app.exec_())

{bec_widgets-0.56.3.dist-info → bec_widgets-0.57.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.56.3
+Version: 0.57.1
 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-0.56.3.dist-info → bec_widgets-0.57.1.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=RF2JeGh8tG09DyAOwEu991IZy3C8Vm6lI8O_4Dr9B9Q,12239
 .pylintrc,sha256=OstrgmEyP0smNFBKoIN5_26-UmNZgMHnbjvAWX0UrLs,18535
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=kanSLoK5uphXdlmpcQqyPg1Z31HfUlC-tbK4nmYvz8o,6924
+CHANGELOG.md,sha256=zxHMzEXHUbEgqxmsrAtt2A-iiShgClvqzI5lZKRqoX4,6824
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=V34V-R1GQv2uDyzy9qDYTnNNe2dbkeeDVpFI-Q8GSkU,1135
+PKG-INFO,sha256=3KI7EdkH96oYBSsLvSfLCot3XuI2m8AgiRHo3zXUrRo,1135
 README.md,sha256=y4jB6wvArS7N8_iTbKWnSM_oRAqLA2GqgzUR-FMh5sU,2645
-pyproject.toml,sha256=zn3vc-ka-y-TAwav3-etEpelzU-jsqo1KOzt55_6Ucw,1803
+pyproject.toml,sha256=-9xY8HWFrm3iGS29r-3dRMXdM-LJecifdKwnmvYoWPU,1803
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -16,8 +16,8 @@ bec_widgets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/assets/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqgdX7a00nM3igZdc20pkYM,1747017
 bec_widgets/assets/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uftXCH9ws,3889
 bec_widgets/cli/__init__.py,sha256=tLD8HWgyURhMjYlKZ43pBu-qvGD1LI5o3n3rEieg-70,43
-bec_widgets/cli/auto_updates.py,sha256=RFc9sbNE9Ec8K3U1DSrLzwUweM3W51Lmcp9D2gSt2e4,4696
-bec_widgets/cli/client.py,sha256=tQIaQcNnOkF3M-Ym4_U7vMwpYWgVPEGAJY4ibnlPLgM,52909
+bec_widgets/cli/auto_updates.py,sha256=8x4_SrD8Hh1RbrUWXLfisw6X5v8Mij2DiTfjvn9dkUw,4692
+bec_widgets/cli/client.py,sha256=_39klWIob_MdCJ8mxjXhJ_1z56qVCoyeMH0Ji2uEiik,52876
 bec_widgets/cli/client_utils.py,sha256=gxa9TpYCWa0a7jsrMaWv_FQOnfeqP-xht8PYbhcEgys,10802
 bec_widgets/cli/generate_cli.py,sha256=tBt-F4Xccg9Pj2zuDEGHd0Ho1fKLfCf3PuSa8KmelQk,4431
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -25,7 +25,7 @@ bec_widgets/cli/rpc_wigdet_handler.py,sha256=OXHoiDFJPzbQ5RO0bzIX5aUXeMMlJTwAiTm
 bec_widgets/cli/server.py,sha256=rsj31Vsx6ayThNe4PQelQFahGjYXFZjfrNyB2fnm6Ro,5737
 bec_widgets/examples/__init__.py,sha256=WWQ0cu7m8sA4Ehy-DWdTIqSISjaHsbxhsNmNrMnhDZU,202
 bec_widgets/examples/jupyter_console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/examples/jupyter_console/jupyter_console_window.py,sha256=O_jcU7DY39PCrjVSJ7YJtTNSj8-se_AvzsgEiVqmKk8,5266
+bec_widgets/examples/jupyter_console/jupyter_console_window.py,sha256=pfwbMfvXu0FdX-a6SdprfOEGxG-IgsuySnYy3l9fwIM,5328
 bec_widgets/examples/jupyter_console/jupyter_console_window.ui,sha256=2A2mNTUMZBYygz8K4qWzrcjnNqZBMVyeHm26iLZVRWI,1473
 bec_widgets/examples/motor_movement/__init__.py,sha256=LzPJkxLAxOsZCbXR-fRCPmeYobp7Yqds6tDxW4W1gSw,214
 bec_widgets/examples/motor_movement/motor_control_compilations.py,sha256=8rpA7a2xVZTDMrx7YQIj3IJew78J1gcVMkHvloS0U_Q,9055
@@ -48,8 +48,8 @@ bec_widgets/utils/widget_io.py,sha256=f36198CvT_EzWQ_cg2G-4tRRsaMdJ3yVqsZWKJCQEf
 bec_widgets/utils/yaml_dialog.py,sha256=cMVif-39SB9WjwGH5FWBJcFs4tnfFJFs5cacydRyhy0,1853
 bec_widgets/widgets/__init__.py,sha256=LKgIuY3CI-NHCa_bY9pThYhxLH0MHDo8iNEJDDVIVmw,172
 bec_widgets/widgets/dock/__init__.py,sha256=B7foHt02gnhM7mFksa7GJVwT7n0j_JvYDCt6wc6XR5g,61
-bec_widgets/widgets/dock/dock.py,sha256=fUb8VTYU2yS5N5KOUf1X1m_F1kpDullX3m71llRbBP8,8653
-bec_widgets/widgets/dock/dock_area.py,sha256=8E-rBZxM7pE423jPaXMRKb1YGlAR9oAQvJubNDpemSI,7361
+bec_widgets/widgets/dock/dock.py,sha256=kdX0ZbuUdx6XETZ1NUgzBWlee_Q7JcN3fXpARDAlre8,8955
+bec_widgets/widgets/dock/dock_area.py,sha256=MtuT6_LYCPQ0TnKBtO4_4ReA9L8tZZrroUjkzEQspdk,7322
 bec_widgets/widgets/figure/__init__.py,sha256=3hGx_KOV7QHCYAV06aNuUgKq4QIYCjUTad-DrwkUaBM,44
 bec_widgets/widgets/figure/figure.py,sha256=OzeKZme89JnzMcKT1sACnyw951EtRoSUALl58upY6b4,29762
 bec_widgets/widgets/figure/plots/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -63,6 +63,8 @@ bec_widgets/widgets/figure/plots/motor_map/motor_map.py,sha256=HKRbt8sD8fmzpYcEW
 bec_widgets/widgets/figure/plots/waveform/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/waveform/waveform.py,sha256=k6Lh08V00N9gATppaLgaSaij4Husf8sYU_HXTvF3oB4,21664
 bec_widgets/widgets/figure/plots/waveform/waveform_curve.py,sha256=9q7nJfyH8y9rWw_AIOd6tk7cbckoAGNLHv2oHEKCCyo,7229
+bec_widgets/widgets/jupyter_console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/jupyter_console/jupyter_console.py,sha256=ioLYJL31RdBoAOGFSS8PVSnUhkWPWmLC3tiKp7CouO8,2251
 bec_widgets/widgets/motor_control/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/motor_control/motor_control.py,sha256=UrLCvp3J6uiVxWV2jqQbsA2nsMf9s_rrDH2KjnUm-bk,7890
 bec_widgets/widgets/motor_control/motor_table/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -105,17 +107,23 @@ docs/introduction/introduction.md,sha256=wp7jmhkUtJnSnEnmIAZGUcau_3-5e5-FohvZb63
 docs/user/customisation.md,sha256=Og0NuUsTs8HdwKtpHnycGmH8wCqOeYgj2ozlYRJ-Drk,249
 docs/user/user.md,sha256=uCTcjclIi6rdjYRQebko6bWFEVsjyfshsVU3BDYrC-Y,1403
 docs/user/api_reference/api_reference.md,sha256=q2Imc48Rq6GcAP0R4bS3KuW5ptZZdsV4wxGJb3JJQHg,174
-docs/user/applications/applications.md,sha256=hs8WKVuxBENV2Q7m4wN8wmSI_B3JBYrSYS1IYdbyoWg,147
-docs/user/getting_started/getting_started.md,sha256=BagVhtCSoLgYlVaaYOep3KT5r_8DjtQKYj2g-PoU7uw,346
-docs/user/getting_started/installation.md,sha256=Rt7O2VI5LRrrRpru1YSb8KAd92znFhHJFs7vhpmHIXQ,1239
+docs/user/applications/applications.md,sha256=yOECfaYRUEDIxF-O0duOwSJlG4f93RylrpMjbw1-8Dg,100
+docs/user/getting_started/command_line_introduction.md,sha256=qTGXnxyRajxv7AXbZaPVVOA5D6zBnK0M0ZF0bniymEM,8683
+docs/user/getting_started/getting_started.md,sha256=zYzoHC8xvHF5wDK66thkdamf8mKKNEudiA-fCOzbedM,358
+docs/user/getting_started/gui_complex_gui.gif,sha256=ovv9u371BGG5GqhzyBMl4mvqMHLfJS0ylr-dR0Ydwtw,6550393
+docs/user/getting_started/installation.md,sha256=nBl2Hfvo6ua3-tVZn1B-UG0hCTlrFY6_ibXHWnXeegs,1135
+docs/user/widgets/bec_figure.md,sha256=Ph8ajmESk71Y9nBJsLKLiN-YvGJwN4FdN_Rs3jcObwE,5068
+docs/user/widgets/image_plot.gif,sha256=_mVFhMTXGqwDOcEtrBHMZj5Thn2sLhDAHEeL2XyHN-s,14098977
 docs/user/widgets/motor.gif,sha256=FtaWdRHx4UZaGJPpq8LNhMMgX4PFcAB6IZ93JCMEh_w,2280719
+docs/user/widgets/progress_bar.gif,sha256=5jh0Zw2BBGPuNxszV1DBLJCb4_6glIRX-U2ABjnsK2k,5263592
 docs/user/widgets/scatter_2D.gif,sha256=yHpsuAUseMafJjI_J5BcOhmE3nu9VFn_Xm9XHzJaH5I,13188862
+docs/user/widgets/spiral_progress_bar.md,sha256=fnkg1cRM9y49MwYVXDukHGu80SXHxsI9mU9ZfDkENPs,1114
 docs/user/widgets/w1D.gif,sha256=tuHbleJpl6bJFNNC2OdndF5LF7IyfvlkFCMGZajrQPs,622773
-docs/user/widgets/widgets.md,sha256=vIfilXMyE1iPQMQXGH8wEjXWsFI6GPI0Cn9VQg5lLwI,1879
+docs/user/widgets/widgets.md,sha256=NFdqTlLTHXueErLzvw4wHwTUrzRSEuRelb1fiT4PySg,352
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/end-2-end/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/end-2-end/conftest.py,sha256=b5Yebbj8C1-IcXq23XGbOnXF0kOZD_Po46Z-p4cBwfs,1346
-tests/end-2-end/test_bec_dock_rpc_e2e.py,sha256=E2XR6cgmyrHknbe-97LhuSAGlsPguc5VOQ2-Q5Apvm0,9843
+tests/end-2-end/test_bec_dock_rpc_e2e.py,sha256=5W1uczZV6AqzjY6rHMR8GJDQuGpImtz-BGqq_cdqjbE,9823
 tests/end-2-end/test_bec_figure_rpc_e2e.py,sha256=X8lQLx2NsB6-nU61IhVtAw1-pJ4A2qFgx5PxOWC0V7Q,5527
 tests/end-2-end/test_rpc_register_e2e.py,sha256=M7sSq3us2yQIW5tAIFOFfBULatZTQNLdt0frh1bINts,1595
 tests/unit_tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -123,7 +131,7 @@ tests/unit_tests/client_mocks.py,sha256=ErrklY7446jXE2_XGKebs_a-2Pqif5ECOPvxVAKR
 tests/unit_tests/conftest.py,sha256=KrnktXPWmZhnKNue-xGWOLD1XGEvdz9Vf7V2eO3XQ3A,596
 tests/unit_tests/test_bec_connector.py,sha256=f2XXGGw3NoZLIUrDuZuEWwF_ttOYmmquCgUrV5XkIOY,1951
 tests/unit_tests/test_bec_dispatcher.py,sha256=rYPiRizHaswhGZw55IBMneDFxmPiCCLAZQBqjEkpdyY,3992
-tests/unit_tests/test_bec_dock.py,sha256=gvtNkkCPrDFY_1qZ53ZXChdgmQFSwwQrr1VeZC5ybKc,3610
+tests/unit_tests/test_bec_dock.py,sha256=x1mgeNvgu9yVuZvgUkfD60F7FLANGQsXSBhF3n8kyIM,3606
 tests/unit_tests/test_bec_figure.py,sha256=xYAftY8bI_EH-SlNPD0Tjd7FS_47ouZ1E4hrpjPt7O4,8002
 tests/unit_tests/test_bec_motor_map.py,sha256=AfD_9-x6VV3TPnkQgNfFYRndPHDsGx-a_YknFeDr6hc,4588
 tests/unit_tests/test_client_utils.py,sha256=eViJ1Tz-HX9TkMvQH6W8cO-c3_1I8bUc4_Yen6LOc0E,830
@@ -142,7 +150,7 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.56.3.dist-info/METADATA,sha256=V34V-R1GQv2uDyzy9qDYTnNNe2dbkeeDVpFI-Q8GSkU,1135
-bec_widgets-0.56.3.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-bec_widgets-0.56.3.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.56.3.dist-info/RECORD,,
+bec_widgets-0.57.1.dist-info/METADATA,sha256=3KI7EdkH96oYBSsLvSfLCot3XuI2m8AgiRHo3zXUrRo,1135
+bec_widgets-0.57.1.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+bec_widgets-0.57.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.57.1.dist-info/RECORD,,

docs/user/applications/applications.md

@@ -8,7 +8,3 @@
 maxdepth: 1
 hidden: true
 ---
-
-apps/motor_app
-apps/plot_app
-apps/modular_app

docs/user/getting_started/command_line_introduction.md

@@ -0,0 +1,87 @@
+(user.command_line_introduction)=
+# Command Line Introduction
+In order to use BEC Widgets as a plotting tool for BEC, it needs to be [installed](#user.installation) in the same python environment as the BECIpythonClient. If that is the case, it will automatically launch a GUI and assign the control of the GUI to the `gui` object in the client. The GUI backend will also be automatically connect to the BEC server, giving access to all information on the server and allowing the user to visualize the data in real-time.
+
+## BECDockArea
+The `gui` object represents the top level of hierarchy in BEC Widgets. It is a [`BECDockArea`](/api_reference/_autosummary/bec_widgets.cli.client.BECDockArea) based on the [pyqtgraph.dockarea](https://pyqtgraph.readthedocs.io/en/latest/api_reference/dockarea.html). The GUI can be further composed of multiple [`BECDock`](/api_reference/_autosummary/bec_widgets.cli.client.BECDock)s that can be detached and attached to the main area. These docks allow users to freely arrange and customize the widgets they add to the gui, giving them the necessary freedom to design the user interface they desire.
+
+## Widgets
+Widgets are the building blocks of the BEC Widgets framework. They are the visual components that allow users to interact with the data and control the behavior of the application. Each dock can contain multiple widgets, although we recommend using a direct mapping of a single widget to a dock. We currently support two type of widgets:
+- [`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure): A widget that can be used to visualize data from BEC. It is automatically connected to the BEC server and can be used to plot data from BEC.
+- [`SpiralProgressBar`](/api_reference/_autosummary/bec_widgets.cli.client.SpiralProgressBar): A custom widget that can be used to show progress in a spiral shape.
+
+**BECFigure**
+The [`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure) widget is one of the core widgets developed for BEC and designed to be flexible and can be used to visualize different types of data. It can be used to visualize [1D Waveform](user.widgets.waveform_1d), [2D Scatter Plot](user.widgets.scatter_2d), [Motor Position Map](user.widgets.motor_map) and 2D image data. As mentioned before, starting the BECIPythonClient will automatically launch a `gui` with a single dock area and a BECFigure widget attached to it. This widget is accessible via the `fig` object from the client directly. We also provide two methods [`plot()`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.plot), [`image()`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.image) and [`motor_map()`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.motor_map) as shortcuts to add a plot, image or motor map to the BECFigure.
+
+**Waveform Plot** 
+ The [`BECWaveForm`](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform) is a widget that can be used to visualize 1D waveform data, i.e. to plot data of a monitor against a motor position. The method [`plot()`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.plot) of BECFigure adds a BECWaveForm widget to the figure, and returns the plot object. 
+
+```python
+plt = fig.add_plot('samx', 'bpm4i')
+```
+Here, we assign the plot to the object `plt`. We can now use this object to further customize the plot, e.g. changing the title ([`set_title()`](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform.rst#bec_widgets.cli.client.BECWaveform.set_title)), axis labels ([`set_x_label()`](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform.rst#bec_widgets.cli.client.BECWaveform.set_x_label)) or limits ([`set_x_lim()`](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform.rst#bec_widgets.cli.client.BECWaveform.set_x_lim)). We invite you to explore the API of the BECWaveForm in the [documentation](user.widgets.waveform_1d) or directly in the command line.
+
+**Scatter Plot**
+The [`BECWaveForm`](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveForm) widget can also be used to visualize 2D scatter plots. More details on setting up the scatter plot are available in the widget documentation of the [scatter plot](user.widgets.scatter_2d).
+
+**Motor Map**
+The [`BECMotorMap`](/api_reference/_autosummary/bec_widgets.cli.client.BECMotorMap) widget can be used to visualize the position of motors. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans. More details on setting up the motor map are available in the widget documentation of the [motor map](user.widgets.motor_map).
+
+**Image Plot**
+The [`BECImageItem`](/api_reference/_autosummary/bec_widgets.cli.client.BECImageItem) widget can be used to visualize 2D image data for example a camera. More details on setting up the image plot are available in the widget documentation of the [image plot](user.widgets.image)
+
+### Useful Commands
+We recommend users to explore the API of the widgets by themselves since we assume that the user interface is supposed to be intuitive and self-explanatory. We appreciate feedback from user in order to constantly improve the experience and allow easy access to the gui, widgets and their functionality. We recommend checking the [API documentation](user.api_reference), but also by using BEC Widgets, exploring the available functions and check their dockstrings.
+```python
+gui.add_dock? # shows the dockstring of the add_dock method
+```
+
+In addition, we list below a few useful commands that can be used to interface with the widgets:
+
+```python
+gui.panels # returns a dictionary of all docks in the gui
+gui.add_dock() # adds a new dock to the gui
+
+dock = gui.panels['dock_2']
+dock.add_widget_bec('BECFigure') # adds a new widget of BECFigure to the dock
+dock.widget_list # returns a list of all widgets in the dock
+
+figure = dock.widget_list[0] # assigns the created BECFigure to figure
+plt = figure.add_plot('samx', 'bpm4i') # adds a BECWaveForm plot to the figure
+plt.curves # returns a list of all curves in the plot
+```
+
+We note that commands can also be chained. For example, `gui.add_dock().add_widget_bec('BECFigure')` will add a new dock to the gui and add a new widget of `BECFigure` to the dock. 
+
+## Composing a larger GUI
+The example given above introduces BEC Widgets with its different components, and provides an overview of how to interact with the widgets. Nevertheless, another power aspect of BEC Widgets lies in the ability to compose a larger GUI with multiple docks and widgets. This section aims to provide a tutorial like guide on how to compose a more complex GUI that (A) live-plots a 1D waveform, (B) plots data from a camera, and (C) tracks the positions of two motors.
+Let's assume BEC was just started and the `gui` object is available in the client. A single dock is already attached together with a BEC Figure. Let's add the 1D waveform to this dock, change the color of the line to white and add the title *1D Waveform* to the plot.
+
+```python
+plt = fig.add_plot('samx', 'bpm4i')
+plt.curves[0].set_color(color="white")
+plt.set_title('1D Waveform')
+```
+
+Next, we add 2 new docks to the gui, one to plot the data of a camera and one to track the positions of two motors. 
+```ipython
+cam_widget= gui.add_dock(name="cam_dock").add_widget_bec('BECFigure').image("eiger")
+motor_widget = gui.add_dock(name="mot_dock").add_widget_bec('BECFigure').motor_map("samx", "samy")
+```
+Note, we chain commands here which is possible since the `add_dock` and `add_widget_bec` methods return the dock and the widget respectively. We can now further customize the widgets by changing the title, axis labels, etc.
+
+```python
+cam_widget.set_title("Camera Image Eiger")
+cam_widget.set_vrange(vmin=0, vmax=100)
+```
+As a final step, we can now add also a SpiralProgressBar to a new dock, and perform a grid_scan with the motors *samx* and *samy*.
+As you see in the example below, all docks are arranged below each other. This is the default behavior of the `add_dock` method. However, the docks can be freely arranged by drag and drop as desired by the user. We invite you to explore this by yourself following the example in the video, and build your custom GUI with BEC Widgets.
+
+```python
+prog_bar = gui.add_dock(name="prog_dock").add_widget_bec('SpiralProgressBar')
+prog_bar.set_line_widths(15)
+scans.grid_scan(dev.samy, -2, 2, 10, dev.samx, -5, 5, 10, exp_time=0.1, relative=False)
+```
+
+![gui_complex_gui](./gui_complex_gui.gif)
+

docs/user/getting_started/getting_started.md

@@ -8,5 +8,6 @@ maxdepth: 2
 hidden: true
 ---
 
-getting_started/installation
+installation/
+command_line_introduction/
 ```

docs/user/getting_started/installation.md

@@ -1,7 +1,5 @@
 (user.installation)=
 # Installation
-
-
 **Prerequisites**
 
 Before installing BEC Widgets, please ensure the following requirements are met:
@@ -11,25 +9,14 @@ Before installing BEC Widgets, please ensure the following requirements are met:
 
 **Standard Installation**
 
-Install BEC Widgets using the pip package manager. Open your terminal and execute:
-
-```bash
-pip install bec_widgets PyQt6
-```
-
-This command installs BEC Widgets along with its dependencies, including the default PyQt6.
-
-**Selecting a PyQt Version**
-
-BEC Widgets supports both PyQt5 and PyQt6. To install a specific version, use:
+To install BEC Widgets using the pip package manager, execute the following command in your terminal for getting the default PyQT6 version in your python environment:
 
-For PyQt6:
 
 ```bash
 pip install bec_widgets[pyqt6]
 ```
 
-For PyQt5:
+In case you want to use PyQt5, you can install it by using the following command:
 
 ```bash
 pip install bec_widgets[pyqt5]

docs/user/widgets/bec_figure.md

@@ -0,0 +1,100 @@
+(user.widgets.bec_figure)=
+# BECFigure
+[`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure) is a widget that provides a graphical user interface for creating and managing plots. It is a versatile tool that allows users to create a wide range of plots, from simple 1D waveforms to complex 2D scatter plots. BECFigure is designed to be user-friendly and interactive, enabling users to customize plots and visualize data in real-time.
+In the following, we describe 4 different type of widgets thaat are available in BECFigure. 
+
+(user.widgets.waveform_1d)=
+## [1D Waveform Widget](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform)
+
+**Purpose:** This widget provides a straightforward visualization of 1D data. It is particularly useful for plotting positioner movements against detector readings, enabling users to observe correlations and patterns in a simple, linear format.
+
+**Key Features:**
+- Real-time plotting of positioner versus detector values.
+- Interactive controls for zooming and panning through the data.
+- Customizable visual elements such as line color and style.
+
+**Example of Use:**
+![Waveform 1D](./w1D.gif)
+
+**Code example**
+The following code snipped demonstrates how to create a 1D waveform plot using BEC Widgets within BEC. More details about BEC Widgets in BEC can be found in the getting started section within the [introduction to the command line.](user.command_line_introduction)
+```python
+# adds a new dock, a new BECFigure and a BECWaveForm to the dock
+plt = gui.add_dock().add_widget('BECFigure').plot('samx', 'bpm4i')
+# add a second curve to the same plot 
+plt.add_curve_scan('samx', 'bpm3i')
+plt.set_title("Gauss plots vs. samx")
+plt.set_x_label("Motor X")
+plt.set_y_label("Gauss Signal (A.U.")
+```
+Note, the return value of the simulated devices *bpm4i* and *bpm3i* may not be gaussian signals, but they can be easily configured with the code snippet below. For more details please check the documentation of the [simulation](https://bec.readthedocs.io/en/latest/developer/devices/bec_sim.html).
+```python
+# bpm4i uses GaussianModel and samx as a reference; default settings
+dev.bpm4i.sim.select_sim_model("GaussianModel")
+# bpm3i uses StepModel and samx as a reference; default settings
+dev.bpm3i.sim.select_sim_model("StepModel")
+```
+
+(user.widgets.scatter_2d)=
+## [2D Scatter Plot](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform)
+
+**Purpose:** The 2D scatter plot widget is designed for more complex data visualization. It employs a false color map to represent a third dimension (z-axis), making it an ideal tool for visualizing multidimensional data sets.
+
+**Key Features:**
+
+- 2D scatter plot with color-coded data points based on a third variable (two positioners for x/y vs. one detector for colormap).
+- Interactive false color map for enhanced data interpretation.
+- Tools for selecting and inspecting specific data points.
+
+**Example of Use:**
+![Waveform 1D](./scatter_2D.gif)
+
+**Code example**
+The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
+```python
+# adds a new dock, a new BECFigure and a BECWaveForm to the dock
+plt = gui.add_dock().add_widget('BECFigure').add_plot('samx', 'samy', 'bpm4i')
+```
+
+(user.widgets.motor_map)=
+## [Motor Position Map](/api_reference/_autosummary/bec_widgets.cli.client.BECMotorMap)
+
+**Purpose:** A specialized component derived from the Motor Alignment Tool. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans.
+
+**Key Features:**
+- Real-time tracking of motor positions.
+- Visual representation of motor trajectories, aiding in alignment tasks.
+
+**Example of Use:**
+![Waveform 1D](./motor.gif)
+
+**Code example**
+The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
+```python
+# add a motor map to the gui
+mot_map = gui.add_dock().add_widget('BECFigure').motor_map('samx', 'samy')
+# change the number of points displayed
+```
+
+(user.widgets.image_2d)=
+## [Image Plot](/api_reference/_autosummary/bec_widgets.cli.client.BECImageItem)
+
+**Purpose:** A versatile widget for visualizing 2D image data, such as camera images. It provides a detailed representation of image data, with an attached color and scale bar to dynamically adjust the image display.
+
+**Key Features:**
+- Live-plotting of 2D image data from cameras (*if data stream is available in BEC*).
+- Color maps and scale bars for customizing image display.
+**Example of Use:**
+![Image 2D](./image_plot.gif)
+
+**Code example**
+The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
+```python
+# add a camera view for the eiger camera to the gui
+cam_widget = gui.add_dock().add_widget('BECFigure').image('eiger')
+# set the title of the camera view
+cam_widget.set_title("Camera Image Eiger")
+# change the color map range, e.g. from 0 to 100, per default it is autoscaling
+# Note, the simulation has hot pixels on the detector
+cam_widget.set_vrange(vmin=0, vmax=100)
+```

docs/user/widgets/spiral_progress_bar.md

@@ -0,0 +1,21 @@
+(user.widgets.spiral_progress_bar)=
+# [Spiral Progress Bar](/api_reference/_autosummary/bec_widgets.cli.client.SpiralProgressBar)
+**Purpose** The Spiral Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The widget is designed to be used in applications where the progress of a task is represented as a percentage. The Spiral Progress Bar widget is a part of the BEC Widgets library and can be controlled directly using its API, or hooked up to the progress of a device readback or scan.
+
+**Key Features:**
+
+- circular progress bar to show updates on the progress of a task.
+- hooks to update the progress bar from a device readback or scan.
+- multiple progress rings to show different tasks in parallel.
+
+**Example of Use:**
+![SpiralProgressBar](./progress_bar.gif)
+
+**Code example**
+The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
+```python
+# adds a new dock with a spiral progress bar
+progress = gui.add_dock().add_widget("SpiralProgressBar")
+# customize the size of the ring
+progress.set_line_width(20)
+```

docs/user/widgets/widgets.md

@@ -1,41 +1,15 @@
 (user.widgets)=
 # Widgets
-
-## Visualization Widgets
-
 BEC Widgets includes a variety of visualization widgets designed to cater to diverse data representation needs in beamline experiments. These widgets enhance the user experience by providing intuitive and interactive data visualizations.
 
-### 1D Waveform Widget
-
-**Purpose:** This widget provides a straightforward visualization of 1D data. It is particularly useful for plotting positioner movements against detector readings, enabling users to observe correlations and patterns in a simple, linear format.
-
-**Key Features:**
-- Real-time plotting of positioner versus detector values.
-- Interactive controls for zooming and panning through the data.
-- Customizable visual elements such as line color and style.
-
-**Example of Use:**
-![Waveform 1D](./w1D.gif)
-### 2D Scatter Plot
-
-**Purpose:** The 2D scatter plot widget is designed for more complex data visualization. It employs a false color map to represent a third dimension (z-axis), making it an ideal tool for visualizing multidimensional data sets.
-
-**Key Features:**
-
-- 2D scatter plot with color-coded data points based on a third variable (two positioners for x/y vs. one detector for colormap).
-- Interactive false color map for enhanced data interpretation.
-- Tools for selecting and inspecting specific data points.
-
-**Example of Use:**
-![Waveform 1D](./scatter_2D.gif)
-### Motor Position Map
+```{toctree}
+---
+maxdepth: 2
+hidden: false
+---
 
-**Purpose:** A specialized component derived from the Motor Alignment Tool. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans.
+bec_figure/
+spiral_progress_bar/
+```
 
-**Key Features:**
-- Real-time tracking of motor positions.
-- Visual representation of motor trajectories, aiding in alignment tasks.
-- Ability to record and recall specific motor positions for repetitive tasks.
 
-**Example of Use:**
-![Waveform 1D](./motor.gif)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.56.3"
+version = "0.57.1"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -38,9 +38,9 @@ def test_rpc_add_dock_with_figure_e2e(rpc_server_dock, qtbot):
     assert len(dock_server.docks) == 3
 
     # Add 3 figures with some widgets
-    fig0 = d0.add_widget_bec("BECFigure")
-    fig1 = d1.add_widget_bec("BECFigure")
-    fig2 = d2.add_widget_bec("BECFigure")
+    fig0 = d0.add_widget("BECFigure")
+    fig1 = d1.add_widget("BECFigure")
+    fig2 = d2.add_widget("BECFigure")
 
     assert len(dock_server.docks) == 3
     assert len(dock_server.docks["dock_0"].widgets) == 1
@@ -166,7 +166,7 @@ def test_spiral_bar(rpc_server_dock):
 
     d0 = dock.add_dock(name="dock_0")
 
-    bar = d0.add_widget_bec("SpiralProgressBar")
+    bar = d0.add_widget("SpiralProgressBar")
     assert bar.__class__.__name__ == "SpiralProgressBar"
 
     bar.set_number_of_bars(5)
@@ -188,7 +188,7 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
 
     d0 = dock.add_dock("dock_0")
 
-    d0.add_widget_bec("SpiralProgressBar")
+    d0.add_widget("SpiralProgressBar")
 
     client = rpc_server_dock.client
     dev = client.device_manager.devices

tests/unit_tests/test_bec_dock.py

@@ -58,7 +58,7 @@ def test_bec_dock_area_add_remove_dock(bec_dock_area, qtbot):
 
 def test_add_remove_bec_figure_to_dock(bec_dock_area):
     d0 = bec_dock_area.add_dock()
-    fig = d0.add_widget_bec("BECFigure")
+    fig = d0.add_widget("BECFigure")
     plt = fig.plot(x_name="samx", y_name="bpm4i")
     im = fig.image("eiger")
     mm = fig.motor_map("samx", "samy")