Guides

In addition to the guides presented below, there are many Jupyter notebooks online to provide additional Bluesky training for the APS. Further, NSLS-II provides online notebooks which can be executed online (in a web browser). See the Bluesky home page for more details.

Devices

• Area Detector with default HDF5 File Name
  • EPICS Area Detector IOC
  • File Directories
  • ophyd
  • bluesky
  • databroker
  • punx
  • Recapitulation
• Area Detector with custom HDF5 File Name
  • EPICS Area Detector IOC
  • ophyd
  • databroker
  • punx
• Area Detector, Single mode, HDF5 file
  • EPICS Area Detector IOC
  • File Directories
  • ophyd
  • bluesky
  • databroker
  • punx
  • Recapitulation
• ADPerkinElmer Area Detector with default HDF5 File Name
  • EPICS Area Detector IOC
  • ophyd
  • bluesky
• ADPilatus Area Detector with default HDF5 File Name
  • EPICS Area Detector IOC
  • ophyd
  • bluesky
• Fly Scans with EPICS motor and scaler
  • Overview
  • Outline
  • Setup
  • Scan
  • Visualize

File Writers

• Output scan(s) to a NeXus/HDF5 file
  • Callback
  • Export
• Output scan(s) to a SPEC data file.
  • Setup
  • get the most recent scan, by steps
  • Support function: specfile_example()
  • Write the run as SPEC data
  • a specific scan
  • specify a list of scans by UID
  • Find specific plans within a range of dates

How-to Guides

• How to interrupt/stop/abort a running plan & recover to safe settings
  • Terminate or Interrupt
  • Handle Exceptions
  • Suspending the RunEngine
  • Recover Safe Settings
  • Summary
• What are the objects to control?
  • listobjects() function
  • listdevice() function
  • .summary() method
  • %wa magic command
  • listplans() function
  • findCatalogsInNamespace() function
• How to Search for Bluesky Data?
  • What is a catalog?
  • What is a run?
  • How to retrieve a run?
  • Search with listruns()
  • Search with a Filtered catalog
  • Other searches:
• How to setup logging
  • Handlers
  • What are the logging levels?

Plans

• The Excel_plan() – batch scans using a spreadsheet
  • Excel plan and infrastructure
• The lineup() plan - align an axis with a signal
  • Setup
  • Scan
  • Validate
• The nscan() plan – scan multiple axes together
  • Setup
  • Scan
• The run_command_file() plan – batch scans using a text file
  • The Command File
  • The Actions
  • Register our own execute_command_list
  • Testing the command file
  • Running the command file
  • Appendix: Other spreadsheet examples
• The TuneAxis() plan - align an axis with a signal
  • Setup the simulated detector signal.
  • Set up the tuner
  • Multi-pass tune
  • Single-pass tune

File Downloads for the Examples

The jupyter notebooks and files related to this section may be downloaded from the following table.

• jupyter notebook: de_0_adsim_hdf5_basic

• jupyter notebook: de_1_adsim_hdf5_custom_names

• jupyter notebook: de_2_adsim_hdf5_single_mode

• jupyter notebook: pl_excel_scan

  • sample_example.xlsx

• jupyter notebook: pl_nscan

• jupyter notebook: pl_tuneaxis

• jupyter notebook: fw_specfile_example

  • spec1.dat

  • spec2.dat

  • spec3.dat

  • spec_tunes.dat

  • test_specdata.txt