dls-dodal 1.25.0__py3-none-any.whl → 1.26.0__py3-none-any.whl

{dls_dodal-1.25.0.dist-info → dls_dodal-1.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dls-dodal
-Version: 1.25.0
+Version: 1.26.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License: Apache License
@@ -213,6 +213,7 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: click
 Requires-Dist: ophyd
 Requires-Dist: ophyd-async >=0.3a5
 Requires-Dist: bluesky
@@ -265,6 +266,26 @@ Documentation  https://DiamondLightSource.github.io/dodal
 Releases       https://github.com/DiamondLightSource/dodal/releases
 ============== ==============================================================
 
+Testing Connectivity
+--------------------
+
+You can test your connection to a beamline if it's PVs are visible to your machine with:
+
+.. code:: shell
+
+    # On any workstation:
+    dodal connect <BEAMLINE>
+
+    # On a beamline workstation, this should suffice:
+    dodal connect ${BEAMLINE}
+
+
+For more options, including a list of valid beamlines, type
+
+.. code:: shell
+
+    dodal connect --help
+
 
 .. |code_ci| image:: https://github.com/DiamondLightSource/dodal/actions/workflows/code.yml/badge.svg?branch=main
     :target: https://github.com/DiamondLightSource/dodal/actions/workflows/code.yml

{dls_dodal-1.25.0.dist-info → dls_dodal-1.26.0.dist-info}/RECORD

@@ -1,47 +1,51 @@
 dodal/__init__.py,sha256=y-VRpfiX-Lm5nchB9N0VfMy_6dwFqVxpSn5SiAQql9I,114
-dodal/__main__.py,sha256=7KR7t1SPAAUdVsMV-ldVBTw1bQQajjeh7ZfzgG4DG6k,322
-dodal/_version.py,sha256=izUYmj1xhfFSjyCg70rnNBT10Bx8qXrG5Kr9-Eo8CH4,413
+dodal/__main__.py,sha256=kP2S2RPitnOWpNGokjZ1Yq-1umOtp5sNOZk2B3tBPLM,111
+dodal/_version.py,sha256=ZreJF-rILTr9IBCA-InSDMjl6Bdsh4uJHrXyWFkH87M,413
 dodal/adsim.py,sha256=OW2dcS7ciD4Yq9WFw4PN_c5Bwccrmu7R-zr-u6ZCbQM,497
+dodal/cli.py,sha256=z0UBESrNrq6Kq4rttp4uHcwS1fnOnRkKBRDHSriPpGY,2058
 dodal/log.py,sha256=grK5-c-V6UjMERwDqYPdKbc_BpycrNb8hP0uteLOVCY,8296
-dodal/utils.py,sha256=eBSYkFyAKMzPRppDD2FVRs45NjcOHNS5NM2jrQKZ3H4,7818
+dodal/utils.py,sha256=aH-W94t6NFOoGHZ7awbUKY8_k7qIYDourCFs3MKIjjA,10024
 dodal/beamline_specific_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/beamline_specific_utils/i03.py,sha256=Ixe1anFQl-kwRJubmQx28TIW4Zw8qDxpElNNNapWQHI,396
-dodal/beamlines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dodal/beamlines/_device_helpers.py,sha256=Dva35Cf2e-YX9H8fUoMcQ9K6X-5_ZkWRkoKFb-zv2V8,918
-dodal/beamlines/beamline_parameters.py,sha256=N22dtDLw3Hlo7EUmGxe4qFGcu7OnldwCz_mU7yK2rd0,3577
-dodal/beamlines/beamline_utils.py,sha256=qrRjbpsYWdFEHhrDzNWD5ETXqrCBOR2-O1gP3gG8l3g,4490
-dodal/beamlines/i03.py,sha256=GKD8iX_7p9bAuoUECQB1GSx9RGJzeEx0BJEIdd73wjA,15914
-dodal/beamlines/i04.py,sha256=eHHDyln_s_5_DbE9V2ktv2qfOlfwrRHHN4rOsS3-Ot8,12042
-dodal/beamlines/i04_1.py,sha256=rWBdKzNHqPWEwpK616PUMVSi_zLhX0f40HVq8drgobo,4717
-dodal/beamlines/i20_1.py,sha256=NCJdJ7htumHExFJww0-LzLtJcZX_KSTxK9e9KAeWy98,732
-dodal/beamlines/i22.py,sha256=m6S_F-jP4PFXdP056optvZt1AZ8Mxu5DF53QUn8S050,6634
-dodal/beamlines/i23.py,sha256=-KXU-x-WBPa_Vwy9h3yKOl9HGBSDjvIIcu8gOtGZYVo,1388
-dodal/beamlines/i24.py,sha256=pgUXceJRq3cOfMzBlsyex-ZiwhZTMFgvBuYWX1cQnl4,4555
-dodal/beamlines/p38.py,sha256=OrlfIYO__EqBhZWWSg3mCwGb5zyoTMGrjI2L6gr-SEE,6071
-dodal/beamlines/p45.py,sha256=T7EXD4LAvucoIr5MeLrDL1vsho4ELtzKDu2KLmFXziA,2943
+dodal/beamlines/README.md,sha256=K9MkL_GomxlsoTB7Mz-_dJA5NNSbmCfMiutchGg3C8o,404
+dodal/beamlines/__init__.py,sha256=U0dQYFEUloCdQOs24zyfpPTncJXOO4cDcfHSevVOAw4,2890
+dodal/beamlines/i03.py,sha256=BsqiPR-z1svEm0psbTtmW3FR69xcC7_pJqLc5Z27mSQ,15935
+dodal/beamlines/i04.py,sha256=2sa7qbNnIDK7r7d8-9Y296Fvzl8TzI_z_K2u7EsUQQw,12063
+dodal/beamlines/i04_1.py,sha256=KDxSUQNhIs_NFiRaLY-Jiory0DeN7Y0ErvGuoTrwCDU,4731
+dodal/beamlines/i20_1.py,sha256=XJpey1-XZnCVpjK6-tODRYeBofqV44BL8lK5OSdQgiI,746
+dodal/beamlines/i22.py,sha256=TlXgAuRYM4JS733tyZyLMYDyC7ajwg85_XzYI5qh46U,7574
+dodal/beamlines/i23.py,sha256=iEFkrA4sPQsRLGAmeD263jPMX4u2SF1NK4_KYqnVwow,1402
+dodal/beamlines/i24.py,sha256=87ugX8yAv1gqpwskl4RDjqZPraySeD0TDJylI6zUytQ,4569
+dodal/beamlines/p38.py,sha256=0uRL4GVs1sGobr0BZpDDbtStNJcipT6o4FvoA_OWLaE,7120
+dodal/beamlines/p45.py,sha256=TNIkC-SBfj0ayZtlLLXW9xCSi5CzJkO8XpAMIo8fjao,2957
 dodal/common/__init__.py,sha256=ZC4ICKUDB0BDxRaVy8nmqclVmDBne-dPtk6UJsoFq6I,258
 dodal/common/coordination.py,sha256=psJ-UWNk4w9YUy-1Vc-CpSn9ea_Ugs2pY5wFKA7JBEY,1133
 dodal/common/maths.py,sha256=JRSBhbMzwlicKp1_Bsfu9gA79JJA_Dgq9EpbExFH65M,1829
 dodal/common/types.py,sha256=M0gZs9F7--gREF8VYJn-Y1Mt9mIEgp1aLY3oUpUkSno,546
 dodal/common/udc_directory_provider.py,sha256=zNlt_VgdAlyBtVN7neTHk_0tWBbI4pPUL7q9WQOzXvo,1260
-dodal/common/visit.py,sha256=vyyFhk8nxfm3SMucshqwkUozOXb7wqqQF_qs9BimgEo,7538
+dodal/common/visit.py,sha256=8q-cee1r59tU_ywsxBvUzRMyP3Mn6zRHbE-pQAzBPVM,7545
+dodal/common/beamlines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dodal/common/beamlines/beamline_parameters.py,sha256=N22dtDLw3Hlo7EUmGxe4qFGcu7OnldwCz_mU7yK2rd0,3577
+dodal/common/beamlines/beamline_utils.py,sha256=AgmH9wpnFQ4DHAA7_Yo0COa2piX2ksFxukFt2_600kA,4488
+dodal/common/beamlines/device_helpers.py,sha256=s79js7no9k8JMfG7NvdmFomSP5m5VDQ6th_Hsbx1znA,939
 dodal/devices/CTAB.py,sha256=_MfL_KH4uDPxq_RuHFEZ9HVXOpUnQb5be3csoz9DdAs,1630
 dodal/devices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/devices/adsim.py,sha256=dMU0TKIuiODHYFHQOH4_5UvB8iJtaJEtjqaEDGjcU-w,311
 dodal/devices/aperture.py,sha256=0MtTzKMDZ5DVAz0DE0kXI0M76VCp0y9vFsrMggEMpxk,586
 dodal/devices/aperturescatterguard.py,sha256=2T1VKzE3-mb9hocZtHRwRqC4Eh_M_r8lCmiYwU_mndE,9906
-dodal/devices/attenuator.py,sha256=b6IsFZqplo8PREabV2tsyFuQAflN9oBM1zCuTuW2_S0,5487
+dodal/devices/attenuator.py,sha256=OD7fElTIMHWk7ZopPqEu29lionm7WwgC0-Kvl8vBIb0,2599
 dodal/devices/backlight.py,sha256=9BJcAg1f1kGRlb7bNzeltSDlpBXcxjcW90f87ewnj5k,562
 dodal/devices/beamstop.py,sha256=8L3qhlk-3ZBOp10xK1i8qZqYTGOXX1mVF1MgXoN0dfg,215
 dodal/devices/cryostream.py,sha256=6MU4rXIOL33C-8F3DVfAtv0ZnwiysTtawjkeePd5IrQ,332
 dodal/devices/dcm.py,sha256=vfyGYDzfSwTiNqlzkfNjkrL-Q1hNVSgJddvJ5Un_lvg,1610
-dodal/devices/eiger.py,sha256=6r08BWa-RNs8TK0x1OC3HmyyKAEuiA5vqDEd9q5rJEI,13403
-dodal/devices/eiger_odin.py,sha256=cKPYkTXvhjF7xzXeaC7JnbnKWyJpF95vqPIqdqXXuZw,6914
+dodal/devices/eiger.py,sha256=NE4tHdqgUZpUxJLQbd5lLUIHZcpeotppexJGlDNByzM,13868
+dodal/devices/eiger_odin.py,sha256=U5Byb7uNwDdNscBRp7yBYQrsjKrKXl2l5WdSpL09lAw,6980
 dodal/devices/fast_grid_scan.py,sha256=cbM6Jqcu7Gao0zFH6u8iTuJfojDDYs0AvseAnRs8iMg,12134
 dodal/devices/fluorescence_detector_motion.py,sha256=RrXfPmJzWnAjcjp9u0AnJEfjvWPMKburVTySB2hxYbw,181
 dodal/devices/flux.py,sha256=RtPStHw7Mad0igVKntKWVZfuZn2clokVJqH14HLix6M,198
-dodal/devices/focusing_mirror.py,sha256=5rEa6RC-bxBvH-TSksQelCs9Xcx1AOhSilyDaNhYn1o,6430
+dodal/devices/focusing_mirror.py,sha256=aRqBkE3OgaXpH6lP3v1VbSYgHsMMbSsPPXzeyAGf_Pg,6435
 dodal/devices/ipin.py,sha256=OGMXwAE4KDDonZRPFkUmR9Vsk6X4Ox-hEvPT5drP-mQ,208
+dodal/devices/linkam3.py,sha256=TPhiQ1D9i_HIlKHAlfnVfX7H6aPOAeXPEJLdmvwdKWQ,3776
 dodal/devices/logging_ophyd_device.py,sha256=xw4lbyqq5_ehESGterVEfubJsBiJTWvBp5b9k62gSkg,666
 dodal/devices/lower_gonio_stages.py,sha256=oJ_Xeuqs5E8AWAoZX52jD1qV6pCSjCOjdwnXFKz_xjw,229
 dodal/devices/motors.py,sha256=aKtMv5q_4b1eFhzyuk2-D6zDsY_6cqAmG59y5LWUz1s,1328
@@ -50,7 +54,6 @@ dodal/devices/panda_fast_grid_scan.py,sha256=cQmrs3pQ3P_J1e5C1IOdjDZibRthIHjqY98
 dodal/devices/qbpm1.py,sha256=OY7-WbdxMiLGUK8Z57ezwqSXbHxoPP-y3GvBgj9kgMA,220
 dodal/devices/robot.py,sha256=ITMKXiA83KVCAVI3ZpN-wWCLj62uDmxLBFO3PUheaRg,2379
 dodal/devices/s4_slit_gaps.py,sha256=j3kgF9WfGFaU9xdUuiAh-QqI5u_vhiAftaDVINt91SM,243
-dodal/devices/sample_shutter.py,sha256=XsaEgmJBRPdB9YwgIda_T3trdLI_u0Ogw0Mn-LsCMI8,628
 dodal/devices/scatterguard.py,sha256=0qnvhoo3RjLsrxVgIoDJpryqunlgMVgaTsoyKRC2g4Y,331
 dodal/devices/scintillator.py,sha256=4Dej1a6HRom9GRwTDsaTKGfvloP20POUqIeHqsI8-R8,184
 dodal/devices/slits.py,sha256=URru9VN2N19KqeUPDZaBmyKYn0_JJiE0Vko4sZpfsl8,601
@@ -59,11 +62,12 @@ dodal/devices/status.py,sha256=TuUGidZ4Ar-WCRc_sX0wn58DmL6brj1pMr8rNF5Z6VU,1198
 dodal/devices/synchrotron.py,sha256=E5vcSum-zoD5vIZxa2Xcl0gAkeRqY6a-AfZQICCwLHg,1947
 dodal/devices/tetramm.py,sha256=dHA15KkJhBHwtmbivDua_aVqFbvK47TVQG7KXmn8jQ8,8041
 dodal/devices/turbo_slit.py,sha256=W3ZRIqDhq4iMhr5GcIiWvl2U1GaPtGanqkL7upQOZTY,1132
-dodal/devices/undulator.py,sha256=74uYuwch10dzvP3lKWuHl9SoFHwrRngyFtM9ZOkQzWc,1061
-dodal/devices/undulator_dcm.py,sha256=ugvIwGyh3SoAdKyVRZGUsL6yt7-zaC6lsN8FmSaDSXY,5180
+dodal/devices/undulator.py,sha256=kn84MQpuBHtQj7H7HeBoAYKXu5buGKvTgs3tf2gdEdw,2074
+dodal/devices/undulator_dcm.py,sha256=TC9fO55r1YIG_88PPbGGtzfjcRJcaoC2ny51JiDOEX4,5199
 dodal/devices/webcam.py,sha256=dvNWJ6hHQR7BUsMRC9TH4XiCCofVhlgZ8HYfVCvd2og,1367
 dodal/devices/xbpm_feedback.py,sha256=a4evzdoMANbwoboQCbdMkcrxRogXLnHs966SZJsywYQ,1521
 dodal/devices/zebra.py,sha256=XE2oEm6kLkXd86ev4dYP8bh3tI9Fesb1SmU61RSMHBA,9082
+dodal/devices/zebra_controlled_shutter.py,sha256=MqX4KE6w0FliZRDBltswcLCNSsp6vQrD_iBY640IljI,1094
 dodal/devices/areadetector/__init__.py,sha256=8IwLxuZMW0MOJpJp_ZDdlaE20hrtsH_PXWGaKgMiYs4,240
 dodal/devices/areadetector/adaravis.py,sha256=pwbmmnakarjhD59XoyAIXJdakS-nqDG09Xmwq17AVw4,3787
 dodal/devices/areadetector/adsim.py,sha256=3U7kS93RM3Xeh-XWKjeuw5jXbIGWAbrs59LfxtvB7OU,1907
@@ -73,12 +77,12 @@ dodal/devices/detector/__init__.py,sha256=XEwjopgTtBq93RRuFthVVVI9DT1jUvpOJzWOHa
 dodal/devices/detector/det_dim_constants.py,sha256=MZ4w2nsTKzj4eN7yGsSs1pqKWIuU4vc6UzcSll02uWg,2305
 dodal/devices/detector/det_dist_to_beam_converter.py,sha256=f6JFp-eEB2v8NzZg27UrN0VDP5CMjRnaPU6BTA7_n_s,1937
 dodal/devices/detector/det_resolution.py,sha256=aQkKp24LpRGiwzPAQM3wLVa4ANw32HdrKc2kftHfKQA,3253
-dodal/devices/detector/detector.py,sha256=spRf_l9FOdLOjMMmKkdd-FJ3rHT3oAXB2GZ_ayS6vCs,4526
+dodal/devices/detector/detector.py,sha256=UDw_hLbhfUo_ECasGQ_Ud8bVQzE9D8uaAMagVAa_R4g,4647
 dodal/devices/detector/detector_motion.py,sha256=REREva2kyPcIzOZmahN9rT0jDSuUbV0qUDl4IcBnutA,1221
 dodal/devices/i03/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/devices/i04/transfocator.py,sha256=uieByXIj0JRbmvMB_om5NOAEbEJkzfkCD24bl2aEo1g,3154
 dodal/devices/i20_1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dodal/devices/i22/fswitch.py,sha256=PKMrgsJ_DT0G865VEIlNhC_DwES17ypNuYdVsQFgvtg,1735
+dodal/devices/i22/fswitch.py,sha256=AdYtnkCBuhivyJGZqelg_7sjB2pHN7vl1JTtlO4vHo4,3061
 dodal/devices/i23/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dodal/devices/i23/gonio.py,sha256=cxqD2Kd578c4-K4h2sHdJjoap2gPGC46Qr4SPudHLTs,864
 dodal/devices/i24/I24_detector_motion.py,sha256=bKbb44Qs24oguwJ780N4e5XGNtka_3ZZCGGq6BQu99Y,229
@@ -109,8 +113,9 @@ dodal/devices/zocalo/zocalo_interaction.py,sha256=B6TBTDwUlluksLTwC4TiEEgfFzWLOm
 dodal/devices/zocalo/zocalo_results.py,sha256=U4Vk4OF-eL8w0BR-fbw3k4jyRo6G3Ywaf8NMAkjr4Hs,9658
 dodal/parameters/experiment_parameter_base.py,sha256=O7JamfuJ5cYHkPf9tsHJPqn-OMHTAGouigvM1cDFehE,313
 dodal/plans/check_topup.py,sha256=VOkHak88_r-pdTsSnwAJnbvlK2_UhKnO5I36pJmWKvQ,2985
-dls_dodal-1.25.0.dist-info/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-dls_dodal-1.25.0.dist-info/METADATA,sha256=Wk1-HZALxYm9H-aFDgXey-voV4SQQt8my-m5nwNa_Rs,16420
-dls_dodal-1.25.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-dls_dodal-1.25.0.dist-info/top_level.txt,sha256=xIozdmZk_wmMV4wugpq9-6eZs0vgADNUKz3j2UAwlhc,6
-dls_dodal-1.25.0.dist-info/RECORD,,
+dls_dodal-1.26.0.dist-info/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+dls_dodal-1.26.0.dist-info/METADATA,sha256=0fEtRaibwFzXvFI-JP3xbxw29Sp_H1ocnv23eMgU5xk,16837
+dls_dodal-1.26.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+dls_dodal-1.26.0.dist-info/entry_points.txt,sha256=wpzz9FsTiYxI8OBwLKX9V9ResLwThBSmtRMcPwII0FA,46
+dls_dodal-1.26.0.dist-info/top_level.txt,sha256=xIozdmZk_wmMV4wugpq9-6eZs0vgADNUKz3j2UAwlhc,6
+dls_dodal-1.26.0.dist-info/RECORD,,

dls_dodal-1.26.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dodal = dodal.__main__:main

dodal/__main__.py

@@ -1,16 +1,8 @@
-from argparse import ArgumentParser
-
-from . import __version__
+from .cli import main
 
 __all__ = ["main"]
 
 
-def main(args=None):
-    parser = ArgumentParser()
-    parser.add_argument("-v", "--version", action="version", version=__version__)
-    args = parser.parse_args(args)
-
-
 # test with: python -m dodal
 if __name__ == "__main__":
     main()

dodal/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.25.0'
-__version_tuple__ = version_tuple = (1, 25, 0)
+__version__ = version = '1.26.0'
+__version_tuple__ = version_tuple = (1, 26, 0)

dodal/beamlines/README.md

@@ -0,0 +1,3 @@
+# Beamlines
+
+Beamline modules are code-as-configuration. They define the set of devices and common device settings needed for a particular beamline or group of similar beamlines (e.g. a beamline and its digital twin). Some of our tooling depends on the convention of _only_ beamline modules going in this package. Common utilities should go somewhere else e.g. `dodal.utils` or `dodal.beamlines.common`.

dodal/beamlines/__init__.py

@@ -0,0 +1,85 @@
+import importlib.util
+from functools import lru_cache
+from pathlib import Path
+from typing import Iterable, Mapping
+
+# Where beamline names (per the ${BEAMLINE} environment variable don't always
+# match up, we have to map between them bidirectionally). The most common use case is
+# beamlines with a "-"" in the name such as "i04-1", which is not valid in a Python
+# module name. Add any new beamlines whose name differs from their module name to this
+# dictionary, which maps ${BEAMLINE} to dodal.beamlines.<MODULE NAME>
+_BEAMLINE_NAME_OVERRIDES = {
+    "i04-1": "i04_1",
+    "i20-1": "i20_1",
+    "s03": "i03",
+}
+
+
+def all_beamline_modules() -> Iterable[str]:
+    """
+    Get the names of all importable modules in beamlines
+
+    Returns:
+        Iterable[str]: Generator of beamline module names
+    """
+
+    # This is done by inspecting file names rather than modules to avoid
+    # premature importing
+    spec = importlib.util.find_spec(__name__)
+    if spec is not None:
+        search_paths = [Path(path) for path in spec.submodule_search_locations]
+        for path in search_paths:
+            for subpath in path.glob("**/*"):
+                if (
+                    subpath.name.endswith(".py")
+                    and subpath.name != "__init__.py"
+                    and ("__pycache__" not in str(subpath))
+                ):
+                    yield subpath.with_suffix("").name
+    else:
+        raise KeyError(f"Unable to find {__name__} module")
+
+
+def all_beamline_names() -> Iterable[str]:
+    """
+    Get the names of all beamlines as per the ${BEAMLINE} environment variable
+
+    Returns:
+        Iterable[str]: Generator of beamline names that dodal supports
+    """
+    inverse_mapping = _module_name_overrides()
+    for module_name in all_beamline_modules():
+        yield from inverse_mapping.get(module_name, set()).union({module_name})
+
+
+@lru_cache
+def _module_name_overrides() -> Mapping[str, set[str]]:
+    """
+    Get the inverse of _BEAMLINE_NAME_OVERRIDES so that modules can be mapped back to
+    beamlines. _BEAMLINE_NAME_OVERRIDES is expected to be a constant so the return
+    value is cached.
+
+    Returns:
+        Mapping[str, set[str]]: A dictionary mapping the name of a dodal module to the
+        set of beamlines it supports.
+    """
+
+    inverse_mapping: dict[str, set[str]] = {}
+    for beamline, module in _BEAMLINE_NAME_OVERRIDES.items():
+        inverse_mapping[module] = inverse_mapping.get(module, set()).union({beamline})
+    return inverse_mapping
+
+
+def module_name_for_beamline(beamline: str) -> str:
+    """
+    Get the module name for a particular beamline, it may differ from the beamline
+    name e.g. i04-1 -> i04_1
+
+    Args:
+        beamline: The beamline name as per the ${BEAMLINE} environment variable
+
+    Returns:
+        str: The importable module name
+    """
+
+    return _BEAMLINE_NAME_OVERRIDES.get(beamline, beamline)

dodal/beamlines/i03.py

@@ -1,11 +1,11 @@
 from ophyd_async.panda import HDFPanda
 
-from dodal.beamlines.beamline_utils import (
+from dodal.common.beamlines.beamline_utils import (
     device_instantiation,
     get_directory_provider,
     set_directory_provider,
 )
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.common.udc_directory_provider import PandASubdirectoryProvider
 from dodal.devices.aperturescatterguard import AperturePositions, ApertureScatterguard
 from dodal.devices.attenuator import Attenuator
@@ -23,7 +23,6 @@ from dodal.devices.panda_fast_grid_scan import PandAFastGridScan
 from dodal.devices.qbpm1 import QBPM1
 from dodal.devices.robot import BartRobot
 from dodal.devices.s4_slit_gaps import S4SlitGaps
-from dodal.devices.sample_shutter import SampleShutter
 from dodal.devices.smargon import Smargon
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.undulator import Undulator
@@ -32,6 +31,7 @@ from dodal.devices.webcam import Webcam
 from dodal.devices.xbpm_feedback import XBPMFeedback
 from dodal.devices.xspress3_mini.xspress3_mini import Xspress3Mini
 from dodal.devices.zebra import Zebra
+from dodal.devices.zebra_controlled_shutter import ZebraShutter
 from dodal.devices.zocalo import ZocaloResults
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name, skip_device
@@ -394,12 +394,12 @@ def panda(
 @skip_device(lambda: BL == "s03")
 def sample_shutter(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> SampleShutter:
+) -> ZebraShutter:
     """Get the i03 sample shutter device, instantiate it if it hasn't already been.
     If this is called when already instantiated in i03, it will return the existing object.
     """
     return device_instantiation(
-        SampleShutter,
+        ZebraShutter,
         "sample_shutter",
         "-EA-SHTR-01:",
         wait_for_connection,

dodal/beamlines/i04.py

@@ -1,5 +1,5 @@
-from dodal.beamlines.beamline_utils import device_instantiation
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import device_instantiation
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.aperturescatterguard import AperturePositions, ApertureScatterguard
 from dodal.devices.attenuator import Attenuator
 from dodal.devices.backlight import Backlight
@@ -15,12 +15,12 @@ from dodal.devices.ipin import IPin
 from dodal.devices.motors import XYZPositioner
 from dodal.devices.oav.oav_detector import OAV, OAVConfigParams
 from dodal.devices.s4_slit_gaps import S4SlitGaps
-from dodal.devices.sample_shutter import SampleShutter
 from dodal.devices.smargon import Smargon
 from dodal.devices.synchrotron import Synchrotron
 from dodal.devices.undulator import Undulator
 from dodal.devices.xbpm_feedback import XBPMFeedbackI04
 from dodal.devices.zebra import Zebra
+from dodal.devices.zebra_controlled_shutter import ZebraShutter
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name, skip_device
 
@@ -110,12 +110,12 @@ def beamstop(
 
 def sample_shutter(
     wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
-) -> SampleShutter:
+) -> ZebraShutter:
     """Get the i04 sample shutter device, instantiate it if it hasn't already been.
     If this is called when already instantiated in i04, it will return the existing object.
     """
     return device_instantiation(
-        SampleShutter,
+        ZebraShutter,
         "sample_shutter",
         "-EA-SHTR-01:",
         wait_for_connection,

dodal/beamlines/i04_1.py

@@ -1,5 +1,5 @@
-from dodal.beamlines.beamline_utils import device_instantiation
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import device_instantiation
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.backlight import Backlight
 from dodal.devices.detector import DetectorParams
 from dodal.devices.eiger import EigerDetector

dodal/beamlines/i20_1.py

@@ -1,5 +1,5 @@
-from dodal.beamlines.beamline_utils import device_instantiation
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import device_instantiation
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.turbo_slit import TurboSlit
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import get_beamline_name

dodal/beamlines/i22.py

@@ -3,23 +3,22 @@ from pathlib import Path
 from ophyd_async.epics.areadetector import AravisDetector, PilatusDetector
 from ophyd_async.panda import HDFPanda
 
-from dodal.beamlines.beamline_utils import (
+from dodal.common.beamlines.beamline_utils import (
     device_instantiation,
     get_directory_provider,
     set_directory_provider,
 )
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.device_helpers import numbered_slits
 from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitDirectoryProvider
 from dodal.devices.focusing_mirror import FocusingMirror
 from dodal.devices.i22.fswitch import FSwitch
+from dodal.devices.linkam3 import Linkam3
 from dodal.devices.slits import Slits
 from dodal.devices.tetramm import TetrammDetector
+from dodal.devices.undulator import Undulator
 from dodal.log import set_beamline as set_log_beamline
-from dodal.utils import get_beamline_name, skip_device
-
-from ._device_helpers import numbered_slits
-from .beamline_utils import device_instantiation, get_directory_provider
-from .beamline_utils import set_beamline as set_utils_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name, skip_device
 
 BL = get_beamline_name("i22")
 set_log_beamline(BL)
@@ -123,6 +122,22 @@ def hfm(
     )
 
 
+def undulator(
+    wait_for_connection: bool = True,
+    fake_with_ophyd_sim: bool = False,
+) -> Undulator:
+    return device_instantiation(
+        Undulator,
+        "undulator",
+        f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+        bl_prefix=False,
+        poles=80,
+        length=2.0,
+    )
+
+
 def slits_1(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -200,13 +215,15 @@ def fswitch(
         "-MO-FSWT-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
+        lens_geometry="paraboloid",
+        cylindrical=True,
+        lens_material="Beryllium",
     )
 
 
 # Must find which PandA IOC(s) are compatible
 # Must document what PandAs are physically connected to
 # See: https://github.com/bluesky/ophyd-async/issues/284
-@skip_device
 def panda1(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = False,
@@ -214,9 +231,10 @@ def panda1(
     return device_instantiation(
         HDFPanda,
         "panda1",
-        "-MO-PANDA-01:",
+        "-EA-PANDA-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
+        directory_provider=get_directory_provider(),
     )
 
 
@@ -228,9 +246,10 @@ def panda2(
     return device_instantiation(
         HDFPanda,
         "panda2",
-        "-MO-PANDA-02:",
+        "-EA-PANDA-02:",
         wait_for_connection,
         fake_with_ophyd_sim,
+        directory_provider=get_directory_provider(),
     )
 
 
@@ -242,9 +261,10 @@ def panda3(
     return device_instantiation(
         HDFPanda,
         "panda3",
-        "-MO-PANDA-03:",
+        "-EA-PANDA-03:",
         wait_for_connection,
         fake_with_ophyd_sim,
+        directory_provider=get_directory_provider(),
     )
 
 
@@ -256,9 +276,10 @@ def panda4(
     return device_instantiation(
         HDFPanda,
         "panda4",
-        "-MO-PANDA-04:",
+        "-EA-PANDA-04:",
         wait_for_connection,
         fake_with_ophyd_sim,
+        directory_provider=get_directory_provider(),
     )
 
 
@@ -275,3 +296,16 @@ def oav(
         hdf_suffix="HDF5:",
         directory_provider=get_directory_provider(),
     )
+
+
+@skip_device
+def linkam(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> Linkam3:
+    return device_instantiation(
+        Linkam3,
+        "linkam",
+        "-EA-TEMPC-05",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )

dodal/beamlines/i23.py

@@ -1,5 +1,5 @@
-from dodal.beamlines.beamline_utils import device_instantiation
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import device_instantiation
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.i23.gonio import Gonio
 from dodal.devices.oav.pin_image_recognition import PinTipDetection
 from dodal.log import set_beamline as set_log_beamline

dodal/beamlines/i24.py

@@ -1,5 +1,5 @@
-from dodal.beamlines.beamline_utils import BL, device_instantiation
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import BL, device_instantiation
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.devices.detector import DetectorParams
 from dodal.devices.eiger import EigerDetector
 from dodal.devices.i24.dual_backlight import DualBacklight

dodal/beamlines/p38.py

@@ -3,22 +3,22 @@ from pathlib import Path
 from ophyd_async.epics.areadetector import AravisDetector
 from ophyd_async.panda import HDFPanda
 
-from dodal.beamlines.beamline_utils import (
+from dodal.common.beamlines.beamline_utils import (
     device_instantiation,
     get_directory_provider,
     set_directory_provider,
 )
-from dodal.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.beamlines.device_helpers import numbered_slits
 from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitDirectoryProvider
 from dodal.devices.focusing_mirror import FocusingMirror
+from dodal.devices.i22.fswitch import FSwitch
+from dodal.devices.linkam3 import Linkam3
 from dodal.devices.slits import Slits
 from dodal.devices.tetramm import TetrammDetector
+from dodal.devices.undulator import Undulator
 from dodal.log import set_beamline as set_log_beamline
-from dodal.utils import get_beamline_name, skip_device
-
-from ._device_helpers import numbered_slits
-from .beamline_utils import device_instantiation, get_directory_provider
-from .beamline_utils import set_beamline as set_utils_beamline
+from dodal.utils import BeamlinePrefix, get_beamline_name, skip_device
 
 BL = get_beamline_name("p38")
 set_log_beamline(BL)
@@ -172,6 +172,22 @@ def slits_6(
     )
 
 
+def fswitch(
+    wait_for_connection: bool = True,
+    fake_with_ophyd_sim: bool = True,
+) -> FSwitch:
+    return device_instantiation(
+        FSwitch,
+        "fswitch",
+        "-MO-FSWT-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+        lens_geometry="paraboloid",
+        cylindrical=True,
+        lens_material="Beryllium",
+    )
+
+
 def vfm(
     wait_for_connection: bool = True,
     fake_with_ophyd_sim: bool = True,
@@ -198,6 +214,22 @@ def hfm(
     )
 
 
+def undulator(
+    wait_for_connection: bool = True,
+    fake_with_ophyd_sim: bool = True,
+) -> Undulator:
+    return device_instantiation(
+        Undulator,
+        "undulator",
+        f"{BeamlinePrefix(BL).insertion_prefix}-MO-SERVC-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+        bl_prefix=False,
+        poles=80,
+        length=2.0,
+    )
+
+
 # Must find which PandA IOC(s) are compatible
 # Must document what PandAs are physically connected to
 # See: https://github.com/bluesky/ophyd-async/issues/284
@@ -209,7 +241,7 @@ def panda1(
     return device_instantiation(
         HDFPanda,
         "panda1",
-        "-MO-PANDA-01:",
+        "-EA-PANDA-01:",
         wait_for_connection,
         fake_with_ophyd_sim,
         directory_provider=get_directory_provider(),
@@ -224,7 +256,7 @@ def panda2(
     return device_instantiation(
         HDFPanda,
         "panda2",
-        "-MO-PANDA-02:",
+        "-EA-PANDA-02:",
         wait_for_connection,
         fake_with_ophyd_sim,
         directory_provider=get_directory_provider(),
@@ -239,8 +271,21 @@ def panda3(
     return device_instantiation(
         HDFPanda,
         "panda3",
-        "-MO-PANDA-03:",
+        "-EA-PANDA-03:",
         wait_for_connection,
         fake_with_ophyd_sim,
         directory_provider=get_directory_provider(),
     )
+
+
+@skip_device
+def linkam(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> Linkam3:
+    return device_instantiation(
+        Linkam3,
+        "linkam",
+        "-EA-LINKM-02:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )