hardware-control 2.2.0__tar.gz → 3.0.1__tar.gz

{hardware-control-2.2.0 → hardware-control-3.0.1}/.pre-commit-config.yaml

@@ -1,18 +1,18 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.4.0
     hooks:
     -   id: trailing-whitespace
     -   id: requirements-txt-fixer
     -   id: debug-statements
     -   id: check-merge-conflict
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.24.0
+    rev: v3.3.1
     hooks:
     -   id: pyupgrade
         args: ["--py36-plus"]
 -   repo: https://github.com/psf/black
-    rev: 21.7b0
+    rev: 23.1.0
     hooks:
       - id: black
         language_version: python3

{hardware-control-2.2.0 → hardware-control-3.0.1}/.readthedocs.yaml

@@ -5,11 +5,17 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - qmake6
+  tools:
+    python: "3.8"
+
 sphinx:
    configuration: docs/source/conf.py
 
 python:
-  version: "3.8"
   install:
     - method: pip
       path: .

{hardware-control-2.2.0/docs/source → hardware-control-3.0.1}/CHANGELOG.md

@@ -7,6 +7,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.1] 2023-02-18
+
+### CHANGED
+- updated docs
+- Removed auto_update from HCPushButton since it connects to a command not a parameter
+
+### FIXED
+- HCLabel: force convertion to string, so that call to .rjust works all the time
+- TPI: several fixes
+- Fix quering for a serial device
+
+## [3.0.0] 2023-02-18
+
+The main new feature is updating to pyqt6.
+
+### Changed
+- Update from PyQt5 to PyQt6
+- Update to pymodbus > 3.0.0
+- Update to nidaqmx >= 0.6.4
+- Update qtconsole >= 5.3.2
+- any parameter used in a HC-widget or dataset will now by default be updated in app
+
+### Fixed
+- fixed button click in MultiPowerSupply
+- fixed removing continuous command from Oscilloscope
+- fixed setting value in HCSpinBox
+- fixed try_reconnect for DG5353
+- fixed autoscale in plot widget
+
+### Added
+- TPI: new microwave controller
+- Lakeshore 372: new instrument driver
+- Keithley 2400: add voltage measurements
+- Keithley 2001: new driver
+- SRS CIS200: add clear offset command
+- SRS DG645: new driver
+- CAEN: new function to read out v_max
+
+### Removed
+- GPy dependencies
+
 ## [2.2.0] 2022-07-26
 
 ### Added
@@ -17,7 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.1.1] 2022-04-14
 
-### FIXED
+### Fixed
 - Author list in setup.cfg cannot be multiline
 
 ## [2.1.0] 2022-04-13
@@ -88,5 +129,6 @@ Started to use the program at our test stands. Lots of cleanup and improvements
 - Clean up examples
 
 ## [0.0.2] 2020-07-08
+
 ### Added
 - first release on pypi

