Update of the undulator preprocessor and the xbpm preprocessor

Oct 13, 2025 by wbrum.org 52 views

Introduction

In recent developments, the Bluesky preprocessors have been enhanced to insert plans before an 'open_run' and after a 'close_run' message in the RunEngine. These preprocessors follow a similar pattern, and it is likely that more of these will be created in the future. To avoid duplicating the logic for this part, we propose creating a helper function that can be used across different preprocessors. In this article, we will discuss the creation of a preprocessor helper function, do_on_run, and its potential integration into the Bluesky framework.

Background

As of the recent pull requests on the Diamond Light Source's GitHub repositories, dodal and mx-bluesky, the Bluesky preprocessors have been modified to insert plans before an 'open_run' and after a 'close_run' message. These changes aim to improve the efficiency and flexibility of the preprocessors. However, the current implementation involves duplicating the logic for inserting plans, which can lead to maintenance and scalability issues.

Proposed Solution

To address the issue of duplicated logic, we propose creating a helper function, do_on_run, that can be used across different preprocessors. This function will take three parameters:

on_run_open: A function that will be executed when an 'open_run' message is seen in the RunEngine.
on_run_close: An optional function that will be executed when a 'close_run' message is seen in the RunEngine. If not provided, the function will default to None.
run_key: An optional parameter that specifies the key for the run. If not provided, the function will default to None.

The do_on_run function will be responsible for inserting plans before and after the specified run messages. By using this helper function, we can avoid duplicating the logic and make the preprocessors more maintainable and scalable.

Acceptance Criteria

To ensure that the proposed solution meets the requirements, we have established the following acceptance criteria:

Discussion with Bluesky: We will engage in a discussion with the Bluesky developers to determine whether this feature is something they would like to include in the Bluesky framework.
Implementation of the do_on_run function: We will add the do_on_run function to either the Bluesky or dodal framework, depending on the outcome of the discussion with the Bluesky developers.
Update of the undulator preprocessor and the xbpm preprocessor: We will update the undulator preprocessor in dodal and the xbpm preprocessor in mx-bluesky to use the do_on_run helper function.

Benefits of the Proposed Solution

The proposed solution offers several benefits, including:

Reduced duplication of logic: By using the do_on_run helper function, we can avoid duplicating the logic for inserting plans, making the preprocessors more maintainable and scalable.
Improved flexibility: The do_on_run function can be used across different preprocessors, making it easier to add new features and functionality.
Enhanced collaboration: By engaging with the Bluesky developers, we can ensure that the proposed solution meets their requirements and is aligned with their vision for the Bluesky framework.

Implementation Details

To implement the do_on_run function, we will follow these steps:

Create the do_on_run function: We will create a new function, do_on_run, that takes the three parameters mentioned earlier.
Implement the logic for inserting plans: We will implement the logic for inserting plans before and after the specified run messages.
Update the undulator preprocessor and the xbpm preprocessor: We will update the undulator preprocessor in dodal and the xbpm preprocessor in mx-bluesky to use the do_on_run helper function.

Conclusion

In conclusion, the proposed solution of creating a preprocessor helper function, do_on_run, offers several benefits, including reduced duplication of logic, improved flexibility, and enhanced collaboration. By engaging with the Bluesky developers and implementing the do_on_run function, we can make the preprocessors more maintainable and scalable, and ensure that the Bluesky framework meets the requirements of its users.

Future Work

In the future, we plan to continue working on the Bluesky preprocessors, exploring new features and functionality that can be added to the framework. We will also engage with the Bluesky developers to ensure that our work is aligned with their vision for the framework.

References

Acknowledgments

Q: What is the purpose of the preprocessor helper function, `do_on_run`?

A: The do_on_run function is designed to insert plans before and after the specified run messages in the RunEngine. This function aims to reduce duplication of logic and make the preprocessors more maintainable and scalable.

Q: How does the `do_on_run` function work?

A: The do_on_run function takes three parameters: on_run_open, on_run_close, and run_key. It inserts plans before and after the specified run messages, depending on the values of these parameters.

Q: What are the benefits of using the `do_on_run` function?

A: The benefits of using the do_on_run function include:

Reduced duplication of logic
Improved flexibility
Enhanced collaboration with the Bluesky developers

Q: How does the `do_on_run` function interact with the Bluesky framework?

A: The do_on_run function is designed to be integrated into the Bluesky framework. It will be used by the undulator preprocessor in dodal and the xbpm preprocessor in mx-bluesky.

Q: What is the current status of the `do_on_run` function?

A: The do_on_run function is currently in the development stage. We are working on implementing the logic for inserting plans and updating the undulator preprocessor and the xbpm preprocessor to use the do_on_run function.

Q: How can I contribute to the development of the `do_on_run` function?

A: If you are interested in contributing to the development of the do_on_run function, please contact the Bluesky developers or the Diamond Light Source. We welcome feedback and suggestions from the community.

Q: What are the next steps for the `do_on_run` function?

A: The next steps for the do_on_run function include:

Finalizing the implementation of the logic for inserting plans
Updating the undulator preprocessor and the xbpm preprocessor to use the do_on_run function
Engaging with the Bluesky developers to ensure that the do_on_run function meets their requirements

Q: How will the `do_on_run` function be maintained and updated in the future?

A: The do_on_run function will be maintained and updated by the Bluesky developers and the Diamond Light Source. We will work together to ensure that the function remains up-to-date and meets the evolving needs of the community.

Q: Can I use the `do_on_run` function in my own projects?

A: Yes, you can use the do_on_run function in your own projects. However, please note that the function is still in the development stage, and it may be subject to changes. We recommend waiting until the function is officially released before using it in production.

Q: Where can I find more information about the `do_on_run` function?

A: You can find more information about the do_on_run function on the Bluesky GitHub repository or by contacting the Bluesky developers or the Diamond Light Source.