Instrument

As the configuration of a system becomes more complex, it may be easier to describe (and startup) by making the startup steps into a Python package for import.

The instrument package defines the features of your equipment for use with data acquisition using the Bluesky [1] framework. It is structured as a Python package [2] so that it will be easy to use with the Python import command, like much other Python software.

There are many ways to define your equipment so consider this guide as a reference for ideas rather than a set of requirements.

• Install New Instrument
  • Installation checklist
  • Next steps …
• The instrument package for Bluesky Data Acquisition
  • Start the instrument package
  • Description
  • Log files
  • SPEC data files
  • User Code File
  • databroker
• Instrument Package Guide
  • Basic Structure
  • Add Motor(s)
  • Add Scaler(s)
  • Re-organize into Devices
  • Add Area Detector(s)
  • Other Device Support
  • Implement Custom Plans
  • Callbacks
  • Review Metadata
  • Experiment-specific User Code
• Python __init__.py files
  • instrument/collection.py
  • instrument/queueserver.py
• Activate the bluesky conda environment
• Configure bluesky instrument
  • Initial configuration of the instrument
  • Parts of the instrument package
• Setup your databroker catalog configuration
• Create bluesky directory
• Create a bluesky IPython profile
• Create a File System Soft Link
  • Start a Bluesky Console Session
  • The ${HOME}/bin directory
  • File system links
• Translate Previous SPEC Configuration
• Setup catalog configuration for databroker
• Start software version control
• Test that Bluesky Works at APS
• Test the new bluesky instrument
• Test the New Bluesky Instrument

---

[1]

https://blueskyproject.io/

[2]

https://python-packaging-tutorial.readthedocs.io/en/latest/setup_py.html