Upgrade checklist, May 2016

deployment-plan.md

0. Create 'DAMA Software' logbook in beamline Olog.
1. Run conda list -n collection > /tmp/conda-list-before-upgrade.txt and include it in an Olog entry as an attachment.
2. Commit any uncomitted code in the IPython profile, which should be located (or linked to) at ~/.ipython/profile_colllection.
3. Create a new directory inside the IPython profile, ~/.ipython/profile_collection/acceptance_tests.
4. Write acceptance tests as short, standalone scripts that can be executed like ipython --profile=collection -i 01-some-test.py. See examples from XPD or CSX.
5. Run acceptance tests successfully, and commit repo.
6. Install packages. Use --no-deps to keep conda from installing things you don't want.
   • event_model>=1.0.2
   • bluesky==0.5.1
   • databroker==0.4.1
   • metadatastore==0.5.2
   • ophyd (latest on nsls2-dev)
   • pyepics (latest on nsls2-dev)
   • doct==1.0.2
   • historydict==1.1.0
   • filestore==0.3.0
7. As above, create a text file and attach it to the same log entry.
8. Commit IPython profile and sync with github.
9. Standardize 00-startup.py around the documented standard. Put olog code (farther down the page in that same link) in a separate file, 01-olog-configuration.py, where it can be easily removed when the Olog is acting up.
10. Adjust for API Changes in beamline config:
    • Remove imports of bluesky.broker_callbacks, bluesky.hardware_checklist, bluesky.standard_config.
    • If gs was being imported from standard_config, import it from bluesky.global_state instead.
    • gs.RE.subscribe_lossless('all', metadatastore.commands.insert) (This line is in the linked example config already.)
    • To avoid an annoying warning, import install_qt_kicker from bluesky.utils instead of (deprecated) bluesky.qt_kicker.
    • Cleanup unneeded code that turns asyncio debugging off. (It's off my default now.)
    • Do not bulk import from bluesky.plans import *. (There is a lot of stuff in there now, and some names like sleep shadow common imports.)
11. Check the order of Components in Device class definitions. To be safe: in PVPositioner definitions, readback (not setpoint) should be first because that is the value that will be used to restore motors to their original positions if .position does not exist.
12. Customize names, read_attrs, and configuration_attrs in accordance with beamline scientists' preferences.
13. Run user acceptance tests.
14. Commit IPython profile and upload to github.
15. Ask what new hardware beamline will use this cycle.

Wish I could give thumbs ups on gists. 👍