bec-widgets 0.99.8__py3-none-any.whl → 0.99.9__py3-none-any.whl

docs/user/widgets/device_input/device_input.md

@@ -1,100 +0,0 @@
-(user.widgets.device_input)=
-
-# Device Input Widgets
-
-````{tab} Overview
-
-The `Device Input Widgets` consist of two primary widgets: `DeviceLineEdit` and `DeviceComboBox`. Both widgets are designed to facilitate the selection of devices within the BEC environment, allowing users to filter, search, and select devices dynamically. These widgets are highly customizable and can be integrated into a GUI either through direct code instantiation or by using `QtDesigner`.
-
-## DeviceLineEdit
-The `DeviceLineEdit` widget provides a line edit interface with autocomplete functionality for device names, making it easier for users to quickly search and select devices.
-
-## DeviceComboBox
-The `DeviceComboBox` widget offers a dropdown interface for device selection, providing a more visual way to browse through available devices.
-
-## Key Features:
-- **Device Filtering**: Both widgets allow users to filter devices by their class names, ensuring that only relevant devices are shown.
-- **Default Device Setting**: Users can set a default device to be pre-selected when the widget is initialized.
-- **Real-Time Autocomplete (LineEdit)**: The `DeviceLineEdit` widget supports real-time autocomplete, helping users find devices faster.
-- **Dropdown Selection (ComboBox)**: The `DeviceComboBox` widget displays devices in a dropdown list, making selection straightforward.
-- **QtDesigner Integration**: Both widgets can be added as custom widgets in `QtDesigner` or instantiated directly in code.
-
-````
-
-````{tab} Examples
-
-Both `DeviceLineEdit` and `DeviceComboBox` can be integrated within a GUI application through direct code instantiation or by using `QtDesigner`. Below are examples demonstrating how to create and use these widgets.
-
-
-## Example 1 - Creating a DeviceLineEdit in Code
-
-In this example, we demonstrate how to create a `DeviceLineEdit` widget in code and customize its behavior.
-
-```python
-from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
-from bec_widgets.widgets.device_line_edit import DeviceLineEdit
-
-class MyGui(QWidget):
-    def __init__(self):
-        super().__init__()
-        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
-
-        # Create and add the DeviceLineEdit to the layout
-        self.device_line_edit = DeviceLineEdit(device_filter="Motor")
-        self.layout().addWidget(self.device_line_edit)
-
-# Example of how this custom GUI might be used:
-app = QApplication([])
-my_gui = MyGui()
-my_gui.show()
-app.exec_()
-```
-
-## Example 2 - Creating a DeviceComboBox in Code
-
-Similarly, here is an example of creating a `DeviceComboBox` widget in code and customizing its behavior.
-
-```python
-from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
-from bec_widgets.widgets.device_combo_box import DeviceComboBox
-
-class MyGui(QWidget):
-    def __init__(self):
-        super().__init__()
-        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
-
-        # Create and add the DeviceComboBox to the layout
-        self.device_combo_box = DeviceComboBox(device_filter="Motor")
-        self.layout().addWidget(self.device_combo_box)
-
-# Example of how this custom GUI might be used:
-app = QApplication([])
-my_gui = MyGui()
-my_gui.show()
-app.exec_()
-```
-
-## Example 3 - Setting Default Device
-
-Both `DeviceLineEdit` and `DeviceComboBox` allow you to set a default device that will be selected when the widget is initialized.
-
-```python
-# Set default device for DeviceLineEdit
-self.device_line_edit.set_default_device("motor1")
-
-# Set default device for DeviceComboBox
-self.device_combo_box.set_default_device("motor2")
-```
-````
-
-````{tab} API - ComboBox
-```{eval-rst} 
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.DeviceComboBox.rst
-```
-````
-
-````{tab} API - LineEdit
-```{eval-rst}
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.DeviceLineEdit.rst
-```
-````

docs/user/widgets/dock_area/bec_dock_area.md

