MX3 Beamline Library

This repository hosts the code required for executing data collection plans on the MX3 beamline at the Australian Synchrotron.

Installation instructions

This project uses uv. To install the project without extra dependencies run

uv sync

To install extra dependencies and development dependencies (which may require access to private repositories hosted by the Australian synchrotron), run

uv sync --all-extras --group dev

Data Collection Plans

To facilitate data acquisition plans, we rely on Bluesky, an experiment orchestration tool. Bluesky interacts with hardware through the Ophyd library, which is a Python-based hardware abstraction layer.

The repository includes various data collection plans, each of which is detailed in the examples folder:

• Optical Centering
• X-ray Centering
• Tray Screening

Executing these plans in simulation mode is possible by setting the environment variable BL_ACTIVE=False. However, note that there might be some limitations since certain devices still need to interact with specific APIs (such as the SIMPLON-API or simulated SIMPLON-API) for complete functionality.

Ophyd Devices

To execute the plans mentioned above, we provide ophyd-devices for interaction with hardware components. These devices include:

• MD3 Goniometer
• ISARA Robot
• DECTRIS Detector
• Blackfly Camera

Algorithms

The repository also features algorithms which are used by the optical and x-ray centering plans (see e.g. the examples folder):

• Algorithms for crystal identification from raster data
• An algorithm to identify the tip of a loop

References

We acknowledge the use of external code in this repository:

• The MD3 exporter client used for communication is sourced from MXCUBE.
• The algorithm to identify the tip of the loop is based on code developed by PSI.