instrument.configs#

Configuration files related to this Bluesky instrument package. Configuration of the bluesky queueserver host process (QS host) is described in the queueserver section.

iconfig.yml#

Various constants and terms used to configure the instrument package.

 1# Configuration for the Bluesky instrument package.
 2
 3# identify the version of this iconfig.yml file
 4ICONFIG_VERSION: 2.0.0
 5
 6# Add additional configuration for use with your instrument.
 7
 8### The short name for the databroker catalog.
 9DATABROKER_CATALOG: &databroker_catalog temp
10
11### RunEngine configuration
12RUN_ENGINE:
13    DEFAULT_METADATA:
14        beamline_id: instrument
15        instrument_name: Most Glorious Scientific Instrument
16        proposal_id: commissioning
17        databroker_catalog: *databroker_catalog
18
19    ### EPICS PV to use for the `scan_id`.
20    ### Default: `RE.md["scan_id"]` (not using an EPICS PV)
21    # SCAN_ID_PV: f"{IOC}bluesky_scan_id"
22
23    ### Where to "autosave" the RE.md dictionary.
24    ### Defaults:
25    MD_STORAGE_HANDLER: StoredDict
26    MD_PATH: .re_md_dict.yml
27
28    ### The progress bar is nice to see,
29    ### except when it clutters the output in Jupyter notebooks.
30    ### Default: True
31    USE_PROGRESS_BAR: false
32
33# Command-line tools, such as %wa, %ct, ...
34USE_BLUESKY_MAGICS: True
35
36### Best Effort Callback Configurations
37### Defaults: all true (except no plots in queueserver)
38# BEC:
39#     BASELINE: false
40#     HEADING: false
41#     PLOTS: false
42#     TABLE: false
43
44### Support for known output file formats.
45### Uncomment to use.  If undefined, will not write that type of file.
46### Each callback should apply its configuration from here.
47# NEXUS_DATA_FILES:
48#     FILE_EXTENSION: hdf
49#     WARN_MISSING_CONTENT: true
50SPEC_DATA_FILES:
51    FILE_EXTENSION: dat
52
53### APS Data Management
54### Use bash shell, deactivate all conda environments, source this file:
55DM_SETUP_FILE: "/home/dm/etc/dm.setup.sh"
56
57### Local OPHYD Device Control Yaml
58DEVICES_FILE: devices.yml
59APS_DEVICES_FILE: devices_aps_only.yml
60
61# ----------------------------------
62
63OPHYD:
64    ### Control layer for ophyd to communicate with EPICS.
65    ### Default: PyEpics
66    ### Choices: "PyEpics" or "caproto"
67    # CONTROL_LAYER: caproto
68
69    ### default timeouts (seconds)
70    TIMEOUTS:
71        PV_READ: &TIMEOUT 5
72        PV_WRITE: *TIMEOUT
73        PV_CONNECTION: *TIMEOUT
74
75# Control detail of exception traces in IPython (console and notebook).
76XMODE_DEBUG_LEVEL: Minimal

devices.yml#

Declarations of the ophyd (and ophyd-like) devices and signals used by the instrument package. Configuration is used by the guarneri package to create the objects.

 1# Guarneri-style device YAML configuration
 2
 3instrument.devices.factories.predefined_device:
 4- {creator: ophyd.sim.motor, name: sim_motor}
 5- {creator: ophyd.sim.noisy_det, name: sim_det}
 6
 7apstools.devices.SimulatedApsPssShutterWithStatus:
 8- name: shutter
 9  labels: ["shutters"]
10
11# ophyd.Signal:
12# - name: test
13#   value: 50.7
14# - name: t2
15#   value: 2
16
17# apstools.synApps.Optics2Slit2D_HV:
18# - name: slit1
19#   prefix: ioc:Slit1
20#   labels: ["slits"]
21
22# hkl.SimulatedE4CV:
23# - name: sim4c
24#   prefix: ""
25#   labels: ["diffractometer"]
26
27# ophyd.scaler.ScalerCH:
28# - name: scaler1
29#   prefix: vme:scaler1
30#   labels: ["scalers", "detectors"]
31
32# ophyd.EpicsMotor:
33# - {name: m1, prefix: gp:m1, labels: ["motor"]}
34# - {name: m2, prefix: gp:m2, labels: ["motor"]}
35# - {name: m3, prefix: gp:m3, labels: ["motor"]}
36# - {name: m4, prefix: gp:m4, labels: ["motor"]}
37
38# apstools.devices.ad_creator:
39#   - name: adsimdet
40#     prefix: "ad:"
41#     labels: ["area_detector", "detectors"]
42#     plugins:
43#       - cam:
44#           class: apstools.devices.SimDetectorCam_V34
45#       - image
46#       - pva
47#       - hdf1:
48#           class: apstools.devices.AD_EpicsFileNameHDF5Plugin
49#           read_path_template: "/path/to/bluesky/tmp/"
50#           write_path_template: "/path/to/ioc/tmp/"
51#       - roi1
52#       - stats1

devices_aps_only.yml#

Declarations of the ophyd (and ophyd-like) devices and signals only available when Bluesky is used at the APS.

1# Guarneri-style device YAML configuration
2
3# Objects only available at APS
4
5apstools.devices.ApsMachineParametersDevice:
6  - name: aps