pymodaq 4.4.7__py3-none-any.whl → 5.0.1__py3-none-any.whl

pymodaq/__init__.py

@@ -6,112 +6,78 @@ from pathlib import Path
 
 import warnings
 
+import pymodaq_utils  # to init stuff related to pymodaq_utils  # necessary, leave it there
+import pymodaq_data  # to init stuff related to pymodaq_data  # necessary, leave it there
+import pymodaq_gui  # to init stuff related to pymodaq_gui  # necessary, leave it there
 
-def check_qt_presence():
-    try:
-        from qtpy import QtWidgets
-    except ImportError as e:
-        msg = f"\n\n" \
-              f"****************************************************************************************\n" \
-              f"No Qt backend could be found in your system, please install either pyqt5/6 or pyside2/6.\n\n" \
-              f"pyqt5 is still preferred, while pyqt6 should mostly work.\n\n" \
-              f"do:\n" \
-              f"pip install pyqt5\n for instance\n"\
-              f"****************************************************************************************\n"
-        warnings.warn(msg, FutureWarning, 2)
-        sys.exit()
-
-
-check_qt_presence()
+from pymodaq_data import Q_, Unit, ureg  # necessary, leave it there
 
 
 try:
     # with open(str(Path(__file__).parent.joinpath('resources/VERSION')), 'r') as fvers:
     #     __version__ = fvers.read().strip()
 
-    from pymodaq.utils.logger import set_logger
-    from pymodaq.utils.daq_utils import get_version
-    __version__ = get_version()
+    from pymodaq_utils.logger import set_logger
+    from pymodaq_utils.utils import get_version
+    __version__ = get_version('pymodaq')
     try:
         logger = set_logger('pymodaq', add_handler=True, base_logger=True)
-    except Exception:
-        print("Couldn't create the local folder to store logs , presets...")
 
-    logger.info('')
-    logger.info('')
-    logger.info('************************')
-    logger.info('Starting PyMoDAQ modules')
-    logger.info('************************')
-    logger.info('')
-    logger.info('')
-    logger.info('************************')
-    logger.info('Initializing the pint unit register')
-    logger.info('************************')
-    ureg = UnitRegistry()
-    ureg.default_format = '~'
-    Q_ = ureg.Quantity
-    Unit = ureg.Unit
-    ureg.define('whatever = 1  = wr')  # defining whatever as a dimensionless quantity
-    logger.info('')
-    logger.info('')
-
-    # 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
-    if importlib.util.find_spec('clr') is not None:
+        from pymodaq.utils.daq_utils import copy_preset, get_instrument_plugins
+
+        from pymodaq_utils.config import Config
+        from pymodaq.utils.scanner.utils import register_scanners
+        from pymodaq_data.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
+        if importlib.util.find_spec('clr') is not None:
+            try:
+                import pythoncom
+                pythoncom.CoInitialize()
+            except ModuleNotFoundError as e:
+                infos = "You have installed plugins requiring the pywin32 package to work correctly," \
+                        " please type in *pip install pywin32* and restart PyMoDAQ"
+                print(infos)
+                logger.warning(infos)
+
+        config = Config()  # to ckeck for config file existence, otherwise create one
+        copy_preset()
+
+        from pymodaq_utils.config import Config
+        from pymodaq.utils.scanner.utils import register_scanners
+
         try:
-            import pythoncom
-            pythoncom.CoInitialize()
+            # Need the config to exists before importing
+            from pymodaq_utils.environment import EnvironmentBackupManager
+
+            if config['backup']['keep_backup']:
+                ebm = EnvironmentBackupManager()
+                ebm.save_backup()
         except ModuleNotFoundError as e:
-            infos = "You have installed plugins requiring the pywin32 package to work correctly," \
-                    " please type in *pip install pywin32* and restart PyMoDAQ"
+            infos = "Your pymodaq_utils version is outdated and doesn't allow for automatic backup of pip packages." \
+                    " You should update it."
             print(infos)
             logger.warning(infos)
 
