Pylablib

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Added expandable edit boxes and dialog containers.
- Improved Thorlabs devices compliance.
- Additional minor bugfixes in threading, GUI, devices.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- General

* Minor speedups through calls caching.
* Changed ``muxcall`` signature to allow multiple special argument values.

- Devices

* Added Princeton Instruments cameras, IDS uEye cameras (as an option in uc480 cameras backend), Thorlabs Kinesis piezo motor controllers (e.g., KIM101) and quadrature photo-detector controllers (e.g., KPA101).
* Added RS485 Arcus connection and a simple single-motor stage (DMX-J-SA).
* Improved reliability if errors are encountered upon connection.
* Multiple minor bug fixes and improved support of specific models.

- GUI

* Added widgets: menu dropdown button, scroll area container, area highlighter.
* Added querying element position and layout shape in layout widgets.
* Added more utilities methods: querying containing layout, querying top-level parent, deleting widget.

- Threading

* Added simple profiling through ``yappi``.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- General

* Added restarting methods for regular and threaded applications.

- Threading

* Bugfixes in cameras and camera threads.
* Bugfixes in streaming.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- General

* Added ``timing`` context manager for simple code timing checks.
* Improved RPyC wrapper logging and reliability.
* Added Anaconda support.
* Added minor network and file functions.

- Devices

* Added Newport Picomotor 8742 motor controller, Toptica iBeam Smart laser, older version of Thorlabs FW motorized filter wheel.
* Added camera frame output format (list or array).
* Added ``use_cavity`` option to M2 Solstis laser.
* Added method for auto-detecting associations between PhotonFocus cameras and frame grabbers.
* Updated some generic classes (DCAM cameras, Thorlabs TLCamera cameras).
* Updated SCPI failsafe operation, improved Thorlabs FW reliability.
* Fixed several minor bugs.

- GUI

* Rewritten GUI values handling to pass calls in a hierarchical manner. This makes the operation more predictable and overloading the behavior a bit easier.
* Added out-of-range value action for combo boxes.
* Fixed ``ImagePlotter`` incompatibility with the newer pyqtgraph versions, added separate x and y axis line cuts selection.
* Minor layout handling bugfixes.

- Threading

* Released advanced threading functionality: table/frame streaming, device threads, basic frame processing.
* Task thread additions: delayed batch job stopping, context manager for task loop pausing.
* Added argument-dependent call queue limit.
* Improved threading speed and stability.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- General

* Reorganized the core modules import structure: now ``__init__.py`` modules are mostly empty, and all the necessary imports are either exposed directly in ``pylablib`` (e.g., ``pylablib.Fitter``), or should be accessed directly by the module (e.g. ``pll.core.dataproc.fitting.Fitter``). Intermediate access (e.g., ``pll.core.dataproc.Fitter``) is no longer supported.
* File IO functions (e.g., ``read_csv``) can now take file-like objects in addition to paths.

- Devices

* Added Silicon Software frame grabbers interface and rearranged PhotonFocus code to include both IMAQ and SiliconSoftware frame grabbers.
* Fixed various compatibility bugs arising for specific versions of Python or dependency modules: Kinesis error with specific pyft232 versions, some DLL-dependent devices errors with Python 3.8+, DLL types in 32-bit Python.
* Addressed issue with occasional uc480 acquisition restarts, fixed M2 communication report errors.

- GUI and threading

* Added container and layout management classes in addition to parameter tables for more consistent GUI structure organization.
* Added ``pylablib.widgets`` module which combines all custom widgets for the ease of using in layout managers or custom applications.
* Fixed support for ``PySide2`` Qt5 backed.
* Renamed ``setupUi`` -> ``setup`` for all widgets, and changed the GUI setup organization for many of them (the functioning stayed the same).
* Reorganized scheduling in ``QTaskThread`` to treat jobs, commands, and subscriptions more consistently.
* Added basic data stream management.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There have been too many alterations to list here comprehensively. Below is the list of the largest changes.

- General

* Removed built-in ``DataTable`` class (together with ``core.datatable`` subpackage) in favor of pandas.
* Renamed file IO functions: instead of generic ``load`` and ``save`` methods there are now more specific :func:`.loadfile.load_csv`, :func:`.loadfile.load_dict`, etc.
* Removed some legacy modules which are not used in the rest of the library.
* Renamed or moved certain modules: ``core.utils.rpyc`` -> ``core.utils.rpyc_utils``, ``core.fileio.logfile`` -> ``core.fileio.table_stream``, ``core.fileio.binio`` -> ``core.utils.binio`` , ``core.devio.backend`` -> ``core.devio.backencd_comm``, ``core.devio.untis`` -> ``core.utils.units``, ``core.dataproc.waveforms`` -> ``core.dataproc.utils``