@@ -1,109 +0,0 @@
-(user.widgets.bec_dock_area)=
-
-# BECDockArea
-
-````{tab} Overview
-
-[`BECDockArea`](/api_reference/_autosummary/bec_widgets.cli.client.BECDockArea) is a powerful and flexible container designed to host various widgets and docks within a grid layout. It provides an environment for organizing and managing complex user interfaces, making it ideal for applications that require multiple tools and data visualizations to be displayed simultaneously. BECDockArea is particularly useful for embedding not only visualization tools but also other interactive components, allowing users to tailor their workspace to their specific needs.
-
-- **Flexible Dock Management**: Easily add, remove, and rearrange docks within `BECDockArea`, providing a customized layout for different tasks.
-- **State Persistence**: Save and restore the state of the dock area, enabling consistent user experiences across sessions.
-- **Dock Customization**: Add docks with customizable positions, names, and behaviors, such as floating or closable docks.
-- **Integration with Widgets**: Integrate various widgets like [`WaveformWidget`](user.widgets.waveform_widget), [`ImageWidget`](user.widgets.image_widget), and [`MotorMapWidget`](user.widgets.motor_map) into `BECDockArea`, either as standalone tools or as part of a more complex interface.
-
-**BEC Dock Area Components Schema**
-
-![BECDockArea.png](BECDockArea.png)
-````
-
-````{tab} Examples - CLI
-In the following examples, we will use `BECIPythonClient` as the main object to interact with the `BECDockArea`. These tutorials focus on how to work with the `BECDockArea` framework, such as adding and removing docks, saving and restoring layouts, and managing the docked widgets. By default the `BECDockArea` is refered as `gui` in `BECIPythonClient`. For more detailed examples of each individual component, please refer to the example sections of each individual [`widget`](user.widgets).
-
-## Example 1 - Adding Docks to BECDockArea
-
-In this example, we will demonstrate how to add different docks to a single `BECDockArea` widget. New docks are always added to the bottom of the dock area by default; however, you can specify the position of the dock by using the `position` and `relative_to` arguments.
-
-```python
-# Add a new dock with a WaveformWidget to the BECDockArea
-dock1 = gui.add_dock(name="Waveform Dock", widget="BECWaveformWidget")
-
-# Add a second dock with a MotorMapWidget to the BECDockArea to the right of the first dock
-dock2 = gui.add_dock(name="Motor Map Dock", widget="BECMotorMapWidget",relative_to="Waveform Dock", position="right")
-
-# Add a third dock with an ImageWidget to the BECDockArea, placing it on bottom of the dock area
-dock3 = gui.add_dock(name="Image Dock", widget="BECImageWidget")
-```
-
-```{hint}
-You can move docks around by dragging them with the mouse using the dock's title bar. The dock will snap to the grid layout of the dock area.
-```
-
-## Example 2 - Access of Docks in BECDockArea
-
-Docks can be accessed by their name or by the dock object. The dock object can be used to modify the dock properties or to add widgets to the dock.
-
-```python
-# All docks can be accessed by their name from the panels dictionary
-gui.panels
-
-# Output
-{'Waveform Dock': <BECDock object at 0x168b983d0>,
- 'Motor Map Dock': <BECDock object at 0x13a969250>,
- 'Image Dock': <BECDock object at 0x13f267950>}
- 
-# Access the dock by its name
-dock1 = gui.panels["Waveform Dock"]
-
-# Access the widget object of the dock
-waveform_widget = dock1.widget_list[0]
-```
-
-## Example 3 - Detaching and Attaching Docks in BECDockArea
-
-Docks in `BECDockArea` can be detached (floated) or reattached to the main dock area. This is useful when you want to temporarily undock a widget for better visibility or organization. 
-
-```python
-# Detach the dock named "Waveform Dock"
-gui.detach_dock(dock_name="Waveform Dock")
-
-# Docks can be also detached by the dock object
-dock2.detach()
-dock3.detach()
-
-# Docks can be individually reattached to the main dock area
-dock2.attach()
-
-# Reattach all floating docks to the main dock area
-gui.attach_all()
-```
-
-```{note}
-Floating docks are always returned to the original dock area if they are closed manually. Docks can also be detached by double-clicking on the dock title.
-```
-
-## Example 4 - Removing Docks from BECDockArea
-
-Docks can be removed from the dock area by their name or by the dock object. The dock object can be used to remove the dock from the dock area.
-
-```python
-# Removing docks by their name
-gui.remove_dock(dock_name="Waveform Dock")
-
-# Removing docks by the dock object
-dock2.remove()
-
-# Removing all docks from the dock area
-gui.clear_all()
-```
-
-```{warning}
-When removing a dock, all widgets within the dock will be removed as well. This action cannot be undone, and all references to the dock and its widgets will be lost.
-```
-````
-
-````{tab} API
-```{eval-rst} 
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECDockArea.rst
-```
-````
-