{hardware-control-2.2.0 → hardware-control-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hardware-control
-Version: 2.2.0
+Version: 3.0.1
 Summary: A package to write QT programs to control hardware
 Home-page: https://bitbucket.org/berkeleylab/hardware-control.git
 Author: "Ariel Amsellem, Arun Persaud, Brian Mak, Brian Wynne, Grant Giesbrecht, Timo Bauer, Zhihao Qin"
@@ -14,13 +14,13 @@ Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/bitbucket-pipelines.yml

@@ -9,6 +9,6 @@ pipelines:
             - pip
           script:
             - apt-get update -y
-            - apt-get install -y libgl1-mesa-glx libsm6 libxext6 libxrender-dev
+            - apt-get install -y '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev libdbus-1-dev
             - pip install .
             - pytest -v tests/* --junitxml=test-reports/report.xml

{hardware-control-2.2.0 → hardware-control-3.0.1/docs/source}/CHANGELOG.md

@@ -7,6 +7,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.1] 2023-02-18
+
+### CHANGED
+- updated docs
+- Removed auto_update from HCPushButton since it connects to a command not a parameter
+
+### FIXED
+- HCLabel: force convertion to string, so that call to .rjust works all the time
+- TPI: several fixes
+- Fix quering for a serial device
+
+## [3.0.0] 2023-02-18
+
+The main new feature is updating to pyqt6.
+
+### Changed
+- Update from PyQt5 to PyQt6
+- Update to pymodbus > 3.0.0
+- Update to nidaqmx >= 0.6.4
+- Update qtconsole >= 5.3.2
+- any parameter used in a HC-widget or dataset will now by default be updated in app
+
+### Fixed
+- fixed button click in MultiPowerSupply
+- fixed removing continuous command from Oscilloscope
+- fixed setting value in HCSpinBox
+- fixed try_reconnect for DG5353
+- fixed autoscale in plot widget
+
+### Added
+- TPI: new microwave controller
+- Lakeshore 372: new instrument driver
+- Keithley 2400: add voltage measurements
+- Keithley 2001: new driver
+- SRS CIS200: add clear offset command
+- SRS DG645: new driver
+- CAEN: new function to read out v_max
+
+### Removed
+- GPy dependencies
+
 ## [2.2.0] 2022-07-26
 
 ### Added
@@ -17,7 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [2.1.1] 2022-04-14
 
-### FIXED
+### Fixed
 - Author list in setup.cfg cannot be multiline
 
 ## [2.1.0] 2022-04-13
@@ -88,5 +129,6 @@ Started to use the program at our test stands. Lots of cleanup and improvements
 - Clean up examples
 
 ## [0.0.2] 2020-07-08
+
 ### Added
 - first release on pypi

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/adding_user_interfaces.md

@@ -27,12 +27,15 @@ structures.
 
 #### Hardware-Control Widgets
 
-Hardware-Control defines a set of modified widgets to simplify building instrument
-interfaces. Examples of such widgets include the `HCPushButton` and `HCLineEdit`,
-which extend the standard Qt classes by connecting them to driver command/parameters
-names, and automatically registering them within the main app. We recommend using these
-widgets (rather than QtWidget objects) since they are pre-configured for reading/setting
-instrument parameters and conveying instrument commands.
+Hardware-Control defines a set of modified widgets to simplify
+building instrument interfaces. Examples of such widgets include the
+`HCPushButton` and `HCLineEdit`, which extend the standard Qt classes
+by connecting them to driver command/parameters names, and
+automatically registering them within the main app. We recommend using
+these widgets (rather than QtWidget objects) since they are
+pre-configured for reading/setting instrument parameters and conveying
+instrument commands. They will also add the instrument/parameter to
+the list of variables that will get automatically pulled by the app.
 
 ### 3. Getting Help
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/index.rst

@@ -4,7 +4,7 @@ Welcome to Hardware-control's documentation!
 Hardware-control is a Python package designed to simplify creating
 instrument control programs (for example for power supplies,
 oscilloscopes, etc.). By using reusable front ends (widgets) and
-instrument drivers hardware-control tries to minimize the
+instrument drivers. Hardware-control tries to minimize the
 effort and code required to communicate with instruments in the lab.
 
 Hardware-control uses a few basic constructs to organize its

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/installation.rst

@@ -1,7 +1,7 @@
 Installation
 ============
 
-Hardware control requires python ≥ 3.6.
+Hardware control requires python ≥ 3.7.
 
 The code is available on `PyPi
 <https://pypi.org/project/hardware-control>`_ and therefore can be

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/instrument_index.rst

@@ -26,9 +26,11 @@ drivers for the NI-DAQ modules and picoscopes.
    instruments/alicat
    instruments/caen
    instruments/keysight
+   instruments/lakeshore
    instruments/ni
    instruments/picotech
    instruments/rigol
    instruments/siglent
    instruments/srs
    instruments/tdkl
+   instruments/trinity_power

hardware-control-3.0.1/docs/source/instruments/lakeshore.rst

@@ -0,0 +1,27 @@
+Lake Shore
+==========
+
+hardware_control.instruments.lakeshore.LakeshoreBase module
+-----------------------------------------------------------
+
+.. automodule:: hardware_control.instruments.lakeshore.LakeshoreBase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hardware_control.instruments.lakeshore.Lakeshore224 module
+----------------------------------------------------------
+
+.. automodule:: hardware_control.instruments.lakeshore.Lakeshore224
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hardware_control.instruments.lakeshore.Lakeshore372 module
+----------------------------------------------------------
+
+.. automodule:: hardware_control.instruments.lakeshore.Lakeshore372
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

hardware-control-3.0.1/docs/source/instruments/picotech.rst

@@ -0,0 +1,10 @@
+Picotech
+========
+
+hardware_control.instruments.picotech.Picoscope module
+------------------------------------------------------
+
+.. automodule:: hardware_control.instruments.picotech.Picoscope
+   :members:
+   :undoc-members:
+   :show-inheritance:

hardware-control-3.0.1/docs/source/instruments/trinity_power.rst

@@ -0,0 +1,11 @@
+Trinity Power
+=============
+
+hardware_control.instruments.trinity_power.tpi module
+-----------------------------------------------------
+
+.. automodule:: hardware_control.instruments.trinity_power.TPI
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/outlook.md

@@ -5,11 +5,11 @@ Plans for the future include (but are not limited to):
 - Adding more instrument drivers
 - Expanding the instrument drivers we have to implement more parameters/commands
 - Modifying the auto-update functionality of the main app to be more flexible, e.g. custom timeout for each instrument
-- Looking into using binary ZMQ messages and sending for example numpy arrays over ZMQ instead of strings
+- Looking into using binary ZMQ messages and sending for example numpy arrays over ZMQ instead of strings (e.g., using msgpack)
 - Create a custom widget that shows all logging messages and lets you filter them on the fly (by loglevel and instrument driver, etc.)
 - Code improvement:
    - adding more type hints
    - adding more tests (e.g. figuring out how to test Qt apps)
-   - improving the code base (running linters such as pylint)
-   - update to Qt6
+   - improving the code base (running linters such as pylint, ruff)
    - replace some logging instances with raising an exception where appropiate (currently we only use logger.error)
+   - in the instrument drivers switch from commands (no argument) and parameters (one argument) to something that can handle multiple arguments

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/supported_instruments.rst

@@ -70,6 +70,9 @@ provide a pull request.
      * - `Lake Shore Model 224 <https://www.lakeshore.com/products/categories/overview/temperature-products/cryogenic-temperature-monitors/model-224-temperature-monitor>`_
        - .. image:: /images/Lake_Shore_224.png
            :height: 100
+     * - `Lake Shore Model 372 <https://www.lakeshore.com/products/categories/overview/temperature-products/ac-resistance-bridges/model-372-ac-resistance-bridge-temperature-controller>`_
+       - .. image:: /images/Lake_Shore_372.png
+           :height: 100
 
 
 - Ion Gauge:
@@ -108,6 +111,9 @@ provide a pull request.
      * - `Siglent SDG Series <https://www.siglent.eu/waveform-generators>`_ (LAN)
        - .. image:: /images/SDG1000X.png
            :height: 100
+     * - `Trinity Power TPI <https://rf-consultant.com/products/tpi-1001-b-signal-generator/>`_ (USB)
+       - .. image:: /images/TPI.jpg
+           :height: 100
 
 
 - IOModule:

{hardware-control-2.2.0 → hardware-control-3.0.1}/docs/source/using_hardware_control.md

@@ -114,7 +114,7 @@ To run your program, just call `sys.exit(app.exec_())`!
 A complete sample program could look like this:
 
     # Import required modules
-    from PyQt5.QtWidgets import QGridLayout, QWidget
+    from PyQt6.QtWidgets import QGridLayout, QWidget
     import sys
 
     import hardware_control as hc

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/Caen14xxET_demo.py

@@ -19,7 +19,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/DelayGenerator_demo.py

@@ -16,7 +16,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control as hc

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/FlowController_demo.py

@@ -19,7 +19,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QGridLayout, QTabWidget
+from PyQt6.QtWidgets import QGridLayout, QTabWidget
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/FunctionGenerator_demo.py

@@ -17,7 +17,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QMainWindow, QWidget, QGridLayout
+from PyQt6.QtWidgets import QMainWindow, QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control as hc

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/FunctionGenerator_demo_Siglent.py

@@ -17,7 +17,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QMainWindow, QWidget, QGridLayout
+from PyQt6.QtWidgets import QMainWindow, QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control as hc

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/IOModule_demo.py

@@ -16,7 +16,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 from docopt import docopt
 from pathlib import Path
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/KeysightPowerSupply_demo.py

@@ -20,8 +20,8 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
-from PyQt5.QtGui import QDoubleValidator
+from PyQt6.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtGui import QDoubleValidator
 
 import hardware_control as hc
 

hardware-control-3.0.1/examples/Single_Instrument_Demos/MicrowaveController_demo.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+"""Microwave-Controller demo
+
+Usage:
+  MicrowaveController_demo.py [--conn_addr=CONN_ADD] [--dummy] [--debug] [--console] [--info]
+
+Options:
+  --conn_addr=CONN_ADD  Connection address of physical instrument [default: None].
+                        Required if not in dummy mode.
+  --dummy               Use dummy connection for instruments that return semi-random data
+                        so that one can run the program away from the test stand.
+  --debug               Allow debug print statements.
+  --info                Allow info print statements.
+  --console             Print logger output to console.
+"""
+
+import logging
+import sys
+
+from docopt import docopt
+
+from PyQt6.QtWidgets import QGridLayout, QTabWidget
+
+import hardware_control as hc
+
+commands = docopt(__doc__)
+dummy = commands["--dummy"]
+conn_addr = commands["--conn_addr"]
+
+logger = logging.getLogger(__name__)
+hc.setup_logging_docopt(logger, commands)
+
+
+class Demo(hc.HCMainWindow):
+    def __init__(self, dummy):
+        super().__init__(dummy=dummy)
+
+        self.setWindowTitle("Microwave Controller Demo")
+
+        # This is the main widget (a widget with tabs), actual device widgets are added to it
+        self.tabs = QTabWidget()
+
+        # Create an flow controller Alicat_M_Series instrument backend and add it to the app
+        self.app.add_instrument(hc.instruments.TPI.TPI("MW", conn_addr))
+
+        # Create a FlowController GUI control that connects to the instrument backend
+        self.instr_ctrl = hc.gui.MicrowaveController(
+            self.app, "MW", "Mirowave Controller"
+        )
+
+        # Create an interactive ipython console
+        self.ipython = hc.gui.Qtconsole(self.app)
+
+        # Create tabs for the flow controller control and the ipython console, respectively
+        self.tabs.addTab(self.instr_ctrl, "Instruments")
+        self.tabs.addTab(self.ipython, "Interactive")
+
+        self.setCentralWidget(self.tabs)
+        self.show()
+
+
+main_window = Demo(dummy=dummy)
+sys.exit(main_window.app.exec_())

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/Oscilloscope_demo.py

@@ -16,7 +16,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control.instruments as hc_inst

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/Oscilloscope_demo_Rigol.py

@@ -16,7 +16,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control.instruments as hc_inst

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/Picoscope_demo.py

@@ -14,7 +14,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control.instruments as hc_inst

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/RGA_demo.py

@@ -16,7 +16,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QMainWindow, QWidget, QGridLayout
+from PyQt6.QtWidgets import QMainWindow, QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control as hc

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/RigolPowerSupply_demo.py

@@ -19,7 +19,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/TDKLGenH_demo.py

@@ -19,7 +19,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/Single_Instrument_Demos/TempMonitor_demo.py

@@ -16,7 +16,7 @@ Options:
 import logging
 import sys
 
-from PyQt5.QtWidgets import QMainWindow, QWidget, QGridLayout
+from PyQt6.QtWidgets import QMainWindow, QWidget, QGridLayout
 from docopt import docopt
 
 import hardware_control as hc

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/dataset_plotting.py

@@ -16,7 +16,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QGridLayout, QTabWidget
+from PyQt6.QtWidgets import QGridLayout, QTabWidget
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/hooks.py

@@ -16,7 +16,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QGridLayout, QVBoxLayout, QWidget
+from PyQt6.QtWidgets import QGridLayout, QVBoxLayout, QWidget
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/interactive_python.py

@@ -16,7 +16,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QGridLayout, QTabWidget
+from PyQt6.QtWidgets import QGridLayout, QTabWidget
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/remote_instrument/main_app.py

@@ -17,7 +17,7 @@ import sys
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QTabWidget
+from PyQt6.QtWidgets import QTabWidget
 
 import hardware_control as hc
 

{hardware-control-2.2.0 → hardware-control-3.0.1}/examples/scan_widget.py

@@ -19,7 +19,7 @@ import random
 
 from docopt import docopt
 
-from PyQt5.QtWidgets import QWidget, QGridLayout
+from PyQt6.QtWidgets import QWidget, QGridLayout
 
 import hardware_control as hc
 

hardware-control-3.0.1/hardware_control/_version.py

@@ -0,0 +1,4 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = '3.0.1'
+__version_tuple__ = version_tuple = (3, 0, 1)

{hardware-control-2.2.0 → hardware-control-3.0.1}/hardware_control/base/App.py

@@ -7,8 +7,8 @@ import time
 from typing import Union, Optional, Callable, Any, List
 from datetime import datetime
 
-from PyQt5.QtWidgets import QApplication
-from PyQt5.QtCore import QTimer
+from PyQt6.QtWidgets import QApplication
+from PyQt6.QtCore import QTimer
 import zmq
 
 from .Dataset import Dataset