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
44AREA_DETECTOR:
45    ### General configuration for area detectors.
46    ALLOW_PLUGIN_WARMUP: true
47    BLUESKY_FILES_ROOT: &BLUESKY_DATA_ROOT "/path/to/data/"
48    IMAGE_DIR: "sub/directory/path"
49    HDF5_FILE_TEMPLATE: "%s%s_%6.6d.h5"
50    ### Add configuration for specific detector(s).
51    ### Suggestion:
52    # ADSIM_16M:
53    #     # IOC host: workstation_name
54    #     IOC_FILES_ROOT: *BLUESKY_DATA_ROOT
55    #     NAME: simdet16M
56    #     PV_PREFIX: "simdet16m:"
57
58### Support for known output file formats.
59### Uncomment to use.  If undefined, will not write that type of file.
60### Each callback should apply its configuration from here.
61# NEXUS_DATA_FILES:
62#     FILE_EXTENSION: hdf
63#     WARN_MISSING_CONTENT: true
64SPEC_DATA_FILES:
65    FILE_EXTENSION: dat
66
67### APS Data Management
68### Use bash shell, deactivate all conda environments, source this file:
69DM_SETUP_FILE: "/home/dm/etc/dm.setup.sh"
70
71### Local OPHYD Device Control Yaml
72DEVICES_FILE: devices.yml
73APS_DEVICES_FILE: devices_aps_only.yml
74
75# ----------------------------------
76
77OPHYD:
78    ### Control layer for ophyd to communicate with EPICS.
79    ### Default: PyEpics
80    ### Choices: "PyEpics" or "caproto"
81    # CONTROL_LAYER: caproto
82
83    ### default timeouts (seconds)
84    TIMEOUTS:
85        PV_READ: &TIMEOUT 5
86        PV_WRITE: *TIMEOUT
87        PV_CONNECTION: *TIMEOUT
88
89# Control detail of exception traces in IPython (console and notebook).
90XMODE_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
 3apstools.devices.SimulatedApsPssShutterWithStatus:
 4- name: shutter
 5  labels: ["shutters"]
 6
 7# ophyd.Signal:
 8# - name: test
 9#   value: 50.7
10# - name: t2
11#   value: 2
12
13# apstools.synApps.Optics2Slit2D_HV:
14# - name: slit1
15#   prefix: ioc:Slit1
16#   labels: ["slits"]
17
18# hkl.SimulatedE4CV:
19# - name: sim4c
20#   prefix: ""
21#   labels: ["diffractometer"]
22
23# ophyd.scaler.ScalerCH:
24# - name: scaler1
25#   prefix: vme:scaler1
26#   labels: ["scalers", "detectors"]
27
28# ophyd.EpicsMotor:
29# - {name: m1, prefix: gp:m1, labels: ["motor"]}
30# - {name: m2, prefix: gp:m2, labels: ["motor"]}
31# - {name: m3, prefix: gp:m3, labels: ["motor"]}
32# - {name: m4, prefix: gp:m4, labels: ["motor"]}

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