mx-bluesky#

Code CI Test Coverage Latest PyPI version Apache License

Contains code for working with Bluesky on MX beamlines at Diamond

Getting Started#

To get started with developing this repo at DLS run dls_dev_setup.sh.

If you want to develop interactively at the beamline we recommend using jupyter notebooks. You can get started with this by running:

$ ./start_jupyter.sh

If you’re doing more in-depth development we recommend developing with VSCode. You can do this at DLS by running:

$ module load vscode
$ code .vscode/mx-bluesky.code-workspace

How the documentation is structured#

The documentation consists of a Developer Guide for MX-Bluesky, which also includes documentation for Hyperion. At its current stage in development, there is no user guide.

The Developer Guide contains documentation on how to install, develop and contribute changes to MX-Bluesky; explanations about the purpose of the software and some of the technical concepts; as well as how-to guides and tutorials.

Developer Guide