Add Plans and Devices to your Blueapi Environment

See also

The bluesky documentation for an introduction to the nature of plans and devices and why you would want to customize them for your experimental needs.

Blueapi can be configured to load custom code at startup that defines plans and devices. The code must be in your Python environment (via pip install <package>) or your scratch area.

Configuration

See also

Configure the Application

First determine the import path of your code. If you were going to import it in a Python file, what would you put? For example:

import my_plan_library.tomography.plans

To add plans, you would add the following into your configuration file:

env:
  sources:
    - kind: planFunctions
      module: my_plan_library.tomography.plans

Devices are added similarly, using dodal as the kind, like so:

env:
  sources:
    - kind: planFunctions
      module: my_plan_library.tomography.plans
    - kind: dodal
      module: dodal.beamlines.i04

You can have as many sources for plans and devices as are needed.

See also

Home of Plans and Devices for an introduction to the nature of plans and devices and why you would want to customize them for your experimental needs.