-    config = Config()  # to ckeck for config file existence, otherwise create one
-    copy_preset()
-
-    logger.info('************************')
-    logger.info(f"Setting Qt backend to: {config['qtbackend']['backend']} ...")
-    set_qt_backend()
-    logger.info('************************')
-    logger.info('')
-    logger.info('')
-    logger.info('************************')
-    logger.info(f"Setting Locale to {config['style']['language']} / {config['style']['country']}")
-    logger.info('************************')
-    setLocale()
-    logger.info('')
-    logger.info('')
-
-    logger.info('*************************************************************************')
-    logger.info(f"Getting the list of instrument plugins...")
-    logger.info('')
-    get_instrument_plugins()
-    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('************************')
+        logger.info('*************************************************************************')
+        logger.info(f"Getting the list of instrument plugins...")
+        logger.info('')
+        get_instrument_plugins()
+        logger.info('*************************************************************************')
+
+        logger.info('')
+        logger.info('')
+        logger.info('************************')
+        logger.info(f"Registering Scanners...")
+        register_scanners()
+        logger.info(f"Done")
+        logger.info('************************')
+
+    except Exception:
+        print("Couldn't create the local folder to store logs , presets...")
+
+
 
 except Exception as e:
     try:

pymodaq/control_modules/daq_move.py

@@ -20,34 +20,42 @@ 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 ParameterControlModule
-from pymodaq.control_modules.daq_move_ui import DAQ_Move_UI, ThreadCommand
-from pymodaq.control_modules.move_utility_classes import (MoveCommand, DAQ_Move_base,
-                                                          DataActuatorType, check_units)
-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.logger import set_logger, get_module_name
+from pymodaq_utils.utils import ThreadCommand
+from pymodaq_utils import utils
 from pymodaq.utils.gui_utils import get_splash_sc
-from pymodaq.utils import config as config_mod
+from pymodaq_utils import config as config_mod
 from pymodaq.utils.exceptions import ActuatorError
-from pymodaq.utils.messenger import deprecation_msg
+from pymodaq_utils.warnings import deprecation_msg
+from pymodaq.utils.data import DataToExport, DataActuator
+from pymodaq_data.h5modules.backends import Node
+
+from pymodaq_gui.parameter import ioxml, Parameter
+from pymodaq_gui.parameter import utils as putils
+from pymodaq_gui.utils.utils import mkQApp
+
 from pymodaq.utils.h5modules import module_saving
-from pymodaq.utils.data import (DataRaw, DataToExport, DataFromPlugins, DataActuator, Unit,
-                                DataUnitError)
-from pymodaq.utils.h5modules.backends import Node
-from pymodaq.utils.parameter import ioxml, Parameter
+from pymodaq.control_modules.utils import ParameterControlModule
+from pymodaq.control_modules.daq_move_ui import DAQ_Move_UI, ThreadCommand
+from pymodaq.control_modules.move_utility_classes import (MoveCommand, DAQ_Move_base,
+                                                          DataActuatorType, check_units,
+                                                          DataUnitError)
 
+
+from pymodaq.control_modules.move_utility_classes import params as daq_move_params
 from pymodaq.utils.leco.pymodaq_listener import MoveActorListener, LECOMoveCommands
+
+from pymodaq.utils.daq_utils import get_plugins
 from pymodaq import Q_, Unit
 
 
+
 local_path = config_mod.get_set_local_dir()
 sys.path.append(str(local_path))
 logger = set_logger(get_module_name(__file__))
 config = config_mod.Config()
 
-DAQ_Move_Actuators = utils.get_plugins('daq_move')
+DAQ_Move_Actuators = get_plugins('daq_move')
 ACTUATOR_TYPES = [mov['name'] for mov in DAQ_Move_Actuators]
 if len(ACTUATOR_TYPES) == 0:
     raise ActuatorError('No installed Actuator')
@@ -116,7 +124,7 @@ class DAQ_Move(ParameterControlModule):
         self.splash_sc = get_splash_sc()
         self._title = title
         if len(ACTUATOR_TYPES) > 0:  # will be 0 if no valid plugins are installed
-            self.actuator = ACTUATOR_TYPES[0]
+            self.actuator = kwargs.get('actuator', ACTUATOR_TYPES[0])
 
         self.module_and_data_saver = module_saving.ActuatorSaver(self)
 
@@ -450,11 +458,10 @@ class DAQ_Move(ParameterControlModule):
         super().thread_status(status, 'move')
 
         if status.command == "ini_stage":
-            # status.attribute[0]=edict(initialized=bool,info="", controller=)
-            self.update_status("Stage initialized: {:} info: {:}".format(status.attribute[0]['initialized'],
-                                                                         status.attribute[0]['info']))
-            if status.attribute[0]['initialized']:
-                self.controller = status.attribute[0]['controller']
+            self.update_status(f"Stage initialized: {status.attribute['initialized']} "
+                               f"info: {status.attribute['info']}")
+            if status.attribute['initialized']:
+                self.controller = status.attribute['controller']
                 if self.ui is not None:
                     self.ui.actuator_init = True
                 self._initialized_state = True
