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.

file: iconfig.yml

 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: PersistentDict
26    # MD_PATH: HOME/.config/Bluesky_RunEngine_md'
27    MD_STORAGE_HANDLER: StoredDict
28    MD_PATH: .re_md_dict.yml
29
30    ### The progress bar is nice to see,
31    ### except when it clutters the output in Jupyter notebooks.
32    ### Default: True
33    USE_PROGRESS_BAR: false
34
35# Command-line tools, such as %wa, %ct, ...
36USE_BLUESKY_MAGICS: True
37
38### Best Effort Callback Configurations
39### Defaults: all true (except no plots in queueserver)
40# BEC:
41#     BASELINE: false
42#     HEADING: false
43#     PLOTS: false
44#     TABLE: false
45
46AREA_DETECTOR:
47    ### General configuration for area detectors.
48    ALLOW_PLUGIN_WARMUP: true
49    BLUESKY_FILES_ROOT: &BLUESKY_DATA_ROOT "/path/to/data/"
50    IMAGE_DIR: "sub/directory/path"
51    HDF5_FILE_TEMPLATE: "%s%s_%6.6d.h5"
52    ### Add configuration for specific detector(s).
53    ### Suggestion:
54    # ADSIM_16M:
55    #     # IOC host: workstation_name
56    #     IOC_FILES_ROOT: *BLUESKY_DATA_ROOT
57    #     NAME: simdet16M
58    #     PV_PREFIX: "simdet16m:"
59
60### Support for known output file formats.
61### Uncomment to use.  If undefined, will not write that type of file.
62### Each callback should apply its configuration from here.
63# NEXUS_DATA_FILES:
64#     FILE_EXTENSION: hdf
65#     WARN_MISSING_CONTENT: true
66SPEC_DATA_FILES:
67    FILE_EXTENSION: dat
68
69### APS Data Management
70### Use bash shell, deactivate all conda environments, source this file:
71DM_SETUP_FILE: "/home/dm/etc/dm.setup.sh"
72
73# ----------------------------------
74
75OPHYD:
76    ### Control layer for ophyd to communicate with EPICS.
77    ### Default: PyEpics
78    ### Choices: "PyEpics" or "caproto"
79    # CONTROL_LAYER: caproto
80
81    ### default timeouts (seconds)
82    TIMEOUTS:
83        PV_READ: &TIMEOUT 5
84        PV_WRITE: *TIMEOUT
85        PV_CONNECTION: *TIMEOUT
86
87# Control detail of exception traces in IPython (console and notebook).
88XMODE_DEBUG_LEVEL: Minimal