def report(text, level=None, slack=False): '''Print a string to: * the log file * the screen * the BMM beamtime slack channel Report level decorations on screen: * 'error' (red) * 'warning' (yellow) * 'info' (brown) * 'url' (undecorated) * 'bold' (bright white) * 'verbosebold' (bright cyan) * 'list' (cyan) * 'disconnected' (purple) * 'whisper' (gray) not matching a report level will be undecorated ''' BMMuser = user_ns['BMMuser'] BMM_log_info(text) if color: # test that color is sensible... if level == 'error': print(error_msg(text)) elif level == 'warning': print(warning_msg(text)) elif level == 'info': print(info_msg(text)) elif level == 'url': print(url_msg(text)) elif level == 'bold': print(bold_msg(text)) elif level == 'verbosebold': print(verbosebold_msg(text)) elif level == 'disconnected': print(disconnected_msg(text)) elif level == 'list': print(list_msg(text)) elif level == 'whisper': print(whisper(text)) else: print(text) else: print(text) if BMMuser.use_slack and slack: post_to_slack(text)
def BMM_help(): ''' Print a concise summary of data acquisition commands. ''' BMMuser = user_ns['BMMuser'] print('') print(bold_msg('Open the shutter:\t\t') + 'shb.open()') print(bold_msg('Close the shutter:\t\t') + 'shb.close()') print('') print(bold_msg('Change energy:\t\t\t') + 'RE(mv(dcm.energy, <energy>))') print( bold_msg('Move a motor, absolute:\t\t') + 'RE(mv(<motor>, <position>))') print( bold_msg('Move a motor, relative:\t\t') + 'RE(mvr(<motor>, <delta>))') print(bold_msg('Where is a motor?\t\t') + '%w <motor>') print('') print(bold_msg('Where is the DCM?\t\t') + '%w dcm') print(bold_msg('Where is M2?\t\t\t') + '%w m2') print(bold_msg('Where is M3?\t\t\t') + '%w m3') print(bold_msg('Where are the slits?\t\t') + '%w slits3') print(bold_msg('Where is the XAFS table?\t') + '%w xafs_table') print('') print(bold_msg('Summarize all motor positions:\t') + '%m') print(bold_msg('Summarize utilities:\t\t') + '%ut') print('') print( bold_msg('How long will a scan seq. be?\t') + 'howlong(\'scan.ini\')') print(bold_msg('Run a scan sequence:\t\t') + 'RE(xafs(\'scan.ini\'))') print( bold_msg('Scan a motor, plot a detector:\t') + 'RE(linescan(<det>, <motor>, <start>, <stop>, <nsteps>))') print( bold_msg('Scan 2 motors, plot a detector:\t') + 'RE(areascan(<det>, <slow motor>, <start>, <stop>, <nsteps>, <fast motor>, <start>, <stop>, <nsteps>))' ) #print(bold_msg('Single energy XAS detection:\t')+'RE(sead(\'timescan.ini\'))') print( bold_msg('Make a log entry:\t\t') + 'BMM_log_info(\'blah blah blah\')') print('') print(bold_msg('DATA = ') + BMMuser.DATA) print('') print( bold_msg('All the details: ') + url_msg('https://nsls-ii-bmm.github.io/BeamlineManual/index.html')) return None
def BMM_keys(): ''' Print a concise summary of command line hotkeys. ''' print('') print(bold_msg('Abort scan:\t\t') + error_msg('Ctrl-c twice!')) print(bold_msg('Search backwards:\t') + 'Ctrl-r') print(bold_msg('Quit search:\t\t') + 'Ctrl-g') print(bold_msg('Beginning of line:\t') + 'Ctrl-a') print(bold_msg('End of line:\t\t') + 'Ctrl-e') print(bold_msg('Delete character\t') + 'Ctrl-d') print(bold_msg('Cut text to eol\t\t') + 'Ctrl-k') print(bold_msg('Cut text to bol\t\t') + 'Ctrl-u') print(bold_msg('Paste text\t\t') + 'Ctrl-y') print(bold_msg('Clear screen\t\t') + 'Ctrl-l') print('') print( bold_msg('More details: ') + url_msg( 'https://jakevdp.github.io/PythonDataScienceHandbook/01.02-shell-keyboard-shortcuts.html' )) return None
def change_edge(el, focus=False, edge='K', energy=None, slits=True, target=300., xrd=False, bender=True): '''Change edge energy by: 1. Moving the DCM above the edge energy 2. Moving the photon delivery system to the correct mode 3. Running a rocking curve scan 4. Running a slits_height scan Parameters ---------- el : str one- or two-letter symbol focus : bool, optional T=focused or F=unfocused beam [False, unfocused] edge : str, optional edge symbol ['K'] energy : float, optional e0 value [None, determined from el/edge] slits : bool, optional perform slit_height() scan [False] target : float, optional energy where rocking curve is measured [300] xrd : boolean, optional force photon delivery system to XRD [False] Examples -------- Normal use, unfocused beam: >>> RE(change_edge('Fe')) Normal use, focused beam: >>> RE(change_edge('Fe', focus=True)) L2 or L1 edge: >>> RE(change_edge('Re', edge='L2')) Measure rocking curve at edge energy: >>> RE(change_edge('Fe', target=0)) XRD, new energy: >>> RE(change_edge('Fe', xrd=True, energy=8600)) note that you must specify an element, but it doesn't matter which one the energy will be moved to the specified energy xrd=True implies focus=True and target=0 ''' BMMuser, RE, dcm, dm3_bct = user_ns['BMMuser'], user_ns['RE'], user_ns[ 'dcm'], user_ns['dm3_bct'] dcm_pitch, dcm_bragg = user_ns['dcm_pitch'], user_ns['dcm_bragg'] rkvs = user_ns['rkvs'] try: xs = user_ns['xs'] except: pass #BMMuser.prompt = True el = el.capitalize() ###################################################################### # this is a tool for verifying a macro. this replaces an xafsmod scan # # with a sleep, allowing the user to easily map out motor motions in # # a macro # if BMMuser.macro_dryrun: print( info_msg( '\nBMMuser.macro_dryrun is True. Sleeping for %.1f seconds rather than changing to the %s edge.\n' % (BMMuser.macro_sleep, el))) countdown(BMMuser.macro_sleep) return (yield from null()) ###################################################################### if pds_motors_ready() is False: print( error_msg( '\nOne or more motors are showing amplifier faults.\nToggle the correct kill switch, then re-enable the faulted motor.' )) return (yield from null()) (ok, text) = BMM_clear_to_start() if ok is False: print( error_msg('\n' + text) + bold_msg('Quitting change_edge() macro....\n')) return (yield from null()) if energy is None: energy = edge_energy(el, edge) if energy is None: print( error_msg('\nEither %s or %s is not a valid symbol\n' % (el, edge))) return (yield from null()) if energy > 23500: edge = 'L3' energy = edge_energy(el, 'L3') if energy < 4000: print(warning_msg('The %s edge energy is below 4950 eV' % el)) print(warning_msg('You have to change energy by hand.')) return (yield from null()) if energy > 23500: print( warning_msg( 'The %s edge energy is outside the range of this beamline!' % el)) return (yield from null()) BMMuser.edge = edge BMMuser.element = el BMMuser.edge_energy = energy rkvs.set('BMM:pds:edge', edge) rkvs.set('BMM:pds:element', el) rkvs.set('BMM:pds:edge_energy', energy) if energy > 8000: mode = 'A' if focus else 'D' elif energy < 6000: #mode = 'B' if focus else 'F' ## mode B currently is inaccessible :( mode = 'C' if focus else 'F' else: mode = 'C' if focus else 'E' if xrd: mode = 'XRD' focus = True target = 0.0 current_mode = get_mode() if mode in ('D', 'E', 'F') and current_mode in ('D', 'E', 'F'): with_m2 = False elif mode in ('A', 'B', 'C') and current_mode in ('A', 'B', 'C'): # no need to move M2 with_m2 = False else: with_m2 = True if all_connected(with_m2) is False: print(warning_msg('Ophyd connection failure' % el)) return (yield from null()) ################################ # confirm configuration change # ################################ print(bold_msg('\nEnergy change:')) print(' %s: %s %s' % (list_msg('edge'), el.capitalize(), edge.capitalize())) print(' %s: %.1f' % (list_msg('edge energy'), energy)) print(' %s: %.1f' % (list_msg('target energy'), energy + target)) print(' %s: %s' % (list_msg('focus'), str(focus))) print(' %s: %s' % (list_msg('photon delivery mode'), mode)) print(' %s: %s' % (list_msg('optimizing slits height'), str(slits))) if BMMuser.prompt: action = input("\nBegin energy change? [Y/n then Enter] ") if action.lower() == 'q' or action.lower() == 'n': return (yield from null()) if mode == 'C' and energy < 6000: print( warning_msg( '\nMoving to mode C for focused beam and an edge energy below 6 keV.' )) action = input( "You will not get optimal harmonic rejection. Continue anyway? [Y/n then Enter] " ) if action.lower() == 'q' or action.lower() == 'n': return (yield from null()) start = time.time() if mode == 'XRD': report('Configuring beamline for XRD', level='bold', slack=True) else: report( f'Configuring beamline for {el.capitalize()} {edge.capitalize()} edge', level='bold', slack=True) yield from dcm.kill_plan() ################################################ # change to the correct photon delivery mode # # + move mono to correct energy # # + move reference holder to correct slot # ################################################ # if not calibrating and mode != current_mode: # print('Moving to photon delivery mode %s...' % mode) yield from mv(dcm_bragg.acceleration, BMMuser.acc_slow) yield from change_mode(mode=mode, prompt=False, edge=energy + target, reference=el, bender=bender) yield from mv(dcm_bragg.acceleration, BMMuser.acc_fast) if arrived_in_mode(mode=mode) is False: print(error_msg(f'\nFailed to arrive in Mode {mode}')) print( 'Fixing this is often as simple as re-running the change_mode() command.' ) print('Or try dm3_bct.kill() the re-run the change_mode() command.') print('If that doesn\'t work, call for help') return (yield from null()) yield from user_ns['kill_mirror_jacks']() yield from sleep(1) if BMMuser.motor_fault is not None: print( error_msg('\nSome motors are reporting amplifier faults: %s' % BMMuser.motor_fault)) print( 'Clear the faults and try running the same change_edge() command again.' ) print('Troubleshooting: ' + url_msg( 'https://nsls-ii-bmm.github.io/BeamlineManual/trouble.html#amplifier-fault' )) BMMuser.motor_fault = None return (yield from null()) BMMuser.motor_fault = None ############################ # run a rocking curve scan # ############################ print('Optimizing rocking curve...') yield from abs_set(dcm_pitch.kill_cmd, 1, wait=True) yield from mv(dcm_pitch, approximate_pitch(energy + target)) yield from sleep(1) yield from abs_set(dcm_pitch.kill_cmd, 1, wait=True) yield from rocking_curve() close_last_plot() ########################## # run a slit height scan # ########################## if slits: print('Optimizing slits height...') yield from slit_height(move=True) close_last_plot() ## redo rocking curve? ################################## # set reference and roi channels # ################################## if not xrd: ## reference channel rois = user_ns['rois'] print('Moving reference foil...') yield from rois.select_plan(el) ## Xspress3 BMMuser.verify_roi(xs, el, edge) ## feedback show_edges() if mode == 'XRD': report('Finished configuring for XRD', level='bold', slack=True) else: report( f'Finished configuring for {el.capitalize()} {edge.capitalize()} edge', level='bold', slack=True) if slits is False: print( ' * You may need to verify the slit position: RE(slit_height())') self.to_json(os.path.join(self.DATA, '.BMMuser')) yield from dcm.kill_plan() end = time.time() print('\n\nThat took %.1f min' % ((end - start) / 60)) return ()
def sanitize_step_scan_parameters(bounds, steps, times): '''Attempt to identify and flag/correct some common scan parameter mistakes.''' problem = False text = '' ############################################################################ # bounds is one longer than steps/times, length of steps = length of times # ############################################################################ if (len(bounds) - len(steps)) != 1: text += error_msg('\nbounds must have one more item than steps\n') text += error_msg('\tbounds = %s\n' % ' '.join(map(str, bounds))) text += error_msg('\tsteps = %s\n' % ' '.join(map(str, steps))) problem = True if (len(bounds) - len(times)) != 1: text += error_msg('\nbounds must have one more item than times\n') text += error_msg('\tbounds = %s\n' % ' '.join(map(str, bounds))) text += error_msg('\ttimes = %s\n' % ' '.join(map(str, times))) problem = True ############################ # tests of boundary values # ############################ for b in bounds: if not isfloat(b) and b[-1:].lower() == 'k': if not isfloat(b[:-1]): text += error_msg('\n%s is not a valid scan boundary value\n' % b) problem = True elif not isfloat(b): text += error_msg('\n%s is not a valid scan boundary value\n' % b) problem = True if not isfloat(b) and b[:1] == '-' and b[-1:].lower() == 'k': text += error_msg( '\nNegative bounds must be energy-valued, not k-valued (%s)\n' % b) problem = True ############################# # tests of step size values # ############################# for s in steps: if not isfloat(s) and s[-1:].lower() == 'k': if not isfloat(s[:-1]): text += error_msg( '\n%s is not a valid scan step size value\n' % s) problem = True elif float(s[:-1]) < 0: text += error_msg('\nStep sizes cannot be negative (%s)\n' % s) problem = True elif not isfloat(s): text += error_msg('\n%s is not a valid scan step size value\n' % s) problem = True if isfloat(s) and float(s) < 0: text += error_msg('\nStep sizes cannot be negative (%s)\n' % s) problem = True elif isfloat(s) and float(s) <= 0.09: text += warning_msg('\n%s is a very small step size!\n' % s) elif not isfloat(s) and s[-1:].lower() == 'k' and isfloat( s[-1:]) and float(s[:-1]) < 0.01: text += warning_msg('\n%s is a very small step size!\n' % s) #################################### # tests of integration time values # #################################### for t in times: if not isfloat(t) and t[-1:].lower() == 'k': if not isfloat(t[:-1]): text += error_msg( '\n%s is not a valid integration time value\n' % t) problem = True elif float(t[:-1]) < 0: text += error_msg( '\nIntegration times cannot be negative (%s)\n' % t) problem = True elif not isfloat(t): text += error_msg('\n%s is not a valid integration time value\n' % t) problem = True if isfloat(t) and float(t) < 0: text += error_msg('\nIntegration times cannot be negative (%s)\n' % t) problem = True elif isfloat(t) and float(t) <= 0.1: text += warning_msg('\n%s is a very short integration time!\n' % t) elif not isfloat(t) and t[-1:].lower() == 'k' and isfloat( t[-1:]) and float(t[:-1]) < 0.05: text += warning_msg('\n%s is a very short integration time!\n' % t) if text: text += error_msg('\nsee ') + url_msg( 'https://nsls-ii-bmm.github.io/BeamlineManual/xafs.html#scan-regions\n' ) return problem, text