@@ -465,7 +472,10 @@ class DAQ_Move(ParameterControlModule):
             self.init_signal.emit(self._initialized_state)
 
         elif status.command == "get_actuator_value" or status.command == 'check_position':
-            data_act: DataActuator = status.attribute[0]
+            if isinstance(status.attribute, DataActuator):
+                data_act: DataActuator = status.attribute
+            else:
+                data_act: DataActuator = status.attribute[0]  # backcompatibility
             data_act.name = self.title  # for the DataActuator name to be the title of the DAQ_Move
             if (not Unit(self.units).is_compatible_with(Unit(data_act.units)) and
                     data_act.units == ''):  #this happens if the units have not been specified in
@@ -480,12 +490,15 @@ class DAQ_Move(ParameterControlModule):
             self._current_value = data_act
             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))
+                self._command_tcpip.emit(ThreadCommand('position_is', data_act))
             if self.settings['main_settings', 'leco', 'leco_connected'] and self._send_to_tcpip:
-                self._command_tcpip.emit(ThreadCommand(LECOMoveCommands.POSITION, status.attribute))
+                self._command_tcpip.emit(ThreadCommand(LECOMoveCommands.POSITION, data_act))
 
         elif status.command == "move_done":
-            data_act: DataActuator = status.attribute[0]
+            if isinstance(status.attribute, DataActuator):
+                data_act: DataActuator = status.attribute
+            else:
+                data_act: DataActuator = status.attribute[0]  # deprecated
             data_act.name = self.title  # for the DataActuator name to be the title of the DAQ_Move
             if self.ui is not None:
                 self.ui.display_value(data_act)
@@ -494,9 +507,9 @@ class DAQ_Move(ParameterControlModule):
             self._move_done_bool = True
             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))
+                self._command_tcpip.emit(ThreadCommand('move_done', data_act))
             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))
+                self._command_tcpip.emit(ThreadCommand(LECOMoveCommands.MOVE_DONE, data_act))
 
         elif status.command == 'outofbounds':
             self.bounds_signal.emit(True)
@@ -616,10 +629,12 @@ class DAQ_Move(ParameterControlModule):
         if ('°' in unit or 'degree' in unit) and not '°C' in unit:
             # special cas as pint base unit for angles are radians
             return '°'
-        elif 'W' in unit or 'watt' in unit:
+        elif 'W' in unit or 'watt' in unit.lower():
             return 'W'
         elif '°C' in unit or 'Celsius' in unit:
             return '°C'
+        elif 'V' in unit or 'volt' in unit.lower():
+            return 'V'
         else:
             return str(Q_(1, unit).to_base_units().units)
 
@@ -711,17 +726,19 @@ class DAQ_Move_Hardware(QObject):
             Uninitialize the stage closing the hardware.
 
         """
-        self.hardware.close()
+        if self.hardware is not None and self.hardware.controller is not None:
+            self.hardware.close()
 
         return "Stage uninitialized"
 
     def get_actuator_value(self):
         """Get the current position checking the hardware value.
         """
-        pos = self.hardware.get_actuator_value()
-        if self.hardware.data_actuator_type == DataActuatorType.float:
-            pos = DataActuator(self._title, data=pos, units=self.hardware.axis_unit)
-        return pos
+        if self.hardware is not None:
+            pos = self.hardware.get_actuator_value()
+            if self.hardware.data_actuator_type == DataActuatorType.float:
+                pos = DataActuator(self._title, data=pos, units=self.hardware.axis_unit)
+            return pos
 
     def check_position(self):
         """Get the current position checking the hardware position (deprecated)
@@ -817,7 +834,7 @@ class DAQ_Move_Hardware(QObject):
             --------
             DAQ_utils.ThreadCommand
         """
-        self.status_sig.emit(ThreadCommand("move_done", [pos]))
+        self.status_sig.emit(ThreadCommand("move_done", pos))
 
     def move_home(self):
         """
@@ -832,7 +849,7 @@ class DAQ_Move_Hardware(QObject):
         """Send the move_done signal back to the main class
         """
         self._current_value = pos
-        self.status_sig.emit(ThreadCommand(command="move_done", attribute=[pos]))
+        self.status_sig.emit(ThreadCommand(command="move_done", attribute=pos))
 
     @Slot(ThreadCommand)
     def queue_command(self, command: ThreadCommand):
