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 is split into 2 sections:

The User Guide contains documentation on how to install and use mx-bluesky.

User Guide

The Developer Guide contains documentation on how to develop and contribute changes back to mx-bluesky.

Developer Guide