docs/user/widgets/image/image_widget.md

@@ -1,84 +0,0 @@
-(user.widgets.image_widget)=
-
-# Image Widget
-
-````{tab} Overview
-
-The Image Widget is a versatile tool designed for visualizing 2D image data, such as camera images, in real-time. Directly integrated with the `BEC` framework, it can display live data streams from connected cameras or other image sources within the current `BEC` session. The widget provides advanced customization options for color maps and scale bars, allowing users to tailor the visualization to their specific needs.
-
-## Key Features:
-- **Flexible Integration**: The widget can be integrated into both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`.
-- **Live Data Visualization**: Real-time plotting of 2D image data from cameras or other image sources, provided that a data stream is available in the BEC session.
-- **Customizable Color Maps and Scale Bars**: Users can customize the appearance of images with various color maps and adjust scale bars to better interpret the visualized data.
-- **Real-time Image Processing**: Apply real-time image processing techniques directly within the widget to enhance the quality or analyze specific aspects of the images such as rotation, log scaling, and FFT.
-- **Data Export**: Export visualized image data to various formats such as PNG, TIFF, or H5 for further analysis or reporting.
-- **Interactive Controls**: Offers interactive controls for zooming, panning, and adjusting the visual properties of the images on the fly.
-
-![Image 2D](./image_plot.gif)
-````
-
-````{tab} Examples - CLI
-
-`ImageWidget` can be embedded in both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`. However, the command-line API is the same for all cases.
-
-## Example 1 - Adding Image Widget to BECFigure
-
-In this example, we demonstrate how to add an `ImageWidget` to a [`BECFigure`](user.widgets.bec_figure) to visualize live data from a connected camera.
-
-```python
-# Add a new dock with BECFigure widget
-fig = gui.add_dock().add_widget('BECFigure')
-
-# Add an ImageWidget to the BECFigure
-img_widget = fig.image(source='eiger')
-img_widget.set_title("Camera Image Eiger")
-```
-
-## Example 2 - Adding Image Widget as a Dock in BECDockArea
-
-Adding `ImageWidget` into a [`BECDockArea`](user.widgets.bec_dock_area) is similar to adding any other widget. The widget has the same API as the one in [`BECFigure`](user.widgets.bec_figure); however, as an independent widget outside [`BECFigure`](user.widgets.bec_figure), it has its own toolbar, allowing users to configure the widget without needing CLI commands.
-
-```python
-# Add an ImageWidget to the BECDockArea
-img_widget = gui.add_dock().add_widget('BECImageWidget')
-
-# Visualize live data from a camera with range from 0 to 100
-img_widget.image(source='eiger')
-img_widget.set_vrange(vmin=0, vmax=100)
-```
-
-## Example 3 - Customizing Image Display
-
-This example demonstrates how to customize the color map and scale bar for an image being visualized in an `ImageWidget`.
-
-```python
-# Set the color map and adjust the scale bar range
-img_widget.set_colormap("viridis")
-img_widget.set_vrange(vmin=10, vmax=200)
-```
-
-## Example 4 - Real-time Image Processing
-
-The `ImageWidget` provides real-time image processing capabilities, such as rotating, scaling, and applying FFT to the displayed images. The following example demonstrates how to rotate an image by 90 degrees, transpose it, and apply FFT.
-
-```python
-# Rotate the image by 90 degrees
-img_widget.set_rotation(deg_90=1)
-
-# Transpose the image
-img_widget.set_transpose(enable=True)
-
-# Apply FFT to the image
-img_widget.set_fft(enable=True)
-
-# Set the logarithmic scale for the image display
-img_widget.set_log(enable=True)
-```
-
-````
-
-````{tab} API
-```{eval-rst}  
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECImageWidget.rst
-```
-````

