Update AdSim devices and configuration to use ophyd-async #405

DiamondJoseph · 2024-04-02T12:33:46Z

Fixes #404

Instructions to reviewer on how to test:

Run AdSimulator on workstation
export EPICS_CA_SERVER_PORT=6064, EPICS_CA_REPEATER_PORT=6065
Create an iPython terminal with access to dodal installation
Create a RunEngine (required for connection event loop)
Run the device factory functions and confirm they connect to the devices
pp = get_path_provider()
await pp.update()
run a simple scan with the device axes to confirm they run:
e.g. RE(count([adsim])), RE(scan([adsim], sim_motors.x, 0, 1, 5))

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

codecov · 2024-04-02T12:52:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.42%. Comparing base (52848b3) to head (84a3270).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #405      +/-   ##
==========================================
+ Coverage   95.20%   96.42%   +1.21%     
==========================================
  Files         120      116       -4     
  Lines        4984     4889      -95     
==========================================
- Hits         4745     4714      -31     
+ Misses        239      175      -64

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

stan-dot · 2024-07-09T10:17:08Z

@Relm-Arrowny you've done some simulation work for p99 afaik, how useful is this PR?

Relm-Arrowny · 2024-07-09T12:42:28Z

@Relm-Arrowny you've done some simulation work for p99 afaik, how useful is this PR?

It nice to have, at the moment I either use fake or something from bluesky.sim so being able to just add area detector without thinking about it would save time.

DiamondJoseph · 2024-07-09T12:46:21Z

How far does fake_with_ophyd_sim get you? Do you need something that is capable of writing files?

e.g.

def det(
    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = True
) -> AravisDetector:
    return device_instantiation(
        AravisDetector,
        "det",
        "-EA-MAP-01:",
        wait_for_connection,
        fake_with_ophyd_sim,
        directory_provider=get_directory_provider(),
    )

Relm-Arrowny · 2024-07-09T13:21:39Z

How far does fake_with_ophyd_sim get you? Do you need something that is capable of writing files?

It got me as far as getting arming/trigger to work so I can use it to test plans and emitted the right docs. This is an example of what I do atm.
As for writing file, I am not sure, atm I am not concern about writing files but I can see I may in the future.

src/dodal/devices/areadetector/adsim.py

src/dodal/devices/adsim.py

tests/common/beamlines/test_device_instantiation.py

src/dodal/beamlines/adsim.py

DominicOram

As someone who has never used the ADSim before I think this needs some more info. Ideally I would like a few system tests that spawn the ADSim and run some stuff tests against it using these files. If this is out of scope then I would at least like some documentation at the top of adsim.py pointing to how I would get started using the ADSim (and an issue to do the proper tests).

stan-dot · 2024-10-14T08:52:52Z

src/dodal/beamlines/adsim.py

