Apstools

******

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.

******

released 2022-10-04

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

* Pip requirements updated.

******

released 2022-10-03

New Features and/or Enhancements
---------------------------------------------

* Example of imaging with AreaDetector in Single mode writing HDF5 files.
* ``lineup()``: user can choose which feature (max, min, cen, com), additional API changes.
* ``devices.make_dict_device()`` to make a recordable Device from a dictionary.
* Only publish documentation on demand by executing GitHub workflow.
* Switch HTML documentation to use *PyData* theme.

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

* Re-arranged the documentation. Some examples renamed. Content unchanged.
* Update the APS cycle dates file through 2023-04-30.

******

released 2022-08-15

New Features and/or Enhancements
---------------------------------------------

* Add devices.CamMixin_V3_1_1
* Add devices.CamMixin_V34
* Add devices.SingleTrigger_V34
* Add EpicsScanIdSignal (scan_id from EPICS PV).
* Add run_blocking_function() plan to run blocking functions in the RunEngine.
* Published on conda-forge ``conda install -c conda-forge apstools``.
* replay() can now take a run, [run], header, or [header]
* Switch HTML documentation to use *furo* theme.

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

* Combine install steps, workflows in CI
* Describe how to use the NXWriter callback.
* Refactor AD test with EPICS-controlled image file names.
* Refactor test_move_to_zero().
* Unit tests now support Python version 3.8, 3.9, & 3.10.

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

* ``bluesky_snapshot_viewer`` and underlying GUI code will be dropped by 2022-12-31.
* Drop support for Python 3.7 per NEP29.
* Stop publishing on channel ``-c aps-anl-tag`` (use ``-c conda-forge`` instead).

******

released 2022-07-06

Notice
---------------

* Confirmed: databroker finds HDF5 image files with custom names.
* Still not ready for databroker 2.0+.

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

* Documentation website: https://bcda-aps.github.io/apstools/
* New example: user-controlled HDF5 image file names.
* Using Jupyter notebooks directly (via ``nbsphinx`` extension).
* User-controlled HDF5, JPEG, TIFF image file names.

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

* Fix timeout problem in utils.connect_pvlist().
* Fix unexpected key in datum kwargs.
* Fix ``utils.listdevice()`` mixing dot and underline name separators.

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

* Applied custom project badge for APS software License.
* Use micromamba in testing workflows.

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

* Drop LGTM.com static code analysis service.
* Drop RTD (readthedocs) documentation publishing service.

Contributors
---------------

* Harry Zhou