Rename PGM to PlaneGratingMonochromator (#1676)

oliwenmandiamond · web-flow · commit bab629cb0f9d · 2025-10-30T11:31:20.000Z
diff --git a/src/dodal/beamline_specific_utils/i05_shared.py b/src/dodal/beamline_specific_utils/i05_shared.py
@@ -1,11 +1,14 @@
 from dodal.common.beamlines.beamline_utils import device_factory
 from dodal.devices.i05.enums import Grating
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.utils import BeamlinePrefix
 
 PREFIX = BeamlinePrefix("i05", "I")
 
 
 @device_factory()
-def pgm() -> PGM:
-    return PGM(prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:", grating=Grating)
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=Grating,
+    )
diff --git a/src/dodal/beamlines/b07.py b/src/dodal/beamlines/b07.py
@@ -5,7 +5,7 @@
 from dodal.devices.b07 import Grating, LensMode, PsuMode
 from dodal.devices.electron_analyser import EnergySource
 from dodal.devices.electron_analyser.specs import SpecsDetector
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -22,8 +22,11 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory()
-def pgm() -> PGM:
-    return PGM(prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:", grating=Grating)
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=Grating,
+    )
 
 
 @device_factory()
diff --git a/src/dodal/beamlines/b07_1.py b/src/dodal/beamlines/b07_1.py
@@ -8,7 +8,7 @@
 )
 from dodal.devices.electron_analyser import EnergySource
 from dodal.devices.electron_analyser.specs import SpecsDetector
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -25,8 +25,11 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory()
-def pgm() -> PGM:
-    return PGM(prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:", grating=Grating)
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=Grating,
+    )
 
 
 # Connect will work again after this work completed
diff --git a/src/dodal/beamlines/i05.py b/src/dodal/beamlines/i05.py
@@ -1,7 +1,7 @@
 from dodal.beamline_specific_utils.i05_shared import pgm as i05_pgm
 from dodal.common.beamlines.beamline_utils import device_factory
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -18,5 +18,5 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory()
-def pgm() -> PGM:
+def pgm() -> PlaneGratingMonochromator:
     return i05_pgm()
diff --git a/src/dodal/beamlines/i05_1.py b/src/dodal/beamlines/i05_1.py
@@ -1,7 +1,7 @@
 from dodal.beamline_specific_utils.i05_shared import pgm as i05_pgm
 from dodal.common.beamlines.beamline_utils import device_factory
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -13,7 +13,7 @@
 
 
 @device_factory()
-def pgm() -> PGM:
+def pgm() -> PlaneGratingMonochromator:
     return i05_pgm()
 
 
diff --git a/src/dodal/beamlines/i09.py b/src/dodal/beamlines/i09.py
@@ -10,7 +10,7 @@
 from dodal.devices.electron_analyser import DualEnergySource
 from dodal.devices.electron_analyser.vgscienta import VGScientaDetector
 from dodal.devices.i09 import Grating, LensMode, PassEnergy, PsuMode
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -27,8 +27,8 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory()
-def pgm() -> PGM:
-    return PGM(
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
         prefix=f"{BeamlinePrefix(BL, suffix='J').beamline_prefix}-MO-PGM-01:",
         grating=Grating,
     )
diff --git a/src/dodal/beamlines/i09_2.py b/src/dodal/beamlines/i09_2.py
@@ -8,7 +8,7 @@
     UndulatorPhaseAxes,
 )
 from dodal.devices.i09.enums import Grating
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -25,8 +25,11 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory()
-def pgm() -> PGM:
-    return PGM(prefix=f"{PREFIX.beamline_prefix}-MO-PGM-01:", grating=Grating)
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-MO-PGM-01:",
+        grating=Grating,
+    )
 
 
 @device_factory()
diff --git a/src/dodal/beamlines/i10_optics.py b/src/dodal/beamlines/i10_optics.py
@@ -32,7 +32,7 @@
 
 # Imports taken from i10 while we work out how to deal with split end stations
 from dodal.devices.i10.i10_setting_data import I10Grating
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -59,9 +59,9 @@ def first_mirror() -> PiezoMirror:
 
 
 @device_factory()
-def pgm() -> PGM:
+def pgm() -> PlaneGratingMonochromator:
     "I10 Plane Grating Monochromator, it can change energy via pgm.energy.set(<energy>)"