@@ -860,10 +877,10 @@ class DAQ_Move_Hardware(QObject):
             * **reset_stop_motion** command, set the motion_stopped attribute to false
         """
         try:
+            logger.debug(f'Threadcommand {command.command} sent to {self.title}')
             if command.command == "ini_stage":
-                status = self.ini_stage(
-                    *command.attribute)  # return edict(initialized=bool,info="", controller=, stage=)
-                self.status_sig.emit(ThreadCommand(command=command.command, attribute=[status, 'log']))
+                status: edict = self.ini_stage(*command.attribute)
+                self.status_sig.emit(ThreadCommand(command=command.command, attribute=status))
 
             elif command.command == "close":
                 status = self.close()
@@ -891,11 +908,13 @@ class DAQ_Move_Hardware(QObject):
             else:  # custom commands for particular plugins (see spectrometer module 'get_spectro_wl' for instance)
                 if hasattr(self.hardware, command.command):
                     cmd = getattr(self.hardware, command.command)
-                    cmd(*command.attribute)
+                    if isinstance(command.attribute, list):
+                        cmd(*command.attribute)
+                    elif isinstance(command.attribute, dict):
+                        cmd(**command.attribute)
         except Exception as e:
             self.logger.exception(str(e))
 
-
     def stop_motion(self):
         """
             stop hardware motion with motion_stopped attribute updtaed to True and a status signal sended with an "update_status" Thread Command
