Bluesky

===================

This release fixes a single regression introduced in v1.4.0. We recommend all
users upgrade.

Bug Fixes
---------

* Fix a critical typo that made
:class:`~bluesky.callbacks.mpl_plotting.LiveGrid` unusable.

Note that the 1.4.x series is not compatible with newer versions of matplotlib;
it needs a version lower than 3.1.0 due to an API change in matplotlib. The
1.5.x series is compatible with matplotlib versions before and after the
change.

===================

Features
--------

* Added ability to control 'sense' of
:class:`~bluesky.callbacks.mpl_plotting.LiveGrid` (ex "positive goes
down and to the right") to match the coordinates in the hutch.
* Learned how to specify the serializer / deserializer for the zmq
publisher / client.
* Promoted the inner function from :func:`~bluesky.plan_stubs.one_nd_step`
to a top-level plan :func:`bluesky.plan_stubs.move_per_step`.
* Added flag to :func:`~bluesky.plans.ramp_plan` to control if a
data point is taken before the ramp starts.

Bug Fixes
---------

* Ensure order stability in :func:`~bluesky.magics.get_labeled_devices`
on all supported versions of Python.
* Fixed typos, dev requirements, and build details.

===================

Bug Fixes
---------

* Fixed show-shopping RunEngine bug in flyer asset collection. (The impact of
this bug is expected to be low, as there *are* no flyers with asset
collection yet and the bug was discovered while writing the first one.)
* Fixed packaging issue where certain important files (notably
``requirements.txt``) were not included in the source tarball.
* Made BestEffortCallback swallow errors related to matplotlib's "tight layout"
if the occur --- better to show a messy plot than error out.

===================

Bug Fixes
---------

* Revised behavior of magics that integrate with ophyd's experimental
"labels" feature. The most important difference is that the ``%wa`` magic now
traverses the children of labeled devices to find any sub-devices that are
positioners.

===================

Bug Fixes
---------

* Fixed race condition where monitored signals could emit an Event document
before the corresponding Event Descriptor document.
* Addressed incompatibilities with upcoming release of Python, 3.7.

===================

Features
--------

* When used with ophyd v1.2.0 or later, emit Resource and Datum documents
through the RunEngine. Previously, ophyd would insert these documents
directly into a database. This left other consumers with only partial
information (for example, missing file paths to externally-stored data) and
no guarantees around synchronization. Now, ophyd need not interact with a
database directly. All information flows through the RunEngine and out to any
subscribed consumers in a deterministic order.
* New Msg commands, ``install_suspender`` and ``remove_suspender``, allow plans
to temporarily add and remove Suspenders.
* The RunEngine's signal handling (i.e. Ctrl+C capturing) is now configurable.
The RunEngine accepts a list of ``context_managers`` that it will enter and
exit before and after running. By default, it has one context manager that
handles Ctrl+C. To disable Ctrl+C handling, pass in an empty list instead.
This can also be used to inject other custom behavior.
* Add new plans: :func:`~bluesky.plans.x2x_scan`,
:func:`~bluesky.plans.spiral_square_plan`, and
:func:`~bluesky.plans.rel_spiral_square_plan`.
* Add convenience methods for reviewing the available commands,
:meth:`~bluesky.run_engine.RunEngine.commands` and
:meth:`~bluesky.run_engine.RunEngine.print_command_registry`.
* Add a ``crossings`` attribute to ``PeakStats``.

Bug Fixes
---------

* When resuming after a suspender, call ``resume()`` on all devices (if
present).
* Fixed BEC LiveGrid plot for a motor with one step.
* A codepath in ``LiveFit`` that should have produced a warning produced an
error instead.

Breaking Changes
----------------

* User-defined callbacks subscribed to the RunEngine ``'all'`` stream must
accept documents with names ``'resource'``, ``'datum'`` and ``'bulk_datum'``.
It does not necessarily have to heed their contents, but it must not fall
over if it receives one.

Deprecations
------------

* The IPython "magics", always marked as experimental, have been reworked.
Instead of relying on the singleton lists, ``BlueskyMagics.positioners`` and
``BlueskyMagics.detectors``, the magics now scrape the user namespace for
objects that implement the ``_ophyd_labels_`` interface. See :doc:`magics`
for the new usage. The magics will revert to their old behavior if the
singleton lists are non-empty, but they will produce a warning. The old
behavior will be removed in a future release.