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

docs/user/widgets/widgets.md

@@ -1,220 +0,0 @@
-(user.widgets)=
-# Widgets
-
-BEC Widgets offers a range of tools designed to make data visualization in beamline experiments easier and more
-interactive. These widgets help users better understand their data by providing clear, intuitive displays that enhance
-the overall experience.
-
-## Widget Containers
-
-Serves as containers to organise and display other widgets.
-
-````{grid} 3
-:gutter: 2
-
-```{grid-item-card}  BEC Dock Area
-:link: user.widgets.bec_dock_area
-:link-type: ref
-:img-top: /assets/widget_screenshots/dock_area.png
-
-Quickly build dynamic GUI.
-
-```
-
-```{grid-item-card}  BEC Figure
-:link: user.widgets.bec_figure
-:link-type: ref
-:img-top: /assets/widget_screenshots/figure.png
-
-Display 1D and 2D data.
-```
-````
-
-## Plotting Widgets
-
-Plotting widgets are used to display data in a graphical format.
-
-````{grid} 3
-:gutter: 2
-
-```{grid-item-card}  Waveform Widget
-:link: user.widgets.waveform_widget
-:link-type: ref
-:img-top: /assets/widget_screenshots/waveform_widget.png
-
-Display 1D detector signals.
-```
-
-```{grid-item-card}  Image Widget
-:link: user.widgets.image_widget
-:link-type: ref
-:img-top: /assets/widget_screenshots/image_widget.png
-
-Display signal from 2D detector.
-```
-
-```{grid-item-card}  Motor Map Widget
-:link: user.widgets.motor_map
-:link-type: ref
-:img-top: /assets/widget_screenshots/motor_map_widget.png
-
-Track position for motors.
-```
-
-````
-
-## Device Control Widgets
-
-Control and monitor devices/scan in the BEC environment.
-
-````{grid} 3
-:gutter: 2
-
-```{grid-item-card}  Scan Control Widget
-:link: user.widgets.scan_control
-:link-type: ref
-:img-top: /assets/widget_screenshots/scan_controller.png
-
-Launch scans.
-```
-
-```{grid-item-card}  Device Browser
-:link: user.widgets.device_browser
-:link-type: ref
-:img-top: /assets/widget_screenshots/device_browser.png
-
-Find and drag devices.
-```
-
-```{grid-item-card}  Positioner Box
-:link: user.widgets.positioner_box
-:link-type: ref
-:img-top: /assets/widget_screenshots/device_box.png
-
-Control individual device.
-```
-
-```{grid-item-card} Ring Progress Bar 
-:link: user.widgets.ring_progress_bar
-:link-type: ref
-:img-top: /assets/widget_screenshots/ring_progress_bar.png
-
-Nested progress bar.
-```
-
-````
-
-## BEC Service Widgets
-
-Visualise the status of BEC services.
-
-````{grid} 3
-:gutter: 2
-
-```{grid-item-card} BEC Status Box
-:link: user.widgets.bec_status_box
-:link-type: ref
-:img-top: /assets/widget_screenshots/status_box.png
-
-Display status of BEC services.
-```
-
-```{grid-item-card} BEC Queue Table 
-:link: user.widgets.bec_queue
-:link-type: ref
-:img-top: /assets/widget_screenshots/queue.png
-
-Display current scan queue.
-```
-````
-
-## BEC Utility Widgets
-
-Various utility widgets to enhance user experience.
-
-````{grid} 3
-:gutter: 2
-
-```{grid-item-card} Service Buttons
-:link: user.widgets.buttons
-:link-type: ref
-:img-top: /assets/widget_screenshots/buttons.png
-
-Various service buttons.
-```
-
-```{grid-item-card} Device Input Widgets
-:link: user.widgets.device_input
-:link-type: ref
-:img-top: /assets/widget_screenshots/device_inputs.png
-
-Choose individual device from current session.
-```
-
-```{grid-item-card} Text Box Widget
-:link: user.widgets.text_box
-:link-type: ref
-:img-top: /assets/widget_screenshots/text_box.png
-
-Display custom text or HTML content.
-```
-
-```{grid-item-card} Website Widget
-:link: user.widgets.website
-:link-type: ref
-:img-top: /assets/widget_screenshots/website.png
-
-Display website content.
-```
-
-```{grid-item-card} Toogle Widget
-:link: user.widgets.toggle
-:link-type: ref
-:img-top: /assets/widget_screenshots/toggle.png
-
-Angular like toggle switch.
-```
-
-```{grid-item-card} Spinner 
-:link: user.widgets.spinner
-:link-type: ref
-:img-top: /assets/widget_screenshots/spinner.gif
-
-Display spinner widget for loading or device movement.
-```
-
-```{grid-item-card} Position Indicator
-:link: user.widgets.position_indicator
-:link-type: ref
-:img-top: /assets/widget_screenshots/position_indicator.png
-
-Display position of motor withing its limits.
-```
-````
-
-```{toctree}
----
-maxdepth: 1
-hidden: true
----
-
-dock_area/bec_dock_area.md
-bec_figure/bec_figure.md
-waveform/waveform_widget.md
-image/image_widget.md
-motor_map/motor_map.md
-scan_control/scan_control.md
-progress_bar/ring_progress_bar.md
-bec_status_box/bec_status_box.md
-queue/queue.md
-buttons/buttons.md
-device_browser/device_browser.md
-positioner_box/positioner_box.md
-text_box/text_box.md
-website/website.md
-toggle/toggle.md
-spinner/spinner.md
-device_input/device_input.md
-position_indicator/position_indicator.md
-
-```

