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

docs/user/getting_started/getting_started.md

@@ -0,0 +1,12 @@
+(user.getting_started)=
+# Getting Started
+This section provides a comprehensive guide to getting started with BEC Widgets. Whether you are new to BEC Widgets or looking to refresh your knowledge, this guide will help you set up and navigate the framework with ease.
+
+```{toctree}
+---
+maxdepth: 2
+hidden: true
+---
+
+getting_started/installation
+```

docs/user/{installation.md → getting_started/installation.md}

@@ -14,7 +14,7 @@ Before installing BEC Widgets, please ensure the following requirements are met:
 Install BEC Widgets using the pip package manager. Open your terminal and execute:
 
 ```bash
-pip install bec_widgets
+pip install bec_widgets PyQt6
 ```
 
 This command installs BEC Widgets along with its dependencies, including the default PyQt6.

docs/user/user.md

@@ -1,38 +1,67 @@
 (user)=
 # User
+Welcome to the User section of the BEC Widgets documentation! BEC Widgets is a versatile GUI framework tailored for beamline scientists, enabling efficient and intuitive interaction with beamline experiments. This section is designed to guide both new and experienced users through the essential aspects of utilizing BEC Widgets.
 
-**Overview**
+```{toctree}
+---
+maxdepth: 2
+hidden: true
+---
 
-Welcome to the User section of the BEC Widgets documentation! BEC Widgets is a versatile GUI framework tailored for beamline scientists, enabling efficient and intuitive interaction with beamline experiments. This section is designed to guide both new and experienced users through the essential aspects of utilizing BEC Widgets.
+getting_started/getting_started.md
+applications/applications.md
+widgets/widgets.md
+api_reference/api_reference.md
+```
 
-**Key Topics**
 
