Apstools

******

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

******

released 2022-01-26

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

* Move ``enable`` Component out from synApps Record devices.
* Renew the unit tests for PVPositionerSoftDoneWithStop.

******

released 2022-01-20

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

* Moved ``apsbss`` support to new ``apsbss`` package (install with either ``pip`` or ``conda``). See https://bcda-aps.github.io/apsbss/ for details.
* Can use Python 3.7 - 3.9. Cannot use Python 3.10 yet due to upstream limitation from databroker and intake packages.
* Moved ``command_list_as_table()`` from `utils` into ``plans/command_list``.
* Removed ``BusyStatus`` from `apstools.synApps.busy`
* ``callbacks/``: ``DocumentCollectorCallback``, ``document_contents_callback``, and ``SnapshotReport`` moved into ``callbacks/``.
* ``devices/``: Reorganized all devices, including ``synApps/``, into ``devices/`` subpackage.
* ``devices/``: ``SynPseudoVoigt()`` moved from ``signals/`` to ``devices/``.
* ``plans/``: Reorganized ``plans.py`` and ``_plans/`` into ``plans/`` subpackage.
* ``snapshot/``: Moved ``snapshot`` application and related files to a subdirectory.
* ``utils/``: Reorganized ``utils.py`` and ``_utils/`` into ``utils/`` subpackage.

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

* Add support for Eurotherm 2216e temperature controller
* Add support for Lakeshore 336 temperature controller
* Add support for Lakeshore 340 temperature controller
* Add support for synApps calc ``scalcout`` record.
* Add support for synApps calc ``sseq`` record.
* Add support for EPICS base ``sub`` record.
* Add support for synApps calc ``userAve`` database.
* Add support for synApps calc ``userStringSeq`` database.
* Add support for synApps calc ``userStringCalc`` database.
* Add support for synApps optics ``2slit`` database.

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

* Convert ``None`` to ``"null"`` when saving ``PeakStats`` to stream.

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

Now testing with Python versions 3.7 - 3.9. (Can't use with Py3.10 yet due to upstream requirements.)

Update notebooks:

* ``demo_specfile_example``
* ``demo_tuneaxis``

Remove notebooks:

* ``demo_specfile_databroker``

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

* Applications

* `apstools_plan_catalog` application and related support.

* Devices

* ``ApsCycleComputedRO``
* ``move_energy()`` method in ``KohzuSeqCtl_Monochromator`` class
* ``ProcessController``

* Utilities

* ``device_read2table``
* ``json_export``
* ``json_import``
* ``listdevice_1_5_2``
* ``listruns_v1_4``
* ``object_explorer``

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

* Gilberto Fabbris
* Jan Ilavsky
* Qingteng Zhang

******

released 2021-11-25

NOTE: The ``apsbss`` component will be moved out of ``apstools`` into its
own package with the next release (1.6.0, ~Feb 2022) of ``apstools``.

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

The Python version is limited to 3.7 due to *aps-dm-api* package. Expect this
limitation to be relaxed, allowing any Python 3.7 and higher with the 1.6.0
release.

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

* Added table of APS run cycle dates. Use that if *aps-dm-api* not available.
* Restricted python version to 3.7 due to upstream *aps_dm_api* package.
* Rename name `uid` to `token` to avoid LGTM security false alert.

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

This support was marked as deprecated in release 1.5.4:

* ``apstools.devices.ApsCycleComputedRO``