Reflectometry: Training updates

[KathrynBaker]

As someone not familiar with the reflectometry server I want to be able to at least understand the creation and reading of configurations without encountering ruff/pyright issues, and with a little more description of what to do for the training

Acceptance Criteria

• The training is less reliant on code that no longer meets our standards, and that runs as expected immediately
• The training details more of the instrument set up to help clarify the interactions between the beamline motion and the reflectometry server so that I can create, update, and support configurations more readily
• All the different modes have some numbers that can be entered and checked to see how things change, this is mostly there for some early items, but would be beneficial for later ones
• Double check for system tests, if they don't exist and cover similar tests to those seen during training, write a ticket to create the system tests

Notes

• The existing training code predates the use of ruff and pyright
• There is a need to create configs and set up IOCs to run this, and this is not detailed anywhere at present

Discussed 01:17:30 - in planning 02/10/25

[KathrynBaker]

Proposing for twofold reasons, it is currently in my mind, and also as the reflectometers are in the next deploy group, the next comment will have notes for what needs to be done if this has to wait, or is picked up by someone else.

[KathrynBaker]

• Consider whether or not the branch is actually valid - would having the solutions in the web pages be better?
• Create a new config consisting of GALIL_01, GALIL_02, GALIL_03, and REFL_01
• Add jaws.cmd and axes.cmd in ...\Apps\EPICS\support\motorExtensions\master\settings\<computer name>\galil (examples in later comments)
• Update exercise 1 to build the file from scratch
• Remove considerations for blocks from the exercises - they are not needed in the same way
• Make sure that there are instruction on how to add a block for a REFL_01 PV
• Change the wording in exercise 2 to just use the helper function
• The different perspectives to use for each value to check is not clear (on the refl perspective the values should be 0, on the motor perspective they won't be, or it may be vice versa...) - note, a later exercise allows for the raw motor value to be viewed alongside the values wanted here, introducing that sooner may be wise
• Exercise 3 needs similar changes to exercise 2
• Exercise 5 make the use of autosave, and the requirement of it clearer
• Exercise 6 remove the references to a SECI workflow, consider removing the commenting all together
• Make sure numbers and expected numbers are added for Exercise 6 to help highlight the behaviour of autosave
• Exercise 7 could do with improvements to numbers and expected behaviours
• Make sure Exercise 8 is reworded to not need to reuse motors, as this training should be abstracted at least a little more
• Numbers and expected behaviours would be worthwhile for Exercise 8

[KathrynBaker]

Generic motor sertup that should cover what is needed (and matches the working code @KathrynBaker has)

Galil 01
01 - Jaws 1, North
02 - Jaws 1, South
03 - Jaws 1, East
04 - Jaws 1, West
05 - Jaws 2, North
06 - Jaws 2, South
07 - Jaws 2, East
08 - Jaws 2, West

Galil 02
01 - Detector Angle
02 - Detector Position
03 - Bench Front
04 - Bench Back
05 - Bench Slide
06 - Supermirror Position
07 - Supermirror Angle
08 - Monitor

Galil 03
01 - Slit 1 Offset
02 - Slit 2 Offset
03 -
04 -
05 - Sample Stack Translation
06 - Sample Stack Phi
07 - Sample Stack Height/Offset
08 - Sample Stack Psi

[KathrynBaker]

jaws.cmd example:

$(IFIOC_GALIL_01) dbLoadRecords("$(JAWS)/db/jaws.db","P=$(MYPVPREFIX)MOT:,JAWS=JAWS1:,mXN=MTR0101,mXS=MTR0102,mXW=MTR0104,mXE=MTR0103")
$(IFIOC_GALIL_01) dbLoadRecords("$(JAWS)/db/jaws.db","P=$(MYPVPREFIX)MOT:,JAWS=JAWS2:,mXN=MTR0105,mXS=MTR0106,mXW=MTR0108,mXE=MTR0107")

[KathrynBaker]

axes.cmd example:

$(IFIOC_GALIL_03) dbLoadRecords("$(AXIS)/db/axis.db","P=$(MYPVPREFIX)MOT:,AXIS=STACK:TRANS,mAXIS=MTR0305")
$(IFIOC_GALIL_03) dbLoadRecords("$(AXIS)/db/axis.db","P=$(MYPVPREFIX)MOT:,AXIS=STACK:HEIGHT,mAXIS=MTR0307")
$(IFIOC_GALIL_03) dbLoadRecords("$(AXIS)/db/axis.db","P=$(MYPVPREFIX)MOT:,AXIS=STACK:PHI,mAXIS=MTR0306")
$(IFIOC_GALIL_03) dbLoadRecords("$(AXIS)/db/axis.db","P=$(MYPVPREFIX)MOT:,AXIS=STACK:PSI,mAXIS=MTR0308")
$(IFIOC_GALIL_02) dbLoadRecords("$(AXIS)/db/axis.db","P=$(MYPVPREFIX)MOT:,AXIS=MONITOR,mAXIS=MTR0208")

[KathrynBaker]

If you want working examples check in with @KathrynBaker for them, although they are not ruff/pyright ready.