Update I24 serial docs #487
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,29 +4,125 @@ Roadmap | |
| For a closer look at the ongoing work: `I24ssx | ||
| board <https://github.com/orgs/DiamondLightSource/projects/10/views/2>`__ | ||
|
|
||
| Ongoing list of TODOs: | ||
|
|
||
| 1. Improve alignment of chip: get it to work correctly for multiple | ||
| zooms. | ||
|
|
||
| - Close to being completed (see issue #44) | ||
|
|
||
| 2. Refactor and fix the logger. | ||
| 3. Use callbacks for file IO, eg. to write parameter and map files, nexus writer and ispyb deposition. | ||
| 4. Solution for enabling users to run mx-bluesky instead of old scripts: blocked by permission issues. | ||
|
|
||
| - This should also allow us to stop using the Pilatus to make directories during an Eiger collection. | ||
| - The preferred permanent solution is to run mx-bluesky on the beamline kubernetes cluster. I24 should be due to get on in shutdown 4 2024. | ||
| - Other possibility is to run the ``blueapi`` server on procServ. An example of this has now been set up on ws002 on the beamline and is being tested. | ||
| - A temporary workaround in place for beamline staff, who should be starting to run this for testing/in house beamtimes. Staff have started using this set up in September 24. | ||
|
|
||
| 5. Convert detector set up to use bluesky plans and ophyd_async devices. | ||
|
|
||
| - Eiger device in dodal needs to be converted to ophyd_async and updated to work with different Eigers on several beamlines. This work is dependent on other work out of the scope of this project, see `Dodal#700 <https://github.com/DiamondLightSource/dodal/issues/700>`__ and linked issues. | ||
| - Investigate using the existing Pilatus in ophyd_async which writes HDF5 instead of CBFs, but we may want to make a CBF-writing Pilatus. However, the Pilatus detector is due to be removed soon. | ||
|
|
||
| 6. Start looking into moving away from edm screens towards a web-based GUI. | ||
|
|
||
| - Prepare generic react components to match the features in the edms. | ||
| - Components for things currently managed by general purpose PVs (eg. map). | ||
| - OAV viewer. | ||
|
|
||
| 7. Implementation of serial tools to be used at XFELS. | ||
|
|
||
| - Reinstate removed code from sacla and move it to bluesky. | ||
| - Add any plans/devices that might be needed for other locations. | ||
|
|
||
| 8. Reinstate full mapping code using bluesky. | ||
|
There was a problem hiding this comment. So this all assumes that we do not change how we run the SSX. Are there any plans for integrating panda and coming up with a more standard PVT way of running the scans? There was a problem hiding this comment. Integrating Panda, yes, at least for the fixed target, but I have no idea yet of a possible timeline so I was going to add it at a later time. There was a problem hiding this comment. A comment to that affect would be good |
||
|
|
||
| (TBC…) | ||
|
|
||
|
|
||
| .. list-table:: Rough Roadmap | ||
| :widths: 30 30 15 | ||
| :header-rows: 1 | ||
|
|
||
| * - Work Ongoing | ||
| - Rough Timeline | ||
| - Completed | ||
| * - Fully test extruder collections | ||
| - Nov. 24 | ||
| - :material-regular:`pending;2em` | ||
| * - Fix permissions and allow for user collections | ||
| - Dec. 24 / Jan. 25 | ||
| - :material-regular:`pending;2em` | ||
| * - Convert the current detector set up code to bluesky plans using the device | ||
| - Dependent on `FastCS Eiger issues <https://github.com/bluesky/ophyd-async/issues?q=is%3Aissue+is%3Aopen+eiger>`__ being completed | ||
| - :material-regular:`pending;2em` | ||
| * - Set up callback for nexus writing | ||
| - Dec. 24 | ||
| - :material-regular:`pending;2em` | ||
| * - Set up callback for ispyb deposition | ||
| - Dec. 24 | ||
| - :material-regular:`pending;2em` | ||
| * - Set up callback for parameter and map file I/O | ||
| - Dec. 24 | ||
| - :material-regular:`pending;2em` | ||
| * - Refactor logger | ||
| - Nov. 24 | ||
| - :material-regular:`pending;2em` | ||
| * - Improve current alignment (moveonclick) | ||
| - Nov. 24 | ||
| - :material-regular:`pending;2em` | ||
| * - Set up `coniql <https://github.com/DiamondLightSource/coniql>`__ on the beamline | ||
| - Jan. 25 | ||
| - :material-regular:`pending;2em` | ||
|
There was a problem hiding this comment. I believe |
||
| * - Prepare React components to switch from EDM to a web GUI | ||
| - Dec. 24 / Jan. 25 | ||
| - :material-regular:`pending;2em` | ||
| * - Move the OAV viewer to a web GUI | ||
| - Jan. 25 / Feb. 25 | ||
| - :material-regular:`pending;2em` | ||
|
|
||
|
|
||
| Experiment types required | ||
| ========================= | ||
|
|
||
| - Extruder | ||
|
|
||
| - Standard | ||
| - Pump probe | ||
|
|
||
| - Fixed target (probably about 80-85% of serial on I24) | ||
|
|
||
| - Standard chip collection – option for multiple exposures in each | ||
| spot | ||
| - Pump probe - see for short description | ||
| https://confluence.diamond.ac.uk/display/MXTech/Dynamics+and+fixed+targets | ||
|
|
||
| - Short delays | ||
| - Excite and visit again | ||
| - Long delays with fast shutter opening/closing | ||
|
|
||
| - (Future) Fixed target with rotation at each “window” (Preliminary | ||
| work done by beamline staff on the PMAC program | ||
| https://confluence.diamond.ac.uk/display/MXTech/Grids+with+rotations) | ||
|
|
||
| Details of zebra settings for each type: | ||
| https://confluence.diamond.ac.uk/display/MXTech/Zebra+settings+I24 | ||
|
|
||
| Note that most of the set up for the fixed target is actually done by | ||
| the PMAC via PMAC strings. | ||
|
|
||
|
|
||
|
|
||
| -------------- | ||
|
|
||
| Old roadmap for reference | ||
|
|
||
|
|
||
| +---------------------------------------+----------------+---------------------------------+ | ||
| | Work Ongoing | Rough Timeline | Completed | | ||
| +=======================================+================+=================================+ | ||
| | Document how to set up the current | Ongoing | :material-regular:`check;2em` | | ||
| | visit, deploy the edm screens and run | | | | ||
| | a simple collection | | | | ||
| +---------------------------------------+----------------+---------------------------------+ | ||
|
|
@@ -71,34 +167,3 @@ Ongoing list of things needed: | |
| | Tidy up original code and add some | Summer 23 | :material-regular:`check;2em` | | ||
| | tests | | | | ||
| +---------------------------------------+----------------+---------------------------------+ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could: I think docs should usually just reflect the state of things as they currently are rather than as they were. Unless you're worried that the person reading this may be used to the older way of running it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, I agree with just describing the latest version. In this case, I am a bit worried as scientists and users have been used until now to having to press the set parameters button for the collection to work. I think it may be worth leaving the comment for a bit while the staff gets used to it and then remove it at a later time - hopefully by the beginning of next run...