tests/end-2-end/conftest.py

@@ -1,53 +0,0 @@
-import random
-import time
-from contextlib import contextmanager
-
-import pytest
-from bec_lib.endpoints import MessageEndpoints
-
-from bec_widgets.cli.client_utils import _start_plot_process
-from bec_widgets.cli.rpc_register import RPCRegister
-from bec_widgets.utils import BECDispatcher
-from bec_widgets.widgets.dock import BECDockArea
-from bec_widgets.widgets.figure import BECFigure
-
-
-# make threads check in autouse, **will be executed at the end**; better than
-# having it in fixtures for each test, since it prevents from needing to
-# 'manually' shutdown bec_client_lib (for example) to make it happy, whereas
-# whereas in fact bec_client_lib makes its on cleanup
-@pytest.fixture(autouse=True)
-def threads_check_fixture(threads_check):
-    return
-
-
-@pytest.fixture
-def gui_id():
-    return f"figure_{random.randint(0,100)}"  # make a new gui id each time, to ensure no 'gui is alive' zombie key can perturbate
-
-
-@contextmanager
-def plot_server(gui_id, klass, client_lib):
-    dispatcher = BECDispatcher(client=client_lib)  # Has to init singleton with fixture client
-    process, _ = _start_plot_process(gui_id, klass, client_lib._client._service_config.config_path)
-    try:
-        while client_lib._client.connector.get(MessageEndpoints.gui_heartbeat(gui_id)) is None:
-            time.sleep(0.3)
-        yield gui_id
-    finally:
-        process.terminate()
-        process.wait()
-        dispatcher.disconnect_all()
-        dispatcher.reset_singleton()
-
-
-@pytest.fixture
-def rpc_server_figure(gui_id, bec_client_lib):
-    with plot_server(gui_id, BECFigure, bec_client_lib) as server:
-        yield server
-
-
-@pytest.fixture
-def rpc_server_dock(gui_id, bec_client_lib):
-    with plot_server(gui_id, BECDockArea, bec_client_lib) as server:
-        yield server

tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -1,298 +0,0 @@
-import time
-
-import numpy as np
-import pytest
-from bec_lib.client import BECClient
-from bec_lib.endpoints import MessageEndpoints
-
-from bec_widgets.cli.auto_updates import AutoUpdates
-from bec_widgets.cli.client import BECDockArea, BECFigure, BECImageShow, BECMotorMap, BECWaveform
-from bec_widgets.utils import Colors
-
-# pylint: disable=unused-argument
-# pylint: disable=redefined-outer-name
-# pylint: disable=too-many-locals
-
-
-def test_rpc_add_dock_with_figure_e2e(bec_client_lib, rpc_server_dock):
-    # BEC client shortcuts
-    dock = BECDockArea(rpc_server_dock)
-    client = bec_client_lib
-    dev = client.device_manager.devices
-    scans = client.scans
-    queue = client.queue
-
-    # Create 3 docks
-    d0 = dock.add_dock("dock_0")
-    d1 = dock.add_dock("dock_1")
-    d2 = dock.add_dock("dock_2")
-
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 3
-    # Add 3 figures with some widgets
-    fig0 = d0.add_widget("BECFigure")
-    fig1 = d1.add_widget("BECFigure")
-    fig2 = d2.add_widget("BECFigure")
-
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 3
-    assert len(dock_config["docks"]["dock_0"]["widgets"]) == 1
-    assert len(dock_config["docks"]["dock_1"]["widgets"]) == 1
-    assert len(dock_config["docks"]["dock_2"]["widgets"]) == 1
-
-    assert fig1.__class__.__name__ == "BECFigure"
-    assert fig1.__class__ == BECFigure
-    assert fig2.__class__.__name__ == "BECFigure"
-    assert fig2.__class__ == BECFigure
-
-    mm = fig0.motor_map("samx", "samy")
-    plt = fig1.plot(x_name="samx", y_name="bpm4i")
-    im = fig2.image("eiger")
-
-    assert mm.__class__.__name__ == "BECMotorMap"
-    assert mm.__class__ == BECMotorMap
-    assert plt.__class__.__name__ == "BECWaveform"
-    assert plt.__class__ == BECWaveform
-    assert im.__class__.__name__ == "BECImageShow"
-    assert im.__class__ == BECImageShow
-
-    assert mm._config_dict["signals"] == {
-        "dap": None,
-        "source": "device_readback",
-        "x": {
-            "name": "samx",
-            "entry": "samx",
-            "unit": None,
-            "modifier": None,
-            "limits": [-50.0, 50.0],
-        },
-        "y": {
-            "name": "samy",
-            "entry": "samy",
-            "unit": None,
-            "modifier": None,
-            "limits": [-50.0, 50.0],
-        },
-        "z": None,
-    }
-    assert plt._config_dict["curves"]["bpm4i-bpm4i"]["signals"] == {
-        "dap": None,
-        "source": "scan_segment",
-        "x": {"name": "samx", "entry": "samx", "unit": None, "modifier": None, "limits": None},
-        "y": {"name": "bpm4i", "entry": "bpm4i", "unit": None, "modifier": None, "limits": None},
-        "z": None,
-    }
-    assert im._config_dict["images"]["eiger"]["monitor"] == "eiger"
-
-    # check initial position of motor map
-    initial_pos_x = dev.samx.read()["samx"]["value"]
-    initial_pos_y = dev.samy.read()["samy"]["value"]
-
-    # Try to make a scan
-    status = scans.line_scan(dev.samx, -5, 5, steps=10, exp_time=0.05, relative=False)
-
-    # wait for scan to finish
-    while not status.status == "COMPLETED":
-        time.sleep(0.2)
-
-    # plot
-    plt_last_scan_data = queue.scan_storage.storage[-1].data
-    plt_data = plt.get_all_data()
-    assert plt_data["bpm4i-bpm4i"]["x"] == plt_last_scan_data["samx"]["samx"].val
-    assert plt_data["bpm4i-bpm4i"]["y"] == plt_last_scan_data["bpm4i"]["bpm4i"].val
-
-    # image
-    last_image_device = client.connector.get_last(MessageEndpoints.device_monitor_2d("eiger"))[
-        "data"
-    ].data
-    time.sleep(0.5)
-    last_image_plot = im.images[0].get_data()
-    np.testing.assert_equal(last_image_device, last_image_plot)
-
-    # motor map
-    final_pos_x = dev.samx.read()["samx"]["value"]
-    final_pos_y = dev.samy.read()["samy"]["value"]
-
-    # check final coordinates of motor map
-    motor_map_data = mm.get_data()
-
-    np.testing.assert_equal(
-        [motor_map_data["x"][0], motor_map_data["y"][0]], [initial_pos_x, initial_pos_y]
-    )
-    np.testing.assert_equal(
-        [motor_map_data["x"][-1], motor_map_data["y"][-1]], [final_pos_x, final_pos_y]
-    )
-
-
-def test_dock_manipulations_e2e(rpc_server_dock):
-    dock = BECDockArea(rpc_server_dock)
-
-    d0 = dock.add_dock("dock_0")
-    d1 = dock.add_dock("dock_1")
-    d2 = dock.add_dock("dock_2")
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 3
-
-    d0.detach()
-    dock.detach_dock("dock_2")
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 3
-    assert len(dock.temp_areas) == 2
-
-    d0.attach()
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 3
-    assert len(dock.temp_areas) == 1
-
-    d2.remove()
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 2
-
-    assert ["dock_0", "dock_1"] == list(dock_config["docks"])
-
-    dock.clear_all()
-
-    dock_config = dock._config_dict
-    assert len(dock_config["docks"]) == 0
-    assert len(dock.temp_areas) == 0
-
-
-def test_ring_bar(rpc_server_dock):
-    dock = BECDockArea(rpc_server_dock)
-
-    d0 = dock.add_dock(name="dock_0")
-
-    bar = d0.add_widget("RingProgressBar")
-    assert bar.__class__.__name__ == "RingProgressBar"
-
-    bar.set_number_of_bars(5)
-    bar.set_colors_from_map("viridis")
-    bar.set_value([10, 20, 30, 40, 50])
-
-    bar_config = bar._config_dict
-
-    expected_colors = [list(color) for color in Colors.golden_angle_color("viridis", 5, "RGB")]
-    bar_colors = [ring._config_dict["color"] for ring in bar.rings]
-    bar_values = [ring._config_dict["value"] for ring in bar.rings]
-    assert bar_config["num_bars"] == 5
-    assert bar_values == [10, 20, 30, 40, 50]
-    assert bar_colors == expected_colors
-
-
-def test_ring_bar_scan_update(bec_client_lib, rpc_server_dock):
-    dock = BECDockArea(rpc_server_dock)
-
-    d0 = dock.add_dock("dock_0")
-
-    bar = d0.add_widget("RingProgressBar")
-
-    client = bec_client_lib
-    dev = client.device_manager.devices
-    dev.samx.tolerance.set(0)
-    dev.samy.tolerance.set(0)
-    scans = client.scans
-
-    status = scans.line_scan(dev.samx, -5, 5, steps=10, exp_time=0.05, relative=False)
-    status.wait()
-
-    bar_config = bar._config_dict
-    assert bar_config["num_bars"] == 1
-    assert bar_config["rings"][0]["value"] == 10
-    assert bar_config["rings"][0]["min_value"] == 0
-    assert bar_config["rings"][0]["max_value"] == 10
-
-    status = scans.grid_scan(dev.samx, -5, 5, 4, dev.samy, -10, 10, 4, relative=True, exp_time=0.1)
-    status.wait()
-
-    bar_config = bar._config_dict
-    assert bar_config["num_bars"] == 1
-    assert bar_config["rings"][0]["value"] == 16
-    assert bar_config["rings"][0]["min_value"] == 0
-    assert bar_config["rings"][0]["max_value"] == 16
-
-    init_samx = dev.samx.read()["samx"]["value"]
-    init_samy = dev.samy.read()["samy"]["value"]
-    final_samx = init_samx + 5
-    final_samy = init_samy + 10
-
-    dev.samx.velocity.put(5)
-    dev.samy.velocity.put(5)
-
-    status = scans.umv(dev.samx, 5, dev.samy, 10, relative=True)
-    status.wait()
-
-    bar_config = bar._config_dict
-    assert bar_config["num_bars"] == 2
-    assert bar_config["rings"][0]["value"] == final_samx
-    assert bar_config["rings"][1]["value"] == final_samy
-    assert bar_config["rings"][0]["min_value"] == init_samx
-    assert bar_config["rings"][0]["max_value"] == final_samx
-    assert bar_config["rings"][1]["min_value"] == init_samy
-    assert bar_config["rings"][1]["max_value"] == final_samy
-
-
-def test_auto_update(bec_client_lib, rpc_server_dock, qtbot):
-    dock = BECDockArea(rpc_server_dock)
-
-    AutoUpdates.enabled = True
-    AutoUpdates.create_default_dock = True
-    dock.auto_updates = AutoUpdates(gui=dock)
-    dock.auto_updates.start_default_dock()
-
-    def get_default_figure():
-        return dock.auto_updates.get_default_figure()
-
-    qtbot.waitUntil(lambda: get_default_figure() is not None, timeout=10000)
-    plt = get_default_figure()
-
-    dock.selected_device = "bpm4i"
-
-    # we need to start the update script manually; normally this is done when the GUI is started
-    dock._start_update_script()
-
-    client = bec_client_lib
-    dev = client.device_manager.devices
-    scans = client.scans
-    queue = client.queue
-
-    status = scans.line_scan(dev.samx, -5, 5, steps=10, exp_time=0.05, relative=False)
-    status.wait()
-
-    last_scan_data = queue.scan_storage.storage[-1].data
-
-    # get data from curves
-    widgets = plt.widget_list
-    plt_data = widgets[0].get_all_data()
-
-    # check plotted data
-    assert (
-        plt_data[f"Scan {status.scan.scan_number} - bpm4i"]["x"]
-        == last_scan_data["samx"]["samx"].val
-    )
-    assert (
-        plt_data[f"Scan {status.scan.scan_number} - bpm4i"]["y"]
-        == last_scan_data["bpm4i"]["bpm4i"].val
-    )
-
-    status = scans.grid_scan(
-        dev.samx, -10, 10, 5, dev.samy, -5, 5, 5, exp_time=0.05, relative=False
-    )
-    status.wait()
-
-    plt = dock.auto_updates.get_default_figure()
-    widgets = plt.widget_list
-    qtbot.waitUntil(lambda: len(plt.widget_list) > 0, timeout=5000)
-    plt_data = widgets[0].get_all_data()
-
-    last_scan_data = queue.scan_storage.storage[-1].data
-
-    # check plotted data
-    assert (
-        plt_data[f"Scan {status.scan.scan_number} - {dock.selected_device}"]["x"]
-        == last_scan_data["samx"]["samx"].val
-    )
-    assert (
-        plt_data[f"Scan {status.scan.scan_number} - {dock.selected_device}"]["y"]
-        == last_scan_data["samy"]["samy"].val
-    )
-    dock.auto_updates.shutdown()