Apstools

******

released 2023-02-15

New Features
------------

* Support to record all motor (or other ophyd-labeled devices) positions at start (or end) of run.
* SpecWriterCallback: write ``O`` and ``P`` lines from motor positions recorded at start of run.

Fixes
------------

* NXWriter: scans with area detectors did not have image data. Fixed. Clients must wait for writer to finish.
* PVPositionerSoftDone: computation of 'done' signal and 'inposition' deconvoluted.
* Struck3820: changed (typo) ``do_readl_all`` to ``do_read_all``
* Tests involving PVPositionerSoftDone call '.cb_readback()' method to upate 'done' signal.

Maintenance
------------

* Added github/super-linter workflow, adds mypy, isort, and other tests.
* Apply isort code style.

Known Problems
--------------

* Observing random occurrence of unit test failures involving PVPositionerSoftDone.

******

released 2023-01-11

New Features
------------

* Add ``apstools.utils.plotxy()`` utility function.
* Add tag-based documentation selection via PyData switcher.

Enhancements
------------

* In listruns(), also search the hints for keys.

Fixes
------------

* CI failed to build documentation when creating pip installation.
* ScalerMotorFlyer default fly_time_pad increased to 10 s.
* ScalerMotorFlyer now sets scaler to "OneShot" mode.
* ScalerMotorFlyer in-position comparison now based on motor's precision.
* Version number was not reported correctly in certain situations (issue 771).

Maintenance
------------

* "Custom HDF5 File Name" example updated to latest advice.
* Pin Sphinx to `<6` due to problems with PyData and Sphinx v6.
* Conda channel "nsls2forge" no longer needed.
* Remove ``nsls2forge`` channel from conda environment.

New Contributors
-----------------------

* jwkim-anl (Jong Woo Kim, ANL) for the ``plotxy()`` idea.

******

released 2022-11-30

New Features
------------

* Add ``ScalerMotorFlyer()`` device.
* Add functions to support reporting of logging messages.
* Add :meth:`restorable_stage_sigs` decorator.
* Add support for Python 3.11.
* Add ``utils.analysis_1D()`` & ``utils.analysis_2D()`` functions for peaks statistics.

Enhancements
------------

* Add example notebook *Fly Scans with EPICS motor and scaler*.
* Add guide *How to Search in Databroker*.
* Add guide *How to setup logging*.

Maintenance
------------

* Add convenience import:``from apstools.devices import AD_EpicsFileNameMixin``.
* Enable: ``from apstools.devices import AD_EpicsFileNameMixin``.
* Resolve intermittent, random CI failures.
* Resolve problems reporting unit test coverage statistics.
* Unit tests now support Python version 3.8, 3.9, 3.10, & 3.11.

******

released 2022-10-16

Fixes
------------

* [again] Make sure that YML (and other) files are packaged for pip and conda.

******

skipped

******

released 2022-10-13

New Features
------------

* Add ``request_input()`` plan stub, per user request.
* Add fly scan for scaler v. continuous motor.

Maintenance
-----------

* Rename: ``devices.make_dict_device()`` is now ``devices.dict_device_factory()``.

Fixes
------------

* Make sure that YML (and other) files are packaged for pip and conda.
* PVPositioner got stuck if target position was the same as current position.

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

* Removed all snapshot support.