@@ -906,7 +925,8 @@ class DAQ_Move_Hardware(QObject):
         """
         self.status_sig.emit(ThreadCommand(command="Update_Status", attribute=["Motion stoping", 'log']))
         self.motion_stoped = True
-        self.hardware.stop_motion()
+        if self.hardware is not None and self.hardware.controller is not None:
+            self.hardware.stop_motion()
         self.hardware.poll_timer.stop()
 
     @Slot(edict)
@@ -932,15 +952,13 @@ class DAQ_Move_Hardware(QObject):
                 setattr(self, path[-1], param.value())
 
         elif path[0] == 'move_settings':
-            self.hardware.update_settings(settings_parameter_dict)
+            if self.hardware is not None:
+                self.hardware.update_settings(settings_parameter_dict)
 
 
 def main(init_qt=True):
     if init_qt:  # used for the test suite
-        app = QtWidgets.QApplication(sys.argv)
-        if config('style', 'darkstyle'):
-            import qdarkstyle
-            app.setStyleSheet(qdarkstyle.load_stylesheet(qdarkstyle.DarkPalette))
+        app = mkQApp("PyMoDAQ Move")
 
     widget = QtWidgets.QWidget()
     prog = DAQ_Move(widget, title="test")

pymodaq/control_modules/daq_move_ui.py

@@ -13,15 +13,18 @@ from qtpy import QtWidgets
 from qtpy.QtCore import Signal, Qt
 from qtpy.QtWidgets import QHBoxLayout, QVBoxLayout, QGridLayout, QWidget, QToolBar, QComboBox
 
-from pymodaq.utils.daq_utils import ThreadCommand
-from pymodaq.utils.gui_utils.custom_app import CustomApp
-from pymodaq.utils.gui_utils.widgets import PushButtonIcon, LabelWithFont, SpinBox, QSpinBox_ro, QLED
+from pymodaq_utils.utils import ThreadCommand
+from pymodaq_utils.config import Config
+
+from pymodaq_data import Q_
+
+from pymodaq_gui.utils.widgets import PushButtonIcon, LabelWithFont, SpinBox, QSpinBox_ro, QLED, QSpinBoxWithShortcut
+from pymodaq_gui.utils import DockArea
+from pymodaq_gui.plotting.data_viewers.viewer import ViewerDispatcher
+
 from pymodaq.control_modules.utils import ControlModuleUI
-from pymodaq.utils.gui_utils import DockArea
-from pymodaq.utils.plotting.data_viewers.viewer import ViewerDispatcher
-from pymodaq.utils.data import DataWithAxes, DataToExport, DataActuator
+from pymodaq.utils.data import DataToExport, DataActuator
 
-from pymodaq.utils.config import Config
 
 config = Config()
 
@@ -199,9 +202,9 @@ class DAQ_Move_UI(ControlModuleUI):
         self.main_ui.layout().addWidget(self.toolbar, 0, 0, 1, 2)
         self.main_ui.layout().addWidget(self.move_toolbar, 1, 0, 1, 2)
 
-        self.abs_value_sb = SpinBox(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
+        self.abs_value_sb = QSpinBoxWithShortcut(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
         self.abs_value_sb.setStyleSheet("background-color : lightgreen; color: black")
-        self.abs_value_sb_2 = SpinBox(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
+        self.abs_value_sb_2 = QSpinBoxWithShortcut(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
         self.abs_value_sb_2.setStyleSheet("background-color : lightcoral; color: black")
         self.move_toolbar.addWidget(self.abs_value_sb)
         self.move_toolbar.addWidget(self.abs_value_sb_2)
@@ -227,7 +230,7 @@ class DAQ_Move_UI(ControlModuleUI):
         self.control_ui.layout().addWidget(LabelWithFont('Abs. Value'), 0, 0)
         self.find_home_pb = PushButtonIcon('home2', 'Find Home')
         self.control_ui.layout().addWidget(self.find_home_pb, 0, 1)
-        self.abs_value_sb_bis = SpinBox(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
+        self.abs_value_sb_bis = QSpinBoxWithShortcut(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
         self.control_ui.layout().addWidget(self.abs_value_sb_bis, 1, 0)
         self.move_abs_pb = PushButtonIcon('Move', 'Set Abs.',
                                           tip='Set the value of the actuator to the set absolute value')
@@ -236,7 +239,8 @@ class DAQ_Move_UI(ControlModuleUI):
         self.move_rel_plus_pb = PushButtonIcon('MoveUp', 'Set Rel. (+)')
         self.control_ui.layout().addWidget(self.move_rel_plus_pb, 2, 1)
 
-        self.rel_value_sb = SpinBox(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'))
+        self.rel_value_sb = QSpinBoxWithShortcut(step=0.1, dec=True, siPrefix=config('actuator', 'siprefix'),
+                                                 key_sequences=("Ctrl+E","Ctrl+Shift+E"),)
         self.control_ui.layout().addWidget(self.rel_value_sb, 3, 0)
         self.move_rel_minus_pb = PushButtonIcon('MoveDown', 'Set Rel. (-)')
         self.control_ui.layout().addWidget(self.move_rel_minus_pb, 3, 1)
@@ -256,6 +260,18 @@ class DAQ_Move_UI(ControlModuleUI):
         self.statusbar.setMaximumHeight(30)
         self.parent.layout().addWidget(self.statusbar)
 
+    def set_abs_value_red(self, value: Q_):
+        self.abs_value_sb_2.setValue(value.m_as(self._unit))
+
+    def set_abs_value_green(self, value: Q_):
+        self.abs_value_sb.setValue(value.m_as(self._unit))
+
+    def set_abs_value(self, value: Q_):
+        self.abs_value_sb_bis.setValue(value.m_as(self._unit))
+
+    def set_rel_value(self, value: Q_):
+        self.rel_value_sb.setValue(value.m_as(self._unit))
+
     def set_unit_as_suffix(self, unit: str):
         """Will append the actuator units in the value display"""
         self._unit = unit
@@ -302,11 +318,17 @@ class DAQ_Move_UI(ControlModuleUI):
         self.connect_action('show_config', lambda: self.command_sig.emit(ThreadCommand('show_config', )))
 
         self.move_abs_pb.clicked.connect(lambda: self.emit_move_abs(self.abs_value_sb_bis))
+        self.abs_value_sb.shortcut["Ctrl+E"].activated.connect(lambda: self.emit_move_abs(self.abs_value_sb))
+        self.abs_value_sb_2.shortcut["Ctrl+E"].activated.connect(lambda: self.emit_move_abs(self.abs_value_sb_2))
+        self.abs_value_sb_bis.shortcut["Ctrl+E"].activated.connect(lambda: self.emit_move_abs(self.abs_value_sb_bis))
+
 
         self.rel_value_sb.valueChanged.connect(lambda: self.command_sig.emit(
             ThreadCommand('rel_value', self.rel_value_sb.value())))
         self.move_rel_plus_pb.clicked.connect(lambda: self.emit_move_rel('+'))
         self.move_rel_minus_pb.clicked.connect(lambda: self.emit_move_rel('-'))
+        self.rel_value_sb.shortcut["Ctrl+E"].activated.connect(lambda: self.emit_move_rel('+'))
+        self.rel_value_sb.shortcut["Ctrl+Shift+E"].activated.connect(lambda: self.emit_move_rel('-'))
 
         self.find_home_pb.clicked.connect(lambda: self.command_sig.emit(ThreadCommand('find_home', )))
         self.stop_pb.clicked.connect(lambda: self.command_sig.emit(ThreadCommand('stop', )))
@@ -350,7 +372,7 @@ class DAQ_Move_UI(ControlModuleUI):
 
 
 def main(init_qt=True):
-    from pymodaq.utils.gui_utils.dock import DockArea
+    from pymodaq_gui.utils.dock import DockArea
     if init_qt:  # used for the test suite
         app = QtWidgets.QApplication(sys.argv)