Removes/reduces referenece use on i10 IDs #1032

Relm-Arrowny · 2025-01-29T15:53:59Z

Fixes #1029 and #1046.

Instructions to reviewer on how to test:

Run test.
Confirm connection.
Check uml.

Checks for reviewer

Would the PR title make sense to a scientist on a set of release notes
If a new device has been added does it follow the standards
If changing the API for a pre-existing device, ensure that any beamlines using this device have updated their Bluesky plans accordingly
Have the connection tests for the relevant beamline(s) been run via dodal connect ${BEAMLINE}

…_apple2

codecov · 2025-01-31T16:49:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.88%. Comparing base (756775e) to head (0ce9976).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1032      +/-   ##
==========================================
- Coverage   97.89%   97.88%   -0.02%     
==========================================
  Files         182      182              
  Lines        7187     7182       -5     
==========================================
- Hits         7036     7030       -6     
- Misses        151      152       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

DominicOram

Thanks, I think it's cleaner but have some more comments to make it even more so.

src/dodal/devices/apple2_undulator.py

src/dodal/devices/i10/i10_apple2.py

src/dodal/devices/apple2_undulator.py

DominicOram

Thanks, couple of comments in code. Additionally, I think polarisation is basically a derived signal. I will do #1077 so that we can use it here as I think it will clean things up a lot.

src/dodal/devices/apple2_undulator.py

src/dodal/devices/i10/i10_apple2.py

DominicOram · 2025-02-27T16:07:55Z

I think you should be able to use #1078 for the polarisation signal now. Happy to help if it's not obvious how.

…9-removesreduces-refenece-use-on-i10-ids

DominicOram

Thanks! I think there are still quite a few places where you could be making use of the enum but this is a start. I think using the setter from the other PR will tidy things up a bit though

src/dodal/devices/apple2_undulator.py

src/dodal/devices/i10/i10_apple2.py

tests/devices/i10/test_i10Apple2.py

src/dodal/devices/apple2_undulator.py

olliesilvester

I haven't reviewed the entire thing yet, but a few comments for now.

olliesilvester · 2025-05-27T13:22:19Z

src/dodal/beamlines/i10.py