- Devices

* Some legacy devices have been removed, since without access to the hardware it is hard to maintain and expand them. These include most of Agilent devices (33502A amplifier, N9310A microwave generator, HP 8712B and HP 8722D network analyzers, HP 8168F laser), Rigol DSA1030A spectrum analyzer, Tektronix MDO3000 oscilloscope, Vaunix LabBrick generators, Zurich Instruments HF2 and UHF, Andor Shamrock spectrographs (should be restored in future releases), NuPhoton NP2000 EDFA, PurePhotonics PPCL200 laser, Sirah Matisse laser (should be restored in future releases), Thorlabs PM100 power meter (should be restored in future releases), Lakeshore 370 resistance bridge (should be restored in future releases), MKS 900-series pressure gauges, and some custom devices (Arduino and Olimex AVR boards and Janis-related hardware).
* The main devices package has been moved from ``pylablib.aux_libs.devices`` (which now refers to the legacy code) to ``pylablib.devices``. Module organization has also changed slightly. To find the required modules and device class names, see the :ref:`devices list <devices_root>`.
* Lots of devices' interface has varied slightly, to make the interface more uniform and compatible between different kinds of devices. The changes are usually fairly straightforward (e.g., ``move_to`` instead of ``move``). In many cases the interface was also expanded to include additional available methods.
* Several devices have been added, generalized, or restructured:

+ Combined Thorlabs KDC101 and K10CR1 into a single class :class:`pylablib.devices.Thorlabs.BasicKinesisDevice<.kinesis.BasicKinesisDevice>`, which also accommodates similar kinds of devices.
+ Added Arcus Performax2EXStage device for 2-axis controller with a slightly different interface (:class:`pylablib.devices.Arcus.Performax2EXStage<.performax.Performax2EXStage>`)
+ Added :ref:`several more AWGs <awg_generic>` with similar interfaces

* Simplified the way external DLLs are :ref:`handled <devices_external_dependencies>`
* Unified the :ref:`error handling <devices_error_handling>`

- GUI and threading

* Changed module structure

+ threading and GUI are now separate sub-packages ``core.thread`` and ``core.gui``
+ all widgets are available simply through ``pylablib.widgets`` (simplifies integration with Qt Designer)
+ moved parameter tables widgets to the core library

* Renamed some widgets to remove the ``LV`` prefix.
* Interfaces changes in some of the classes: thread controllers, parameter tables, value tables. The changes are mostly cosmetics and involve names and parameters order. Most important changes:

+ thread controller methods: ``subscribe`` -> ``subscribe_sync``, ``sync_exec`` -> ``sync_exec_point``,
+ thread controller command/query shortcut: ``.c`` -> ``.ca``, ``.q`` -> ``.cs``, ``.qi`` -> ``.csi``, ``.qs`` -> ``.css``
+ thread controller variable access uses ``.v`` shortcut, i.e., instead of ``ctl[name]`` it is now ``ctl.v[name]``
+ GUI value storage ``ValuesTable``/``IndicatorValuesTable`` are now combined and named as ``GUIValues``
+ ``ParamTable`` and ``GUIValues`` uses ``.h`` shortcut to access value handlers, i.e., instead of ``table[name]`` it is now ``table.h[name]``
+ ``ParamTable``, ``ImagePlotterCtl``, ``TracePlotterCtl`` constructor arguments: ``display_table`` -> ``gui_values``, ``display_table_root`` -> ``gui_values_root``
+ value-changed signal names in ``ParamTable`` and ``GUIValues``: ``changed_event`` -> ``get_value_changed_signal``
+ value-changed signal names in value handlers: ``value_changed_signal`` -> ``get_value_changed_signal``
+ ``ParamTable`` methods: ``lock`` -> ``set_enabled``, ``add_button(checkable=True)`` -> ``add_toggle_button``
+ ``NumEdit`` and ``NumLabel`` methods: ``set_number_format`` -> ``set_formatter``, ``set_number_limit`` -> ``set_limiter`` (the call signature also changed)
+ renamed signals to multicasts to avoid confusion with built-in Qt signals. Leads to ``ThreadController.send_signal`` -> ``send_multicast``, ``ThreadController.process_signal`` -> ``process_multicast``, ``ThreadController`` constructor argument ``signal_pool`` -> ``multicast_pool``, class ``SignalPool`` -> ``MulticastPool``, ``QSignalThreadCallScheduler`` -> QMulticastThreadCallScheduler.


Version 0.x
----------------------------