-    return PGM(
+    return PlaneGratingMonochromator(
         prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
         grating=I10Grating,
         grating_pv="NLINES2",
diff --git a/src/dodal/beamlines/i17.py b/src/dodal/beamlines/i17.py
@@ -17,7 +17,7 @@
     UndulatorPhaseAxes,
 )
 from dodal.devices.i17.i17_apple2 import I17Apple2Controller
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -39,8 +39,8 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory(skip=True)
-def pgm() -> PGM:
-    return PGM(
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
         prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
         grating=I17Grating,
         grating_pv="NLINES2",
diff --git a/src/dodal/beamlines/i21.py b/src/dodal/beamlines/i21.py
@@ -8,7 +8,7 @@
     UndulatorPhaseAxes,
 )
 from dodal.devices.i21 import Grating
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -25,8 +25,8 @@ def synchrotron() -> Synchrotron:
 
 
 @device_factory()
-def pgm() -> PGM:
-    return PGM(
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
         prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
         grating=Grating,
     )
diff --git a/src/dodal/beamlines/k07.py b/src/dodal/beamlines/k07.py
@@ -4,7 +4,7 @@
     device_factory,
 )
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
@@ -27,5 +27,8 @@ class Grating(StrictEnum):
 
 # Grating does not exist yet - this class is a placeholder for when it does
 @device_factory(skip=True)
-def pgm() -> PGM:
-    return PGM(prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:", grating=Grating)
+def pgm() -> PlaneGratingMonochromator:
+    return PlaneGratingMonochromator(
+        prefix=f"{PREFIX.beamline_prefix}-OP-PGM-01:",
+        grating=Grating,
+    )
diff --git a/src/dodal/devices/pgm.py b/src/dodal/devices/pgm.py
@@ -7,7 +7,7 @@
 from ophyd_async.epics.motor import Motor
 
 
-class PGM(StandardReadable):
+class PlaneGratingMonochromator(StandardReadable):
     """
     Plane grating monochromator, it is use in soft x-ray beamline to generate monochromic beam.
     """
diff --git a/tests/devices/electron_analyser/conftest.py b/tests/devices/electron_analyser/conftest.py
@@ -28,7 +28,7 @@
     VGScientaSequence,
 )
 from dodal.devices.i09 import Grating
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.testing import patch_motor
 from tests.devices.electron_analyser.helper_util import (
     get_test_sequence,
@@ -56,7 +56,7 @@ async def dual_energy_source() -> DualEnergySource:
     patch_motor(dcm.energy_in_keV, initial_position=2.2)
 
     async with init_devices(mock=True):
-        pgm = PGM("PGM:", Grating)
+        pgm = PlaneGratingMonochromator("PGM:", Grating)
     patch_motor(pgm.energy, initial_position=500)
 
     async with init_devices(mock=True):
diff --git a/tests/devices/i10/test_i10_apple2.py b/tests/devices/i10/test_i10_apple2.py
@@ -35,7 +35,7 @@
     LinearArbitraryAngle,
 )
 from dodal.devices.i10.i10_setting_data import I10Grating
-from dodal.devices.pgm import PGM
+from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.testing import patch_motor
 from tests.devices.i10.test_data import (
     EXPECTED_ID_ENERGY_2_GAP_CALIBRATIONS_IDD_PKL,
@@ -94,9 +94,11 @@ async def mock_phase_axes(prefix: str = "BLXX-EA-DET-007:") -> UndulatorPhaseAxe
 
 
 @pytest.fixture
-async def mock_pgm(prefix: str = "BLXX-EA-DET-007:") -> PGM:
+async def mock_pgm(prefix: str = "BLXX-EA-DET-007:") -> PlaneGratingMonochromator:
     async with init_devices(mock=True):
-        mock_pgm = PGM(prefix=prefix, grating=I10Grating, grating_pv="NLINES2")
+        mock_pgm = PlaneGratingMonochromator(
+            prefix=prefix, grating=I10Grating, grating_pv="NLINES2"
+        )
     patch_motor(mock_pgm.energy)
     return mock_pgm
 
@@ -182,7 +184,7 @@ async def mock_id_energy(
 
 @pytest.fixture
 async def beam_energy(
-    mock_id_energy: InsertionDeviceEnergy, mock_pgm: PGM
+    mock_id_energy: InsertionDeviceEnergy, mock_pgm: PlaneGratingMonochromator
 ) -> BeamEnergy:
     async with init_devices(mock=True):
         beam_energy = BeamEnergy(id_energy=mock_id_energy, mono=mock_pgm.energy)