docs/user/widgets/motor_map/motor_map.md

@@ -1,80 +0,0 @@
-(user.widgets.motor_map)=
-
-# Motor Map Widget
-
-````{tab} Overview
-
-The Motor Map Widget is a specialized tool for tracking and visualizing the positions of motors in real-time. This widget is crucial for applications requiring precise alignment and movement tracking during scans. It provides an intuitive way to monitor motor trajectories, ensuring accurate positioning throughout the scanning process.
-
-## Key Features:
-- **Flexible Integration**: The widget can be integrated into both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`.
-- **Real-time Motor Position Visualization**: Tracks motor positions in real-time and visually represents motor trajectories.
-- **Customizable Visual Elements**: The appearance of all widget components is fully customizable, including scatter size and background values.
-- **Interactive Controls**: Interactive controls for zooming, panning, and adjusting the visual properties of motor trajectories on the fly.
-
-![MotorMap](./motor.gif)
-````
-
-````{tab} Examples CLI
-`MotorMapWidget` can be embedded in both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`. However, the command-line API is the same for all cases.
-
-## Example 1 - Adding Motor Map Widget to BECFigure
-
-In this example, we will demonstrate how to add two different `MotorMapWidgets` into a single [`BECFigure`](user.widgets.bec_figure) widget.
-
-```python
-# Add new dock with BECFigure widget
-fig = gui.add_dock().add_widget('BECFigure')
-
-# Add two WaveformWidgets to the BECFigure
-mm1 = fig.motor_map(motor_x='samx', motor_y='samy')
-mm2 = fig.motor_map(motor_x='aptrx', motor_y='aptry',new=True)
-```
-
-## Example 2 - Adding Motor Map Widget as a Dock in BECDockArea
-
-Adding `MotorMapWidget` into a [`BECDockArea`](user.widgets.bec_dock_area) is similar to adding any other widget. The widget has the same API as the one in BECFigure; however, as an independent widget outside BECFigure, it has its own toolbar, allowing users to configure the widget without needing CLI commands.
-
-```python
-# Add new MotorMaps to the BECDockArea
-mm1 = gui.add_dock().add_widget('BECMotorMapWidget')
-mm2 = gui.add_dock().add_widget('BECMotorMapWidget')
-
-# Add signals to the MotorMaps
-mm1.change_motors(motor_x='samx', motor_y='samy')
-mm2.change_motors(motor_x='aptrx', motor_y='aptry')
-```
-
-## Example 3 - Customizing Motor Map Display
-
-The `MotorMapWidget` allows customization of its visual elements to better suit the needs of your application. Below is an example of how to adjust the scatter size, set background values, and limit the number of points displayed from the position buffer.
-
-```python
-# Set scatter size
-mm1.set_scatter_size(scatter_size=5)
-
-# Set background value
-mm1.set_background_value(background_value=0)
-
-# Limit the number of points displayed and saved in the position buffer
-mm1.set_max_points(max_points=500)
-```
-
-## Example 4 - Changing Motors and Resetting History
-
-You can dynamically change the motors being tracked and reset the history of the motor trajectories during the session.
-
-```python
-# Reset the history of motor movements
-mm1.reset_history()
-
-# Change the motors being tracked
-mm1.change_motors(motor_x='aptrx', motor_y='aptry')
-```
-````
-
-````{tab} API
-```{eval-rst}  
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECMotorMap.rst
-```
-````