+from pathlib import Path
+
+from ophyd_async.epics.adsimdetector import SimDetector
+
+from dodal.common.beamlines.beamline_utils import (
+    device_instantiation,
+    get_path_provider,
+    set_path_provider,
+)
+from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
+from dodal.common.visit import LocalDirectoryServiceClient, StaticVisitPathProvider
+from dodal.devices.adsim import SimStage
+from dodal.log import set_beamline as set_log_beamline
+from dodal.utils import get_hostname
+
+BL = get_hostname()
+set_log_beamline(BL)
+set_utils_beamline(BL)
+
+set_path_provider(
+    StaticVisitPathProvider(
+        BL,
+        Path("/scratch/adsim/bluesky"),
+        client=LocalDirectoryServiceClient(),
+    )
+)
+
+"""
+Usage Example
+-------------
+


needs explanation what adsim is, link do docs maybe

stan-dot · 2024-10-14T08:54:02Z

src/dodal/devices/areadetector/adaravis.py

-class AdAravisDetector(SingleTriggerV33, DetectorBase):
-    cam = Cpt(SynchronisedAdDriverBase, suffix="DET:")
-    hdf = Cpt(
-        Hdf5Writer,
-        suffix="HDF5:",
-        root="",
-        write_path_template="",
-    )
-    _priming_settings: Mapping[Signal, Any]
-
-    def __init__(self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-        self.hdf.kind = "normal"


why is AdAravis related?

The AdSim was a final remaining "used" ophyd device in this module, so with it being deleted the whole module may as well be removed.

DiamondJoseph · 2024-10-17T12:32:28Z

@ZohebShaikh re: discussion on docs and use: since the AD sim that we use on workstations isn't going to be containerised or available in exactly the same form outside of Diamond anytime soon, CF and I discussed and we can instead back it with the example Simulation Beamline that is spun up by EC:

https://epics-containers.github.io/main/tutorials/launch_example.html

It has fewer axes, but still has a camera and should be possible to run up from anywhere with the tutorial.

Please walk through the tutorial for this and alter the beamline to connect to these devices!

stan-dot · 2024-10-23T15:48:05Z

found a bug, possibly with #841 that when in ipython context a device does not connect while in the dodal connect beamlinename it does

from a debugging session with @DiamondJoseph

DiamondJoseph marked this pull request as draft April 2, 2024 12:33

DiamondJoseph force-pushed the adsim_async branch from e865779 to cb9d72d Compare April 3, 2024 08:19

stan-dot mentioned this pull request Jul 9, 2024

Convert all basic motion devices to ophyd-async #168

Open

ZohebShaikh force-pushed the adsim_async branch 2 times, most recently from ecab867 to 5e2187e Compare August 12, 2024 11:29

DiamondJoseph commented Aug 12, 2024

View reviewed changes

src/dodal/devices/areadetector/adsim.py Outdated Show resolved Hide resolved

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

tests/common/beamlines/test_device_instantiation.py Outdated Show resolved Hide resolved

src/dodal/beamlines/adsim.py Outdated Show resolved Hide resolved

ZohebShaikh marked this pull request as ready for review August 12, 2024 13:30

ZohebShaikh force-pushed the adsim_async branch from 28b38d4 to dab2061 Compare August 14, 2024 11:12

DiamondJoseph mentioned this pull request Sep 20, 2024

Update Copier Template to 2.2.0 #737

Merged

4 tasks

DiamondJoseph force-pushed the adsim_async branch from b79dc80 to 70d923b Compare September 20, 2024 12:00

ZohebShaikh requested a review from DominicOram September 20, 2024 12:18

DominicOram requested changes Sep 20, 2024

View reviewed changes

stan-dot approved these changes Oct 14, 2024

View reviewed changes

DiamondJoseph mentioned this pull request Oct 18, 2024

Update device factory docs #855

Closed

4 tasks

DiamondJoseph and others added 10 commits October 23, 2024 15:15

Adjust adsim to use ophyd_async implementations

c6e3fa2

Move adsim configuration to beamline, add beamline test

3679865

get DirectoryProvider, fix linting issue with hints

e7481b4

Use ophyd_async implementation of adsim

bbc9747

added code review changes

f0e8353

made changes for latest ophyd-async version

c3d4c64

added h5py in dependency list

2230e21

moved to epics Motor

cb01540

deleted unused ophyd 1 devices

62e825d

changed name to path_provider

d676a26

DiamondJoseph and others added 4 commits October 23, 2024 15:18

Delete dodal impl of SimDetector, update prefix values

955ad9e

linting

6525921

added docs for adsim

4d1b01a

partial update

84a3270

stan-dot force-pushed the adsim_async branch from 1cd0302 to 84a3270 Compare October 23, 2024 15:18

stan-dot added 2 commits October 23, 2024 15:27

adsim connects

6532dea

docstring changes

ebae0cf

ZohebShaikh added 2 commits November 14, 2024 09:13

Merge branch 'main' into adsim_async

10c39ce

Merge branch 'main' into adsim_async

055b074

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update AdSim devices and configuration to use ophyd-async #405

Update AdSim devices and configuration to use ophyd-async #405

DiamondJoseph commented Apr 2, 2024 •

edited

Loading

codecov bot commented Apr 2, 2024 •

edited

Loading

stan-dot commented Jul 9, 2024

Relm-Arrowny commented Jul 9, 2024

DiamondJoseph commented Jul 9, 2024

Relm-Arrowny commented Jul 9, 2024

DominicOram left a comment

stan-dot Oct 14, 2024

stan-dot Oct 14, 2024

DiamondJoseph Oct 17, 2024

DiamondJoseph commented Oct 17, 2024

stan-dot commented Oct 23, 2024 •

edited

Loading

Update AdSim devices and configuration to use ophyd-async #405

Are you sure you want to change the base?

Update AdSim devices and configuration to use ophyd-async #405

Conversation

DiamondJoseph commented Apr 2, 2024 • edited Loading

Instructions to reviewer on how to test:

Checks for reviewer

codecov bot commented Apr 2, 2024 • edited Loading

Codecov Report

stan-dot commented Jul 9, 2024

Relm-Arrowny commented Jul 9, 2024

DiamondJoseph commented Jul 9, 2024

Relm-Arrowny commented Jul 9, 2024

DominicOram left a comment

Choose a reason for hiding this comment

stan-dot Oct 14, 2024

Choose a reason for hiding this comment

stan-dot Oct 14, 2024

Choose a reason for hiding this comment

DiamondJoseph Oct 17, 2024

Choose a reason for hiding this comment

DiamondJoseph commented Oct 17, 2024

stan-dot commented Oct 23, 2024 • edited Loading

DiamondJoseph commented Apr 2, 2024 •

edited

Loading

codecov bot commented Apr 2, 2024 •

edited

Loading

stan-dot commented Oct 23, 2024 •

edited

Loading