Apstools

******

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``

******

released 2021-10-15

.. Format of the Change History changes with this release to make
the layout become more relevant to the __reader__. The
`release notes <https://github.com/BCDA-APS/apstools/wiki/Release-Notes>`_
on the wiki provide links to these specifics.

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

The ``apstools.beamtime`` module and related content (includes ``apsbss``)
will be moved to a new repository for release 1.6.0. This will
remove the requirement that the APS data management tools (package *aps-dm*,
which only works on the APS computing network) be included. With this
change, users will be able to ``conda install apstools -c aps-anl-tag`` on
computers outside of the APS computing network.

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

* ``apstools.utils.listdevice`` has a new API (old version renamed to ``listdevice_1_5_2``)

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

* Kohzu monochromator ``energy``, ``wavelength``, and ``theta`` each are now a ``PVPositioner`` (subclass).
* Linkam temperature controller CI94
* Linkam temperature controller T96
* Stanford Research Systems 570 current preamplifier
* Stanford Research Systems PTC10 temperature controller
* XIA PF4 filter now supports multiple PF4 units.
* Generalize that amplifiers will have a ``gain`` Component attribute.
* Generalize that temperature controllers will have a ``temperature`` Component attribute that is a positioner (subclass of ``ophyd.PVPositioner``).
* Enhanced positioners for EPICS Devices:
* ``apstools.devices.PVPositionerSoftDone``
* ``apstools.devices.PVPositionerSoftDoneWithStop``

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

* Fixed bug in ``devices.ApsCycleComputedRO`` and ``devices.ApsCycleDM`` involving ``datetime``.

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

* Moved all device support into individual modules under `apstools._devices` because `apstools.devices` module was getting too big. Will refactor all with release 1.6.0.
* Add unit tests for ``devices.ApsCycle*`` Devices.
* Add EPICS IOCs (ADSimDetector and synApps xxx) to continuous integration for use in unit testing.
* Unit tests now use *pytest* package.
* Suppress certain warnings during unit testing.

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

This support will be removed in release 1.6.0:

* ``apstools.beamtime`` module and related content (includes ``apsbss``) will be moved to a new repository
* ``apstools.devices.ProcessController``
* ``apstools.utils.device_read2table``
* ``apstools.utils.listdevice_1_5_2``
* ``apstools.utils.object_explorer``

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

* Fanny Rodolakis
* Gilberto Fabbris
* Jan Ilavsky
* Qingteng Zhang
* 4-ID-C Polar
* 8-ID-I XPCS
* 9-ID-C USAXS

* Drop Codacy (https://app.codacy.com/gh/BCDA-APS/apstools) as no longer needed.

* `540 <https://github.com/BCDA-APS/apstools/pull/540>`_
Add ``apstools.utils.listplans()`` function.

* `534 <https://github.com/BCDA-APS/apstools/pull/534>`_
Add ``apstools.utils.OverrideParameters`` class.
Hoisted from APS USAXS instrument.

* `537 <https://github.com/BCDA-APS/apstools/pull/537>`_
Enhancements to ``apstools.utils.listruns()``:

* Add search by list of ``scan_id`` or ``uid`` values.
* Optimize search speed.

* `534 <https://github.com/BCDA-APS/apstools/pull/534>`_
Add ``apstools.plans.documentation_run()`` plan.
Hoisted from APS USAXS instrument.

* `528 <https://github.com/BCDA-APS/apstools/pull/528>`_
Add ``kind=`` kwarg to synApps Devices.

* `539 <https://github.com/BCDA-APS/apstools/pull/539>`_
Break ``devices`` into submodule ``_devices``.

* `522 <https://github.com/BCDA-APS/apstools/issues/522>`_
Deprecate `apstools.devices.ProcessController`.
Suggest `ophyd.PVPositioner` instead.

* `521 <https://github.com/BCDA-APS/apstools/issues/521>`_
Enhancement: new functions: getRunData(), getRunDataValue(),
getStreamValues() & listRunKeys()

* `518 <https://github.com/BCDA-APS/apstools/issues/518>`_
Bug fixed: TypeError from summary() of CalcoutRecord

* `517 <https://github.com/BCDA-APS/apstools/pull/517>`_
Added support for python 3.9.

* `514 <https://github.com/BCDA-APS/apstools/pull/514>`_
Refactor 'SIGNAL.value' to 'SIGNAL.get()'

* `504 comment <https://github.com/BCDA-APS/apstools/pull/504#issuecomment-804377418>`_
Dropped support for python 3.6.

* `495 <https://github.com/BCDA-APS/apstools/pull/495>`_
Dropped diffractometer support code.

* `511 <https://github.com/BCDA-APS/apstools/pull/511>`_
& `497 <https://github.com/BCDA-APS/apstools/pull/497>`_
Add ``utils.findbyname()`` and ``utils.findbypv()`` functions.

* `506 <https://github.com/BCDA-APS/apstools/pull/506>`_
``spec2ophyd`` can now read SPEC config files from APS 17BM

* `504 <https://github.com/BCDA-APS/apstools/pull/504>`_
Overhaul of listruns() using pandas. Previous code
renamed to listruns_v1_4().

* `503 <https://github.com/BCDA-APS/apstools/pull/503>`_
Unit tests with data now used msgpack-backed databroker.

* `495 <https://github.com/BCDA-APS/apstools/pull/495>`_
remove *hklpy* requirement since all diffractometer
support code will be moved to
[*hklpy*](https://github.com/bluesky/hklpy) package.

* add Area Detector configuration examples:
Pilatus & Perkin-Elmer, both writing image to HDF5 file

* `488 <https://github.com/BCDA-APS/apstools/pull/488>`_
use first trigger_mode when priming AD plugin

* `487 <https://github.com/BCDA-APS/apstools/pull/487>`_
ensure spec2ophyd code is packaged