docs/user/widgets/position_indicator/position_indicator.md

@@ -1,69 +0,0 @@
-(user.widgets.position_indicator)=
-
-# Position Indicator Widget
-
-````{tab} Overview
-
-The [`PositionIndicator`](/api_reference/_autosummary/bec_widgets.cli.client.PositionIndicator) widget is a simple yet effective tool for visually indicating the position of a motor within its set limits. This widget is particularly useful in applications where it is important to provide a visual cue of the motor's current position relative to its minimum and maximum values. The `PositionIndicator` can be easily integrated into your GUI application either through direct code instantiation or by using `QtDesigner`.
-
-## Key Features:
-- **Position Visualization**: Displays the current position of a motor on a linear scale, showing its location relative to the defined limits.
-- **Customizable Range**: The widget allows you to set the minimum and maximum range, adapting to different motor configurations.
-- **Real-Time Updates**: Responds to real-time updates, allowing the position indicator to move dynamically as the motor's position changes.
-- **QtDesigner Integration**: Can be added directly in code or through `QtDesigner`, making it adaptable to various use cases.
-
-````
-
-````{tab} Examples
-
-The `PositionIndicator` widget can be embedded within a GUI application through direct code instantiation or by using `QtDesigner`. Below are examples demonstrating how to create and use the `PositionIndicator` widget.
-
-## Example 1 - Creating a Position Indicator in Code
-
-In this example, we demonstrate how to create a `PositionIndicator` widget in code and connect it to a slider to simulate position updates.
-
-```python
-from qtpy.QtWidgets import QApplication, QSlider, QVBoxLayout, QWidget
-from bec_widgets.widgets.position_indicator import PositionIndicator
-
-app = QApplication([])
-
-# Create the PositionIndicator widget
-position_indicator = PositionIndicator()
-
-# Create a slider to simulate position changes
-slider = QSlider(Qt.Horizontal)
-slider.valueChanged.connect(lambda value: position_indicator.on_position_update(value / 100))
-
-# Create a layout and add the widgets
-layout = QVBoxLayout()
-layout.addWidget(position_indicator)
-layout.addWidget(slider)
-
-# Set up the main widget
-widget = QWidget()
-widget.setLayout(layout)
-widget.show()
-
-app.exec_()
-```
-
-## Example 2 - Setting the Range for the Position Indicator
-
-You can set the minimum and maximum range for the position indicator to reflect the actual limits of the motor.
-
-```python
-# Set the range for the position indicator
-position_indicator.set_range(min_value=0, max_value=200)
-```
-
-## Example 3 - Integrating the Position Indicator in QtDesigner
-
-The `PositionIndicator` can be added to your GUI layout using `QtDesigner`. Once added, you can connect it to the motor's position updates using the `on_position_update` slot.
-
-```python
-# Example: Updating the position in a QtDesigner-based application
-self.position_indicator.on_position_update(new_position_value)
-```
-
-````

docs/user/widgets/positioner_box/positioner_box.md

