pymodaq 4.1.4__tar.gz → 4.2.0__tar.gz

{pymodaq-4.1.4 → pymodaq-4.2.0}/.gitignore

@@ -104,6 +104,9 @@ venv.bak/
 .spyderproject
 .spyproject
 
+# VS code project settings
+.vscode/*
+
 # Rope project settings
 .ropeproject
 
@@ -119,6 +122,8 @@ venv.bak/
 
 .tox
 *.h5
+!data.h5
+
 *yacctab.py
 *lextab.py
 

{pymodaq-4.1.4 → pymodaq-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pymodaq
-Version: 4.1.4
+Version: 4.2.0
 Summary: Modular Data Acquisition with Python
 Project-URL: Homepage, http://pymodaq.cnrs.fr
 Project-URL: Source, https://github.com/PyMoDAQ/PyMoDAQ
@@ -44,15 +44,17 @@ Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: User Interfaces
 Requires-Python: >=3.7
+Requires-Dist: bayesian-optimization
 Requires-Dist: easydict
 Requires-Dist: importlib-metadata; python_version < '3.8'
 Requires-Dist: multipledispatch
 Requires-Dist: numpy<2.0.0
 Requires-Dist: packaging
 Requires-Dist: pint
+Requires-Dist: pyleco; python_version >= '3.8'
 Requires-Dist: pymodaq-plugin-manager>=0.0.17
 Requires-Dist: pymodaq-plugins-mock
-Requires-Dist: pyqtgraph<=0.13.3
+Requires-Dist: pyqtgraph>=0.12
 Requires-Dist: python-dateutil
 Requires-Dist: qdarkstyle
 Requires-Dist: qtconsole

{pymodaq-4.1.4 → pymodaq-4.2.0}/pyproject.toml

@@ -36,12 +36,12 @@ dependencies = [
     "easydict",
     "importlib_metadata; python_version<\"3.8\"",
     "multipledispatch",
-    "numpy < 2.0.0", # should be tested once numpy 2.0.0 major will be released
+    "numpy < 2.0.0",
     "packaging",
     "pint",
     "pymodaq_plugin_manager>=0.0.17",
     "pymodaq_plugins_mock",
-    "pyqtgraph<=0.13.3",
+    "pyqtgraph>=0.12",
     "python-dateutil",
     "qdarkstyle",
     "qtpy",
@@ -51,6 +51,8 @@ dependencies = [
     "toml",
     "qtconsole",
     "tables<3.9",  # issue with some version of required package blosc2>=2.2.8
+    "pyleco; python_version>=\"3.8\"",
+    "bayesian-optimization"
 ]
 
 [project.scripts]

{pymodaq-4.1.4 → pymodaq-4.2.0}/src/pymodaq/__init__.py

@@ -39,9 +39,10 @@ try:
     # in a try statement for compilation on readthedocs server but if this fail, you cannot use the code
     from pymodaq.utils.plotting import data_viewers  # imported here as to avoid circular imports later on
     from pymodaq.utils.daq_utils import copy_preset, setLocale, set_qt_backend
-
+    from pymodaq.utils.daq_utils import get_instrument_plugins
     from pymodaq.utils.config import Config
-
+    from pymodaq.utils.scanner.utils import register_scanners
+    from pymodaq.utils.plotting.plotter.plotter import register_plotter, PlotterFactory
 
     # issue on windows when using .NET code within multithreads, this below allows it but requires the
     # pywin32 (pythoncom) package
@@ -66,8 +67,8 @@ try:
     logger.info('')
     logger.info('************************')
     logger.info(f"Setting Qt backend to: {config['qtbackend']['backend']} ...")
-    logger.info('************************')
     set_qt_backend()
+    logger.info('************************')
     logger.info('')
     logger.info('')
     logger.info('************************')
@@ -83,8 +84,44 @@ try:
     Q_ = ureg.Quantity
     logger.info('')
     logger.info('')
-    logger.info('************************')
+    logger.info('*************************************************************************')
     logger.info(f"Getting the list of instrument plugins...")
+    logger.info('')
+    get_instrument_plugins()
+    logger.info('*************************************************************************')
+
+    if config('network', 'leco-server', 'run_coordinator_at_startup'):
+        try:
+            from pymodaq.utils.leco.utils import start_coordinator
+            logger.info('')
+            logger.info('')
+            logger.info(f'********************************')
+            logger.info(f"Starting the LECO Coordinator...")
+            start_coordinator()
+            logger.info(f"Done")
+        except ImportError as e:
+            logger.warning(f'Issue while importing the pyleco package: {str(e)}')
+        except Exception as e:
+            logger.warning(f'Issue while starting the pyleco coordinator: {str(e)}')
+        finally:
+            logger.info('************************')
+            logger.info('')
+            logger.info('')
+
+    logger.info('')
+    logger.info('')
+    logger.info('************************')
+    logger.info(f"Registering Scanners...")
+    register_scanners()
+    logger.info(f"Done")
+    logger.info('************************')
+
+    logger.info('')
+    logger.info('')
+    logger.info('************************')
+    logger.info(f"Registering plotters...")
+    register_plotter()
+    logger.info(f"Done")
     logger.info('************************')
 
 except Exception as e:

{pymodaq-4.1.4 → pymodaq-4.2.0}/src/pymodaq/control_modules/daq_move.py

@@ -10,8 +10,9 @@ from __future__ import annotations
 import numbers
 from importlib import import_module
 from numbers import Number
+from random import randint
 import sys
-from typing import List, Tuple, Union
+from typing import List, Tuple, Union, Optional, Type
 import numpy as np
 
 from qtpy.QtCore import QObject, Signal, QThread, Slot, Qt, QTimer
@@ -20,15 +21,12 @@ from qtpy import QtWidgets
 from easydict import EasyDict as edict
 
 from pymodaq.utils.logger import set_logger, get_module_name
-from pymodaq.control_modules.utils import ControlModule
-from pymodaq.utils.parameter import ioxml
+from pymodaq.control_modules.utils import ParameterControlModule
 from pymodaq.control_modules.daq_move_ui import DAQ_Move_UI, ThreadCommand
-from pymodaq.utils.managers.parameter_manager import ParameterManager, Parameter
 from pymodaq.control_modules.move_utility_classes import MoveCommand, DAQ_Move_base
-from pymodaq.utils.tcp_ip.tcp_server_client import TCPClient
 from pymodaq.control_modules.move_utility_classes import params as daq_move_params
 from pymodaq.utils import daq_utils as utils
-from pymodaq.utils.parameter import utils as putils
+from pymodaq.utils.parameter import Parameter, utils as putils
 from pymodaq.utils.gui_utils import get_splash_sc
 from pymodaq.utils import config as config_mod
 from pymodaq.utils.exceptions import ActuatorError
@@ -37,9 +35,11 @@ from pymodaq.utils.h5modules import module_saving
 from pymodaq.utils.data import DataRaw, DataToExport, DataFromPlugins, DataActuator
 from pymodaq.utils.h5modules.backends import Node
 
+from pymodaq.utils.leco.pymodaq_listener import MoveActorListener, LECOMoveCommands
+
 
 local_path = config_mod.get_set_local_dir()
-sys.path.append(local_path)
+sys.path.append(str(local_path))
 logger = set_logger(get_module_name(__file__))
 config = config_mod.Config()
 
@@ -52,7 +52,7 @@ if len(ACTUATOR_TYPES) == 0:
 STATUS_WAIT_TIME = 1000
 
 
-class DAQ_Move(ParameterManager, ControlModule):
+class DAQ_Move(ParameterControlModule):
     """ Main PyMoDAQ class to drive actuators
 
     Qt object and generic UI to drive actuators.
@@ -75,12 +75,13 @@ class DAQ_Move(ParameterManager, ControlModule):
 
     move_done_signal = Signal(DataActuator)
     current_value_signal = Signal(DataActuator)
-    _update_settings_signal = Signal(edict)
     bounds_signal = Signal(bool)
 
     params = daq_move_params
 
-    def __init__(self, parent=None, title="DAQ Move"):
+    listener_class = MoveActorListener
+
+    def __init__(self, parent=None, title="DAQ Move", **kwargs):
         """
 
         Parameters
@@ -95,15 +96,13 @@ class DAQ_Move(ParameterManager, ControlModule):
         self.logger = set_logger(f'{logger.name}.{title}')
         self.logger.info(f'Initializing DAQ_Move: {title}')
 
-        QObject.__init__(self)
-        ParameterManager.__init__(self, action_list= ('save', 'update'))
-        ControlModule.__init__(self)
+        super().__init__(action_list=('save', 'update'), **kwargs)
 
         self.parent = parent
         if parent is not None:
             self.ui = DAQ_Move_UI(parent, title)
         else:
-            self.ui: DAQ_Move_UI = None
+            self.ui: Optional[DAQ_Move_UI] = None
 
         if self.ui is not None:
             self.ui.actuators = ACTUATOR_TYPES
@@ -172,7 +171,7 @@ class DAQ_Move(ParameterManager, ControlModule):
         elif cmd.command == 'rel_value':
             self._relative_value = cmd.attribute
 
-    def append_data(self, dte: DataToExport = None, where: Union[Node, str] = None):
+    def append_data(self, dte: Optional[DataToExport] = None, where: Union[Node, str, None] = None):
         """Appends current DataToExport to an ActuatorEnlargeableSaver
 
         Parameters
@@ -374,32 +373,14 @@ class DAQ_Move(ParameterManager, ControlModule):
         """bool: status of the actuator's status (done or not)"""
         return self._move_done_bool
 
-    def value_changed(self, param):
+    def value_changed(self, param: Parameter):
         """ Apply changes of value in the settings"""
-        if param.name() == 'connect_server':
-            if param.value():
-                self.connect_tcp_ip()
-            else:
-                self._command_tcpip.emit(ThreadCommand('quit', ))
-
-        elif param.name() == 'ip_address' or param.name == 'port':
-            self._command_tcpip.emit(
-                ThreadCommand('update_connection', dict(ipaddress=self.settings.child('main_settings', 'tcpip',
-                                                                                      'ip_address').value(),
-                                                        port=self.settings.child('main_settings', 'tcpip',
-                                                                                 'port').value())))
-        elif param.name() == 'refresh_timeout':
-            self._refresh_timer.setInterval(param.value())
+        super().value_changed(param=param)
 
-        elif param.name() == 'plugin_config':
-            self.show_config(self.plugin_config)
+        if param.name() == 'refresh_timeout':
+            self._refresh_timer.setInterval(param.value())
 
-        path = self.settings.childPath(param)
-        if path is not None:
-            if 'main_settings' not in path:
-                self._update_settings_signal.emit(edict(path=path, param=param, change='value'))
-                if self.settings.child('main_settings', 'tcpip', 'tcp_connected').value():
-                    self._command_tcpip.emit(ThreadCommand('send_info', dict(path=path, param=param)))
+        self._update_settings(param=param)
 
     def param_deleted(self, param):
         """ Apply deletion of settings """
@@ -470,6 +451,8 @@ class DAQ_Move(ParameterManager, ControlModule):
             self.current_value_signal.emit(self._current_value)
             if self.settings['main_settings', 'tcpip', 'tcp_connected'] and self._send_to_tcpip:
                 self._command_tcpip.emit(ThreadCommand('position_is', status.attribute))
+            if self.settings['main_settings', 'leco', 'leco_connected'] and self._send_to_tcpip:
+                self._command_tcpip.emit(ThreadCommand(LECOMoveCommands.POSITION, status.attribute))
 
         elif status.command == "move_done":
             data_act: DataActuator = status.attribute[0]
@@ -482,6 +465,8 @@ class DAQ_Move(ParameterManager, ControlModule):
             self.move_done_signal.emit(data_act)
             if self.settings.child('main_settings', 'tcpip', 'tcp_connected').value() and self._send_to_tcpip:
                 self._command_tcpip.emit(ThreadCommand('move_done', status.attribute))
+            if self.settings.child('main_settings', 'leco', 'leco_connected').value() and self._send_to_tcpip:
+                self._command_tcpip.emit(ThreadCommand(LECOMoveCommands.MOVE_DONE, status.attribute))
 
         elif status.command == 'outofbounds':
             self.bounds_signal.emit(True)
@@ -586,23 +571,13 @@ class DAQ_Move(ParameterManager, ControlModule):
             self.logger.exception(str(e))
 
     def connect_tcp_ip(self):
-        if self.settings.child('main_settings', 'tcpip', 'connect_server').value():
-            self._tcpclient_thread = QThread()
-
-            tcpclient = TCPClient(self.settings.child('main_settings', 'tcpip', 'ip_address').value(),
-                                  self.settings.child('main_settings', 'tcpip', 'port').value(),
-                                  self.settings.child('move_settings'), client_type="ACTUATOR")
-            tcpclient.moveToThread(self._tcpclient_thread)
-            self._tcpclient_thread.tcpclient = tcpclient
-            tcpclient.cmd_signal.connect(self.process_tcpip_cmds)
-
-            self._command_tcpip[ThreadCommand].connect(tcpclient.queue_command)
-            self._tcpclient_thread.started.connect(tcpclient.init_connection)
-
-            self._tcpclient_thread.start()
+        super().connect_tcp_ip(params_state=self.settings.child('move_settings'),
+                               client_type="ACTUATOR")
 
     @Slot(ThreadCommand)
-    def process_tcpip_cmds(self, status):
+    def process_tcpip_cmds(self, status: ThreadCommand) -> None:
+        if super().process_tcpip_cmds(status=status) is None:
+            return
         if 'move_abs' in status.command:
             self.move_abs(status.attribute[0], send_to_tcpip=True)
 
@@ -621,22 +596,6 @@ class DAQ_Move(ParameterManager, ControlModule):
             self._send_to_tcpip = True
             self.command_hardware.emit(ThreadCommand('get_actuator_value', ))
 
-        elif status.command == 'connected':
-            self.settings.child('main_settings', 'tcpip', 'tcp_connected').setValue(True)
-
-        elif status.command == 'disconnected':
-            self.settings.child('main_settings', 'tcpip', 'tcp_connected').setValue(False)
-
-        elif status.command == 'Update_Status':
-            self.thread_status(status)
-
-        elif status.command == 'set_info':
-            param_dict = ioxml.XML_string_to_parameter(status.attribute[1])[0]
-            param_tmp = Parameter.create(**param_dict)
-            param = self.settings.child('move_settings', *status.attribute[0][1:])
-
-            param.restoreState(param_tmp.saveState())
-
 
 class DAQ_Move_Hardware(QObject):
     """
@@ -658,10 +617,10 @@ class DAQ_Move_Hardware(QObject):
         super().__init__()
         self.logger = set_logger(f'{logger.name}.{title}.actuator')
         self._title = title
-        self.hardware: DAQ_Move_base = None
+        self.hardware: Optional[DAQ_Move_base] = None
         self.actuator_type = actuator_type
         self.current_position: DataActuator = position
-        self._target_value: DataActuator = None
+        self._target_value: Optional[DataActuator] = None
         self.hardware_adress = None
         self.axis_address = None
         self.motion_stoped = False
@@ -702,7 +661,7 @@ class DAQ_Move_Hardware(QObject):
             =============== =================================== ==========================================================================================================================
             **Parameters**   **Type**                             **Description**
 
-             *params_state*  ordered dictionnary list             The parameter state of the hardware class composed by a list representing the tree to keep a temporary save of the tree
+             *params_state*  ordered dictionary list             The parameter state of the hardware class composed by a list representing the tree to keep a temporary save of the tree
 
              *controller*    one or many instance of DAQ_Move     The controller id of the hardware
 
@@ -878,12 +837,12 @@ class DAQ_Move_Hardware(QObject):
     @Slot(edict)
     def update_settings(self, settings_parameter_dict):
         """
-            Update settings of hardware with dictionnary parameters in case of "Move_Settings" path, else update attribute with dictionnary parameters.
+            Update settings of hardware with dictionary parameters in case of "Move_Settings" path, else update attribute with dictionnary parameters.
 
             =========================  =========== ======================================================
             **Parameters**              **Type**    **Description**
 
-            *settings_parameter_dict*  dictionnary  Dictionnary containing the path and linked parameter
+            *settings_parameter_dict*  dictionary  Dictionary containing the path and linked parameter
             =========================  =========== ======================================================
 
             See Also