sm_bluesky

Bluesky code for Diamond’s surface and magnetic materials beamline.

This is where you should write a short paragraph that describes what your module does, how it does it, and why people should use it.

Source	DiamondLightSource/sm-bluesky
PyPI	pip install sm_bluesky
Documentation	https://diamondlightsource.github.io/sm-bluesky
Releases	DiamondLightSource/sm-bluesky

This is where you should put some images or code snippets that illustrate some relevant examples. If it is a library then you might put some introductory code here:

from sm_bluesky import __version__

print(f"Hello sm_bluesky {__version__}")

Or if it is a commandline tool then you might put some example commands here:

python -m sm_bluesky --version

How the documentation is structured

Documentation is split into four categories, also accessible from links in the top bar.

• Tutorials
  • Installation
  • Running Bluesky on p99

Tutorials for installation and typical usage. New users start here.

• How-to Guides
  • Setup Developer Environment
  • Build and Test
  • Contribute to the project
  • Troubleshooting

Practical step-by-step guides for the more experienced user.

• Explanations
  • Architectural Decision Records

Explanations of how it works and why it works that way.

• Reference
  • API
  • Index
  • Release Notes

Technical reference material including APIs and release notes.