@@ -1,63 +0,0 @@
-(user.widgets.positioner_box)=
-
-# Positioner Box Widget
-
-````{tab} Overview
-
-The [`PositionerBox`](/api_reference/_autosummary/bec_widgets.cli.client.PositionerBox) widget provides a graphical user interface to control a positioner device within the BEC environment. This widget allows users to interact with a positioner by setting setpoints, tweaking the motor position, and stopping motion. The device selection can be done via a small button under the device label, through `QtDesigner`, or by using the command line interface (CLI). This flexibility makes the `PositionerBox` an essential tool for tasks involving precise position control.
-
-## Key Features:
-- **Device Selection**: Easily select a positioner device by clicking the button under the device label or by configuring the widget in `QtDesigner`.
-- **Setpoint Control**: Directly set the positioner’s target setpoint and issue movement commands.
-- **Tweak Controls**: Adjust the motor position incrementally using the tweak left/right buttons.
-- **Real-Time Feedback**: Monitor the device’s current position and status, with live updates on whether the device is moving or idle.
-- **Flexible Integration**: Can be integrated into a GUI through `BECDockArea` or used as a standalone component in `QtDesigner`.
-````
-
-````{tab} Examples
-
-The `PositionerBox` widget can be integrated within a GUI application either through direct code instantiation or by using `QtDesigner`. Below are examples demonstrating how to create and use the `PositionerBox` widget.
-
-## Example 1 - Creating a PositionerBox in Code
-
-In this example, we demonstrate how to create a `PositionerBox` widget in code and configure it for a specific device.
-
-```python
-from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
-from bec_widgets.widgets.positioner_box import PositionerBox
-
-class MyGui(QWidget):
-    def __init__(self):
-        super().__init__()
-        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
-
-        # Create and add the PositionerBox to the layout
-        self.positioner_box = PositionerBox(device="motor1")
-        self.layout().addWidget(self.positioner_box)
-
-# Example of how this custom GUI might be used:
-app = QApplication([])
-my_gui = MyGui()
-my_gui.show()
-app.exec_()
-```
-
-## Example 2 - Selecting a Device via GUI
-
-Users can select the positioner device by clicking the button under the device label, which opens a dialog for device selection.
-
-## Example 3 - Customizing PositionerBox in QtDesigner
-
-The `PositionerBox` widget can be added to a GUI through `QtDesigner`. Once integrated, you can configure the default device and customize the widget’s appearance and behavior directly within the designer.
-
-```python
-# After adding the widget to a form in QtDesigner, you can configure the device:
-self.positioner_box.set_positioner("motor2")
-```
-````
-
-````{tab} API
-```{eval-rst} 
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.PositionerBox.rst
-```
-````

docs/user/widgets/progress_bar/ring_progress_bar.md

@@ -1,103 +0,0 @@
-(user.widgets.ring_progress_bar)=
-
-# Ring Progress Bar
-
-````{tab} Overview
-
-The [`Ring Progress Bar`](/api_reference/_autosummary/bec_widgets.cli.client.RingProgressBar) widget is a circular progress bar designed to visualize the progress of tasks in a clear and intuitive manner. This widget is particularly useful in applications where task progress needs to be represented as a percentage. The `Ring Progress Bar` can be controlled directly via its API or can be hooked up to track the progress of a device readback or scan, providing real-time visual feedback.
-
-## Key Features:
-- **Circular Progress Visualization**: Displays a circular progress bar to represent task completion.
-- **Device and Scan Integration**: Hooks into device readbacks or scans to automatically update the progress bar based on real-time data.
-- **Multiple Rings**: Supports multiple progress rings within the same widget to track different tasks in parallel.
-- **Customizable Visual Elements**: Allows customization of colors, line widths, and other visual elements for each progress ring.
-
-![RingProgressBar](./progress_bar.gif)
-
-````
-
-````{tab} Example
-
-## Example 1 - Adding Ring Progress Bar to BECDockArea
-
-In this example, we demonstrate how to add a `RingProgressBar` widget to a `BECDockArea` to visualize the progress of a task.
-
-```python
-# Add a new dock with a RingProgressBar widget
-progress = gui.add_dock().add_widget("RingProgressBar")
-
-# Customize the size of the progress ring
-progress.set_line_widths(20)
-```
-
-## Example 2 - Adding Multiple Rings to Track Parallel Tasks
-
-By default, the `RingProgressBar` widget displays a single ring. You can add additional rings to track multiple tasks simultaneously.
-
-```python
-# Add a second ring to the RingProgressBar
-progress.add_ring()
-
-# Customize the rings
-progress.rings[0].set_line_widths(20)  # Set the width of the first ring
-progress.rings[1].set_line_widths(10)  # Set the width of the second ring
-```
-
-## Example 3 - Integrating with Device Readback and Scans
-
-The `RingProgressBar` can automatically update based on the progress of scans or device readbacks. This example shows how to set up the progress rings to reflect these updates.
-
-```python
-# Set the first ring to update based on scan progress
-progress.rings[0].set_update("scan")
-
-# Set the second ring to update based on a device readback (e.g., samx)
-progress.rings[1].set_update("device", "samx")
-```
-
-## Example 4 - Customizing Visual Elements of the Rings
-
-The `RingProgressBar` widget offers various customization options, such as changing colors, line widths, and the gap between rings.
-
-```python
-# Set the color of the first ring to blue
-progress.rings[0].set_color("blue")
-
-# Set the background color of the second ring
-progress.rings[1].set_background("gray")
-
-# Adjust the gap between the rings
-progress.set_gap(5)
-
-# Set the diameter of the progress bar
-progress.set_diameter(150)
-```
-
-## Example 5 - Manual Updates and Precision Control
-
-While the `RingProgressBar` supports automatic updates, you can also manually control the progress and set the precision for each ring.
-
-```python
-# Disable automatic updates and manually set the progress value
-progress.enable_auto_updates(False)
-progress.rings[0].set_value(75)  # Set the first ring to 75%
-
-# Set precision for the progress display
-progress.set_precision(2)  # Display progress with two decimal places
-
-
-# Setting multiple rigns with different values
-progress.set_number_of_bars(3)
-
-# Set the values of the rings to 50, 75, and 25 from outer to inner ring
-progress.set_value([50, 75, 25])
-```
-
-````
-
-````{tab} API
-```{eval-rst} 
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.RingProgressBar.rst
-```
-````
-