+"""
+note:
+    I10 has two insertion devices one up(idu) and one down stream(idd).
+    It is worth noting that the down stream device is slightly longer,


Suggested change

It is worth noting that the down stream device is slightly longer,

It is worth noting that the downstream device is slightly longer,

olliesilvester · 2025-05-27T13:34:44Z

src/dodal/devices/apple2_undulator.py

            self.jaw_phase.user_setpoint_readback,
+            self.jaw_phase.user_readback,
            self.jaw_phase.velocity,
        )


 class Apple2(StandardReadable, Movable):


Out of scope for this issue, but we should see if we can create a BaseUndulator device with a minimum set of signals.

olliesilvester · 2025-05-27T13:38:07Z

src/dodal/devices/apple2_undulator.py

+    _set_pol(value: Pol) -> None
+        Sets the polarisation and adjusts motor positions based on the current energy.
+    _read_pol_setpoint(pol: Pol, ...) -> Pol
+        Reads the polarisation from hardware and updates the setpoint.
+    _set(value: Apple2Val, energy: float) -> None
+        Moves the undulator to the specified motor positions and energy.
+    _get_id_gap_phase(energy: float) -> tuple[float, float]
+        Converts energy and polarisation to gap and phase motor positions.
+    _get_poly(new_energy: float, lookup_table: dict) -> np.poly1d


Nit: Given that these are private methods, I probably wouldn't include them on the docstring here. If I were writing plans which need this device, I'd like to quickly see the public methods available to me

olliesilvester · 2025-05-27T14:38:36Z

src/dodal/devices/apple2_undulator.py

            self.jaw_phase.user_setpoint_readback,
+            self.jaw_phase.user_readback,
            self.jaw_phase.velocity,
        )


 class Apple2(StandardReadable, Movable):


Must: This uses the Movable protocol so we need to have have a set function defined. Maybe you can just rename _set?

olliesilvester · 2025-05-27T15:18:13Z

src/dodal/devices/apple2_undulator.py

+        """This change the position of all the motors for a given energy and
+        polarisation_setpoint"""
+
+    def _read_pol_setpoint(


nit: name is implying we are only doing a read. I'd prefer something like def _update_pol_setpoint_using_hardware_read

The raw_to_derived function is for converting raw values to derived values. It seems a bit unexpected for this function to also be changing a setpoint. I'm not too familiar with this device yet though, so I could just be misunderstanding

olliesilvester · 2025-05-27T15:31:22Z

src/dodal/devices/apple2_undulator.py

+        self,
+        value: Pol,
+    ) -> None:
+        # This change the pol setpoint and then change polariastion via set energy.


Suggested change

# This change the pol setpoint and then change polariastion via set energy.

# This changes the pol setpoint and then changes polariastion via set energy.

olliesilvester · 2025-05-27T15:36:49Z

src/dodal/devices/apple2_undulator.py

+            f"btm_inner={btm_inner}, btm_outer={btm_outer}, gap={gap}."
+        )
+
+        if pol != Pol.LH3:


Would be useful to have a comment here to explain why we handle the Pol.LH3 case differently. Also, would it be useful to error/warn if pol==None?

olliesilvester · 2025-05-27T15:41:19Z

src/dodal/devices/i10/i10_apple2.py

-from dodal.devices.apple2_undulator import (
+from dodal.log import LOGGER
+
+# from dodal.beamlines.i10 import pgm


Should: Remove this line

olliesilvester · 2025-05-27T15:47:18Z

src/dodal/devices/apple2_undulator.py

-            phase = 0.0
-            return polarisation, phase
+            LOGGER.info("Determined polarisation: LH (Linear Horizontal).")
+            return Pol("lh"), 0.0


Should: use Pol.LH3 instead here

olliesilvester · 2025-05-27T15:48:31Z

tests/devices/i10/test_i10Apple2.py

 async def test_linear_arbitrary_pol_fail(
    mock_linear_arbitrary_angle: LinearArbitraryAngle,
 ):
-    mock_linear_arbitrary_angle.id_ref().pol = "lh"
+    # set_mock_value(


Should: remove this comment

add docstring and fix issue with connection after removing ref in i10…

e7f2dd5

…_apple2

Relm-Arrowny linked an issue Jan 29, 2025 that may be closed by this pull request

Removes/reduces refenece use on i10 IDs #1029

Open

9 tasks

Relm-Arrowny added 2 commits January 31, 2025 14:19

remove demand in signal names

4c055c9

fixes tests

847f299

Relm-Arrowny added 4 commits January 31, 2025 17:06

corrected read so it always read pol from hardware

002998a

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

6df9b8e

add uml and correct some docstring

dee421b

fix read signals and test

e2a72f3

Relm-Arrowny linked an issue Feb 7, 2025 that may be closed by this pull request

PGM/appl2_undulator timing out early #1046

Open

1 task

Relm-Arrowny added 2 commits February 7, 2025 17:07

Time out fix

a1a54ba

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

5816cc9

Relm-Arrowny mentioned this pull request Feb 10, 2025

Add check for slow tests to CI #1033

Merged

4 tasks

Relm-Arrowny added 5 commits February 10, 2025 13:37

added test for lh3

311a03b

add _ref when refenece is used.

2628de7

add uml and fix docstrings

01efc2a

typos

723a859

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

66d8094

Relm-Arrowny marked this pull request as ready for review February 11, 2025 09:35

Relm-Arrowny requested a review from a team as a code owner February 11, 2025 09:35

Relm-Arrowny requested a review from DominicOram February 11, 2025 09:36

DominicOram changed the title ~~Removes/reduces refenece use on i10 IDs~~ Removes/reduces referenece use on i10 IDs Feb 12, 2025

DominicOram requested changes Feb 24, 2025

View reviewed changes

Relm-Arrowny added 5 commits February 25, 2025 13:35

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

49edeb2

name change

9f95d8a

move init of id into i10apple2

331d0ab

fix docstring

9008d74

change i10Apple2PGM to EnergySetter

56ccc7f

Relm-Arrowny requested a review from DominicOram February 27, 2025 11:38

DominicOram mentioned this pull request Feb 27, 2025

Allow passing a setter to create_hardware_backed_soft_signal #1077

Closed

DominicOram requested changes Feb 27, 2025

View reviewed changes

src/dodal/devices/apple2_undulator.py Outdated Show resolved Hide resolved

src/dodal/devices/apple2_undulator.py Outdated Show resolved Hide resolved

src/dodal/devices/i10/i10_apple2.py Show resolved Hide resolved

DominicOram added 2 commits February 27, 2025 14:17

Add tests for existing hardware backed signal

d0c04d7

Allow setting function on create_hardware_backed_soft_signal

fcc1e28

Relm-Arrowny added 7 commits February 28, 2025 09:41

correct docstring and remove unused prefix

ecc686f

Merge branch '1077_allow_setting_on_hardware_backed_signals' into 102…

9ea0705

…9-removesreduces-refenece-use-on-i10-ids

change pol set to use enum

5592431

added hardware backed polarisation signal

08a49e9

remove redundant code

bf8bf4d

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

43c5ac1

roll back signal

0e740b4

Relm-Arrowny requested a review from DominicOram March 4, 2025 14:58

DominicOram requested changes Mar 24, 2025

View reviewed changes

Relm-Arrowny self-assigned this Apr 25, 2025

Relm-Arrowny added 10 commits April 25, 2025 14:02

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

dfa7c56

change id to use direved derived_signal_r

a77912a

make polarisation both read and set.

447a2fe

remove pol .value

3fb482a

change test to use Pol

6cf8263

fix tests

7ae23ab

docsting and all the pol

3a8daa6

small change to tidy up

ab5b5c5

Merge branch 'main' into 1029-removesreduces-refenece-use-on-i10-ids

40b5d64

correct some spelling

0ce9976

Relm-Arrowny requested a review from DominicOram April 28, 2025 15:23

olliesilvester self-requested a review May 27, 2025 09:57

olliesilvester requested changes May 27, 2025

View reviewed changes

	It is worth noting that the down stream device is slightly longer,
	It is worth noting that the downstream device is slightly longer,

	# This change the pol setpoint and then change polariastion via set energy.
	# This changes the pol setpoint and then changes polariastion via set energy.

Removes/reduces referenece use on i10 IDs #1032

Are you sure you want to change the base?

Removes/reduces referenece use on i10 IDs #1032

Uh oh!

Conversation

Relm-Arrowny commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions to reviewer on how to test:

Checks for reviewer

Uh oh!

codecov bot commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DominicOram left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DominicOram left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DominicOram commented Feb 27, 2025

Uh oh!

DominicOram left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

olliesilvester left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Relm-Arrowny commented Jan 29, 2025 •

edited

Loading

codecov bot commented Jan 31, 2025 •

edited

Loading