Welcome to ibex_bluesky_core’s documentation!

ibex_bluesky_core is a library of common bluesky functionality and ophyd-async devices for use on the ISIS neutron & muon source’s beamlines.

Bluesky is a generic data acquisition framework, which started at NSLS-ii but is developed as a multi-facility collaboration. Bluesky provides concepts such as “scanning” in a generic way.

ophyd-async is a python device abstraction library, which allows bluesky to communicate with an underlying control system (EPICS/IBEX, in our case).

ibex_bluesky_core provides:

• Central configuration for core bluesky classes, such as the RunEngine.

• RunEngine Callbacks customized for use at ISIS: file writing, plotting, fitting, …

• Central implementations of ISIS device classes using ophyd-async: Blocks, DAE, …

• Bluesky or scanning-related utilities which are useful across multiple beamlines.

Getting started

Tutorial

• Getting started
  • Plans
  • Devices
  • Setting and reading values
  • Scanning
  • The RunEngine
  • Callbacks
  • See also

Reference documentation

Devices

• Blocks
  • Block types
  • Configuring block write behaviour
  • Run control
• DAE (Data Acquisition Electronics)
  • Example configurations
  • Mapping to bluesky device model
  • Controllers
  • Reducers
  • Waiters
  • Dae (base class, advanced)

Callbacks

• Document Logging Callback
• File writing callbacks
  • Human readable files
• Plotting
  • Configuration

Fitting

• Fitting Callback
  • Configuration
  • Models
• Standard Fitting Models
  • Linear
  • Polynomial
  • Gaussian
  • Lorentzian
  • Damped Oscillator (DampedOsc)
  • Slit Scan (SlitScan)
  • Error Function (ERF)
  • Complementary Error Function (ERFC)
  • Top Hat (TopHat)
  • Trapezoid

Plan stubs

• call_sync (calling external code)

Preprocessors

• RB Number injection preprocessor

Developer information

• Release Process
• Logging
• Manual system testing
  • Running the tests from PyDEV in the GUI
  • Running from a standalone python session
• Local development
  • Checkout the repository locally
  • Create & activate a virtual environment (windows)
  • Install the library & dev dependencies in editable mode
  • Unit tests
  • Run lints
  • Build docs locally
• Notes on Sphinx and addons
  • Using MyST admonitions
  • Code blocks in docstrings

Architectural decisions

• Repository structure
• Use ophyd-async
• Run in-process
• Use scipp
• Variance addition to counts data

API reference

• API
  • ibex_bluesky_core
    • ibex_bluesky_core.callbacks
      • ibex_bluesky_core.callbacks.document_logger
      • ibex_bluesky_core.callbacks.file_logger
      • ibex_bluesky_core.callbacks.fitting
        • ibex_bluesky_core.callbacks.fitting.fitting_utils
      • ibex_bluesky_core.callbacks.plotting
    • ibex_bluesky_core.devices
      • ibex_bluesky_core.devices.block
      • ibex_bluesky_core.devices.dae
        • ibex_bluesky_core.devices.dae.dae
        • ibex_bluesky_core.devices.dae.dae_controls
        • ibex_bluesky_core.devices.dae.dae_event_mode
        • ibex_bluesky_core.devices.dae.dae_monitor
        • ibex_bluesky_core.devices.dae.dae_period
        • ibex_bluesky_core.devices.dae.dae_period_settings
        • ibex_bluesky_core.devices.dae.dae_settings
        • ibex_bluesky_core.devices.dae.dae_spectra
        • ibex_bluesky_core.devices.dae.dae_tcb_settings
      • ibex_bluesky_core.devices.simpledae
        • ibex_bluesky_core.devices.simpledae.controllers
        • ibex_bluesky_core.devices.simpledae.reducers
        • ibex_bluesky_core.devices.simpledae.strategies
        • ibex_bluesky_core.devices.simpledae.waiters
    • ibex_bluesky_core.log
    • ibex_bluesky_core.plan_stubs
    • ibex_bluesky_core.preprocessors
    • ibex_bluesky_core.run_engine