docs/user/widgets/queue/queue.md

@@ -1,41 +0,0 @@
-(user.widgets.bec_queue)=
-
-# BEC Queue Widget
-
-````{tab} Overview
-
-The [`BEC Queue Widget`](/api_reference/_autosummary/bec_widgets.cli.client.BECQueue) provides a real-time display of the BEC scan queue, allowing users to monitor and track the status of ongoing and pending scans. The widget automatically updates to reflect the current state of the scan queue, displaying critical information such as scan numbers, types, and statuses. This widget is particularly useful for users who need to manage and oversee multiple scans in the BEC environment.
-
-## Key Features:
-- **Real-Time Queue Monitoring**: Displays the current state of the BEC scan queue, with automatic updates as the queue changes.
-- **Detailed Scan Information**: Provides a clear view of scan numbers, types, and statuses, helping users track the progress and state of each scan.
-- **Interactive Table Layout**: The queue is presented in a table format, with customizable columns that stretch to fit the available space.
-- **Flexible Integration**: The widget can be integrated into both [`BECDockArea`](user.widgets.bec_dock_area) and used as an individual component in your application through `QtDesigner`.
-
-````
-
-````{tab} Examples
-
-The `BEC Queue Widget` can be embedded within a [`BECDockArea`](user.widgets.bec_dock_area) or used as an individual component in your application through `QtDesigner`. Below are examples demonstrating how to create and use the `BEC Queue Widget`.
-
-## Example 1 - Adding BEC Queue Widget to BECDockArea
-
-In this example, we demonstrate how to add a `BECQueue` widget to a `BECDockArea`, allowing users to monitor the BEC scan queue directly from the GUI.
-
-```python
-# Add a new dock with a BECQueue widget
-bec_queue = gui.add_dock().add_widget("BECQueue")
-```
-
-```{hint}
-The `BECQueue` widget automatically updates as the scan queue changes, providing real-time feedback on the status of each scan.
-Once the widget is added, it will automatically display the current scan queue
-```
-
-````
-
-````{tab} API
-```{eval-rst} 
-.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECQueue.rst
-```
-````