-- [Installing BEC Widgets](#user.installation): Instructions for installing BEC Widgets on your system.
+***
 
-- [Example Applications](#user.apps): Overview of bespoke applications and demonstrations of BEC Widgets in action, showcasing its use in real-world beamline scenarios.
+````{grid} 2
+:gutter: 5
 
-- [Widgets Overview](#user.widgets): Detailed information on the variety of widgets available, their functions, and how to use them effectively.
+```{grid-item-card}
+:link: user.getting_started
+:link-type: ref
+:img-top: /assets/rocket_launch_48dp.svg
+:text-align: center
 
-- [Customization and Configuration](#user.customisation): Tips on customizing and configuring BEC Widgets to suit your specific experimental needs using Qt Designer.
+## Getting Started
 
-**Bug Reports and Feature Requests**
+Learn how to install BEC Widgets and get started with the framework.
+```
 
-We value your feedback and contributions to improving BEC Widgets. If you encounter any issues or have ideas for new features, we encourage you to report them.
+```{grid-item-card}
+:link: user.applications
+:link-type: ref
+:img-top: /assets/display_settings_48dp.svg
+:text-align: center
 
-- **Bug Reports:** If you find a bug or an issue, please report it on our repository's [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened). We have a template for bug reporting to help you provide all necessary information.
-- **Feature Requests:** Have an idea for a new feature or an enhancement? Share it with us on the [Issues page](https://gitlab.psi.ch/bec/bec-widgets/-/issues?sort=created_date&state=opened) of our repository. We have a feature request template that you can use to describe your proposal.
+## Applications
 
-**Development**
+Learn how to use BEC Widgets Applications, to modify and create new applications.
 
-For advanced details about BEC Widgets’ internal architecture, development contributions, or customization techniques, please explore the [Developer](#developer) section. 
+```
 
-```{toctree}
----
-maxdepth: 3
-hidden: true
----
+```{grid-item-card}
+:link: user.widgets
+:link-type: ref
+:img-top: /assets/apps_48dp.svg
+:text-align: center
+
+## Widgets
+
+Learn about the building blocks of larger applications: widgets.
+```
+
+```{grid-item-card} 
+:link: user.api_reference
+:link-type: ref
+:img-top: /assets/index_api.svg
+:text-align: center
+
+## API reference
 
-installation
-apps
-widgets
-customisation
+Comprehensive reference of all user-facing classes, functions, and methods.
+```
+````

docs/user/{widgets.md → widgets/widgets.md}

@@ -15,7 +15,7 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
 - Customizable visual elements such as line color and style.
 
 **Example of Use:**
-![Waveform 1D](./widgets/w1D.gif)
+![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.
@@ -27,7 +27,7 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
 - Tools for selecting and inspecting specific data points.
 
 **Example of Use:**
-![Waveform 1D](./widgets/scatter_2D.gif)
+![Waveform 1D](./scatter_2D.gif)
 ### Motor Position Map
 
 **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.
@@ -38,4 +38,4 @@ BEC Widgets includes a variety of visualization widgets designed to cater to div
 - Ability to record and recall specific motor positions for repetitive tasks.
 
 **Example of Use:**
-![Waveform 1D](./widgets/motor.gif)
+![Waveform 1D](./motor.gif)

pyproject.toml

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

tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -1,11 +1,25 @@
 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
 
 
+@pytest.fixture(name="bec_client")
+def cli_bec_client(rpc_server_dock):
+    """
+    Fixture to create a BECClient instance that is independent of the GUI.
+    """
+    # pylint: disable=protected-access
+    cli_client = BECClient(forced=True, config=rpc_server_dock.client._service_config)
+    cli_client.start()
+    yield cli_client
+    cli_client.shutdown()
+
+
 def test_rpc_add_dock_with_figure_e2e(rpc_server_dock, qtbot):
     dock = BECDockArea(rpc_server_dock.gui_id)
     dock_server = rpc_server_dock.gui
@@ -163,7 +177,7 @@ def test_spiral_bar(rpc_server_dock):
 
     expected_colors = Colors.golden_angle_color("viridis", 5, "RGB")
     bar_colors = [ring.color.getRgb() for ring in bar_server.rings]
-    bar_values = [ring.value for ring in bar_server.rings]
+    bar_values = [ring.config.value for ring in bar_server.rings]
     assert bar_values == [10, 20, 30, 40, 50]
     assert bar_colors == expected_colors
 
@@ -188,7 +202,7 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
     qtbot.wait(200)
     bar_server = dock_server.docks["dock_0"].widgets[0]
     assert bar_server.config.num_bars == 1
-    np.testing.assert_allclose(bar_server.rings[0].value, 10, atol=0.1)
+    np.testing.assert_allclose(bar_server.rings[0].config.value, 10, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[0].config.min_value, 0, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[0].config.max_value, 10, atol=0.1)
 
@@ -199,7 +213,7 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
 
     qtbot.wait(200)
     assert bar_server.config.num_bars == 1
-    np.testing.assert_allclose(bar_server.rings[0].value, 16, atol=0.1)
+    np.testing.assert_allclose(bar_server.rings[0].config.value, 16, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[0].config.min_value, 0, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[0].config.max_value, 16, atol=0.1)
 
@@ -218,9 +232,63 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
 
     qtbot.wait(200)
     assert bar_server.config.num_bars == 2
-    np.testing.assert_allclose(bar_server.rings[0].value, final_samx, atol=0.1)
-    np.testing.assert_allclose(bar_server.rings[1].value, final_samy, atol=0.1)
+    np.testing.assert_allclose(bar_server.rings[0].config.value, final_samx, atol=0.1)
+    np.testing.assert_allclose(bar_server.rings[1].config.value, final_samy, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[0].config.min_value, init_samx, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[1].config.min_value, init_samy, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[0].config.max_value, final_samx, atol=0.1)
     np.testing.assert_allclose(bar_server.rings[1].config.max_value, final_samy, atol=0.1)
+
+
+def test_auto_update(rpc_server_dock, bec_client, qtbot):
+    dock = BECDockArea(rpc_server_dock.gui_id)
+    dock._client = bec_client
+
+    AutoUpdates.enabled = True
+    AutoUpdates.create_default_dock = True
+    dock.auto_updates = AutoUpdates(gui=dock)
+    dock.auto_updates.start_default_dock()
+    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
+    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)
+
+    # wait for scan to finish
+    while not status.status == "COMPLETED":
+        qtbot.wait(200)
+
+    last_scan_data = queue.scan_storage.storage[-1].data
+
+    # get data from curves
+    plt = dock.auto_updates.get_default_figure()
+    widgets = plt.widget_list
+    plt_data = widgets[0].get_all_data()
+
+    # check plotted data
+    assert plt_data["bpm4i-bpm4i"]["x"] == last_scan_data["samx"]["samx"].val
+    assert plt_data["bpm4i-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
+    )
+
+    # wait for scan to finish
+    while not status.status == "COMPLETED":
+        qtbot.wait(200)
+
+    plt = dock.auto_updates.get_default_figure()
+    widgets = plt.widget_list
+    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}"]["x"] == last_scan_data["samx"]["samx"].val
+    assert plt_data[f"Scan {status.scan.scan_number}"]["y"] == last_scan_data["samy"]["samy"].val

tests/unit_tests/test_client_utils.py

@@ -25,5 +25,5 @@ def test_rpc_call_accepts_device_as_input(cli_figure):
     dev1 = FakeDevice("samx")
     dev2 = FakeDevice("bpm4i")
     fig, mock_rpc_call = cli_figure
-    fig.plot(dev1, dev2)
-    mock_rpc_call.assert_called_with("plot", "samx", "bpm4i")
+    fig.plot(x_name=dev1, y_name=dev2)
+    mock_rpc_call.assert_called_with("plot", x_name="samx", y_name="bpm4i")

tests/unit_tests/test_spiral_progress_bar.py

@@ -145,12 +145,12 @@ def test_bar_set_value(spiral_progress_bar):
     assert len(spiral_progress_bar.rings) == 5
 
     spiral_progress_bar.set_value([10, 20, 30, 40, 50])
-    ring_values = [ring.value for ring in spiral_progress_bar.rings]
+    ring_values = [ring.config.value for ring in spiral_progress_bar.rings]
     assert ring_values == [10, 20, 30, 40, 50]
 
     # update just one bar
     spiral_progress_bar.set_value(90, 1)
-    ring_values = [ring.value for ring in spiral_progress_bar.rings]
+    ring_values = [ring.config.value for ring in spiral_progress_bar.rings]
     assert ring_values == [10, 90, 30, 40, 50]
 
 
@@ -166,7 +166,7 @@ def test_bar_set_precision(spiral_progress_bar):
     assert ring_precision == [2, 2, 2]
 
     spiral_progress_bar.set_value([10.1234, 20.1234, 30.1234])
-    ring_values = [ring.value for ring in spiral_progress_bar.rings]
+    ring_values = [ring.config.value for ring in spiral_progress_bar.rings]
     assert ring_values == [10.12, 20.12, 30.12]
 
     spiral_progress_bar.set_precision(4, 1)
@@ -174,7 +174,7 @@ def test_bar_set_precision(spiral_progress_bar):
     assert ring_precision == [2, 4, 2]
 
     spiral_progress_bar.set_value([10.1234, 20.1234, 30.1234])
-    ring_values = [ring.value for ring in spiral_progress_bar.rings]
+    ring_values = [ring.config.value for ring in spiral_progress_bar.rings]
     assert ring_values == [10.12, 20.1234, 30.12]
 
 
@@ -189,7 +189,7 @@ def test_set_min_max_value(spiral_progress_bar):
     assert ring_max_values == [10, 10]
 
     spiral_progress_bar.set_value([5, 15])
-    ring_values = [ring.value for ring in spiral_progress_bar.rings]
+    ring_values = [ring.config.value for ring in spiral_progress_bar.rings]
     assert ring_values == [5, 10]