brief code review of 00-prep.py

[prjemian]

Since #8 (comment), a short code review seems timely.

[prjemian]

This line is not needed:

ipython-s6bm/ipython_profiles/profile_s6bm/startup/00-prep.py

Line 55 in ab45c8c

from bluesky import RunEngine

but we should convert:

ipython-s6bm/ipython_profiles/profile_s6bm/startup/00-prep.py

Line 65 in ab45c8c

RE = RunEngine({})

to

RE = bluesky.RunEngine({})

[prjemian]

Isn't this code only called once?

ipython-s6bm/ipython_profiles/profile_s6bm/startup/00-prep.py

Lines 60 to 82 in ab45c8c

	def getRunEngine(db=None):
	"""
	Return an instance of RunEngine. It is recommended to have only
	one RunEngine per session.
	"""
	RE = RunEngine({})
	db = db or metadata_db
	RE.subscribe(db.insert)
	RE.subscribe(BestEffortCallback())
	RE.md['beamline_id'] = 'APS 6-BM-A'
	RE.md['proposal_id'] = 'internal test'
	RE.md['pid'] = os.getpid()
	RE.md['login_id'] = USERNAME + '@' + HOSTNAME
	RE.md['versions'] = {}
	RE.md['versions']['apstools'] = apstools.__version__
	RE.md['versions']['bluesky'] = bluesky.__version__
	RE.md['versions']['databroker'] = databroker.__version__
	RE.md['versions']['matplotlib'] = matplotlib.__version__
	RE.md['versions']['numpy'] = np.__version__
	RE.md['versions']['ophyd'] = ophyd.__version__
	RE.md['SESSION_STARTED'] = datetime.isoformat(datetime.now(), " ")
	return RE
	RE = getRunEngine()

Seems that we could avoid creating a new function just for these once-only actions.

[prjemian]

In this code, a Device is created each time the code is called, used, then disposed.

ipython-s6bm/ipython_profiles/profile_s6bm/startup/00-prep.py

Lines 119 to 121 in ab45c8c

	def hutch_light_on():
	"""check PV for hutch lighting"""
	calcs = apstools.synApps_ophyd.userCalcsDevice("6bma1:", name="calcs")

Seems like an expensive activity. Can the device creation be moved to the caller? Similar to changeset ab45c8c

[prjemian]

Consider replacing

ipython-s6bm/ipython_profiles/profile_s6bm/startup/99-help.py

Line 17 in ab45c8c

list_predefined_func()

with show_ophyd_symbols() (new in apstools 1.1.8)

apstools.utils.show_ophyd_symbols()

Here is sample output (from my simulator):

In [4]: apstools.utils.show_ophyd_symbols()                                                                                         
======= ================================ ============= =========
name    ophyd structure                  EPICS PV      label(s) 
======= ================================ ============= =========
fourc   FourCircleDiffractometer                                
m1      EpicsMotor                       vm7:m1        motor    
m16     EpicsMotor                       vm7:m16       motor    
m2      EpicsMotor                       vm7:m2        motor    
m3      EpicsMotor                       vm7:m3        motor    
m4      EpicsMotor                       vm7:m4        motor    
m5      EpicsMotor                       vm7:m5        motor    
m6      EpicsMotor                       vm7:m6        motor    
m7      EpicsMotor                       vm7:m7        motor    
m8      EpicsMotor                       vm7:m8        motor    
noisy   EpicsSignalRO                    vm7:userCalc1 detectors
scaler  ScalerCH                         vm7:scaler1   detectors
shutter SimulatedApsPssShutterWithStatus                        
======= ================================ ============= =========

Out[4]: <pyRestTable.rest_table.Table at 0x7f8b01607208>

[prjemian]

Consider adding a call to print_RE_md() just before these lines:

ipython-s6bm/ipython_profiles/profile_s6bm/startup/99-help.py

Lines 16 to 17 in ab45c8c

	list_predefined_vars()
	list_predefined_func()

apstools.utils.print_RE_md()

Here's example output from my simulator:

In [5]: apstools.utils.print_RE_md()                                                                                                
RunEngine metadata dictionary:
=========== ====================
key         value               
=========== ====================
beamline_id Linux Mint VM7      
login_id    mintadmin@mint-vm   
pid         28976               
proposal_id testing             
scan_id     205                 
versions    =========== ========
            key         value   
            =========== ========
            apstools    1.1.12  
            bluesky     1.5.3   
            databroker  0.13.0  
            epics       3.3.3   
            matplotlib  3.1.0   
            numpy       1.16.4  
            ophyd       1.3.3   
            pyRestTable 2020.0.2
            spec2nexus  2021.1.0
            =========== ========