MultiPyVu 2.1.2__tar.gz → 2.2.0__tar.gz

{MultiPyVu-2.1.2/src/MultiPyVu.egg-info → MultiPyVu-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MultiPyVu
-Version: 2.1.2
+Version: 2.2.0
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
@@ -38,9 +38,6 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pandas
-Requires-Dist: pywin32>=300
-Requires-Dist: pillow
 
 ![qd_logo](https://qdusa.com/images/QD_logo.png)
 # MultiPyVu
@@ -90,13 +87,13 @@ pip install update MultiPyVu
 Several examples have been uploaded to [Quantum Design's Pharos database](https://www.qdusa.com/pharos/view.php?fDocumentId=4339) as well as [GitHub](https://github.com/qdusa/MultiPyVu/tree/master/PharosExamples/).  These examples demonstrate various capabilities of the module, and serve as templates upon which users can add their own code to integrate external hardware operations with the environmental controls of the Quantum Design instrument.
 | Filename | Description|
 -----|-----
-example_Local.py | A simple script which starts the server, then the client, on the PC running MultiVu.  It relays instrument parameters and status to demonstrate communication, serving as a minimum working example useful for testing basic functionality.
-example_Remote-Server.py | For remote operation; this script must be running on the on the control PC along with the MultiVu executable.
-example_Remote-Client.py | For remote operation; this script runs on a separate PC and relays instrument parameters and status to demonstration communication.
-example_Command-Demos.py | Utilizes most functions of the module, setting temperature/field/chamber operations, reading back the values and status of those parameters, and waiting for stability conditions to be met.  As-written, it runs in local mode.
-example_MVDataFile-VISA.py | Simple example showing how to route environmental parameters and data from external instruments into a single MultiVu-readable *.dat* file.  As-written, it runs in local mode.
+example_local.py | A simple script which starts the server, then the client, on the PC running MultiVu.  It relays instrument parameters and status to demonstrate communication, serving as a minimum working example useful for testing basic functionality.
+example_remote_server.py | For remote operation; this script must be running on the on the control PC along with the MultiVu executable.
+example_remote_client.py | For remote operation; this script runs on a separate PC and relays instrument parameters and status to demonstration communication.
+example_command_demos.py | Utilizes most functions of the module, setting temperature/field/chamber operations, reading back the values and status of those parameters, and waiting for stability conditions to be met.  As-written, it runs in local mode.
+example_MVDataFile_VISA.py | Simple example showing how to route environmental parameters and data from external instruments into a single MultiVu-readable *.dat* file.  As-written, it runs in local mode.
 example_graph_dat.py | Script showing how to read a MultiVu *.dat* file into a Pandas DataFrame.
-whats_my_ip_address.cmd | This batch file script prints out the IP address for the computer, providing an easy way to get the server IP address needed for remote operation.
+whats_my_ip_address.cmd | This batch file script prints out the IP address for the computer, providing an easy way to get the server IP address needed for remote operation. Alternatively, the gui can be used to get the IP address by calling ```python -m MultiPyVu```.
 
 ### Getting Started<a class="anchor" id="getting-started"></a>
  Once the MultiPyVu module has been installed, be sure that the MultiVu executable is running on the PC connected to the cryostat before starting the server. For testing purposes, you can use MultiVu in simulation mode on an office computer.
@@ -297,8 +294,6 @@ Once configured, MultiPyVu gives access to the following commands:
 client.resistivity.get_resistance(bridge_number)
 client.resistivity.get_current(bridge_number)
 ```
-We also support reading back the temperature of the rotator thermometer. This reads off the calibration table of the resistor on the horizontal rotator that is programed onto the SROM of your BRT module. The rotator requires an extra connector that routes the thermometer to channel 1, channel 2 to be the new channel 1 and channel 3 to be the new channel 2. As such this command will only give a meaningful result with the horizontal rotator installed:
-```client.resistivity.get_temperature()```
 
 ### Saving & Opening a MultiVu Data File<a class="anchor" id="save"></a>
 The MultiPyVu.Client class can be used in conjunction with 3rd party tools in order to expand the capabilities of measurements from a Quantum Design cryostat. One can set up a VISA connection to a voltmeter, for example, and then collect information while controlling the cryostat temperature, field, and chamber status.  This data can be collected into a MultiVu data file using MultiPyVu.DataFile.  One can also use this to read a data file into a Pandas DataFrame.
@@ -388,7 +383,13 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
-**2.1.0**
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+- Log the version number when the Client connects to the Server
+- Remove unwanted warnings when quitting the Server using the esc-key.
+
+**2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:
 ```python

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/README.md

@@ -46,13 +46,13 @@ pip install update MultiPyVu
 Several examples have been uploaded to [Quantum Design's Pharos database](https://www.qdusa.com/pharos/view.php?fDocumentId=4339) as well as [GitHub](https://github.com/qdusa/MultiPyVu/tree/master/PharosExamples/).  These examples demonstrate various capabilities of the module, and serve as templates upon which users can add their own code to integrate external hardware operations with the environmental controls of the Quantum Design instrument.
 | Filename | Description|
 -----|-----
-example_Local.py | A simple script which starts the server, then the client, on the PC running MultiVu.  It relays instrument parameters and status to demonstrate communication, serving as a minimum working example useful for testing basic functionality.
-example_Remote-Server.py | For remote operation; this script must be running on the on the control PC along with the MultiVu executable.
-example_Remote-Client.py | For remote operation; this script runs on a separate PC and relays instrument parameters and status to demonstration communication.
-example_Command-Demos.py | Utilizes most functions of the module, setting temperature/field/chamber operations, reading back the values and status of those parameters, and waiting for stability conditions to be met.  As-written, it runs in local mode.
-example_MVDataFile-VISA.py | Simple example showing how to route environmental parameters and data from external instruments into a single MultiVu-readable *.dat* file.  As-written, it runs in local mode.
+example_local.py | A simple script which starts the server, then the client, on the PC running MultiVu.  It relays instrument parameters and status to demonstrate communication, serving as a minimum working example useful for testing basic functionality.
+example_remote_server.py | For remote operation; this script must be running on the on the control PC along with the MultiVu executable.
+example_remote_client.py | For remote operation; this script runs on a separate PC and relays instrument parameters and status to demonstration communication.
+example_command_demos.py | Utilizes most functions of the module, setting temperature/field/chamber operations, reading back the values and status of those parameters, and waiting for stability conditions to be met.  As-written, it runs in local mode.
+example_MVDataFile_VISA.py | Simple example showing how to route environmental parameters and data from external instruments into a single MultiVu-readable *.dat* file.  As-written, it runs in local mode.
 example_graph_dat.py | Script showing how to read a MultiVu *.dat* file into a Pandas DataFrame.
-whats_my_ip_address.cmd | This batch file script prints out the IP address for the computer, providing an easy way to get the server IP address needed for remote operation.
+whats_my_ip_address.cmd | This batch file script prints out the IP address for the computer, providing an easy way to get the server IP address needed for remote operation. Alternatively, the gui can be used to get the IP address by calling ```python -m MultiPyVu```.
 
 ### Getting Started<a class="anchor" id="getting-started"></a>
  Once the MultiPyVu module has been installed, be sure that the MultiVu executable is running on the PC connected to the cryostat before starting the server. For testing purposes, you can use MultiVu in simulation mode on an office computer.
@@ -253,8 +253,6 @@ Once configured, MultiPyVu gives access to the following commands:
 client.resistivity.get_resistance(bridge_number)
 client.resistivity.get_current(bridge_number)
 ```
-We also support reading back the temperature of the rotator thermometer. This reads off the calibration table of the resistor on the horizontal rotator that is programed onto the SROM of your BRT module. The rotator requires an extra connector that routes the thermometer to channel 1, channel 2 to be the new channel 1 and channel 3 to be the new channel 2. As such this command will only give a meaningful result with the horizontal rotator installed:
-```client.resistivity.get_temperature()```
 
 ### Saving & Opening a MultiVu Data File<a class="anchor" id="save"></a>
 The MultiPyVu.Client class can be used in conjunction with 3rd party tools in order to expand the capabilities of measurements from a Quantum Design cryostat. One can set up a VISA connection to a voltmeter, for example, and then collect information while controlling the cryostat temperature, field, and chamber status.  This data can be collected into a MultiVu data file using MultiPyVu.DataFile.  One can also use this to read a data file into a Pandas DataFrame.
@@ -344,7 +342,13 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
-**2.1.0**
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+- Log the version number when the Client connects to the Server
+- Remove unwanted warnings when quitting the Server using the esc-key.
+
+**2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:
 ```python

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/setup.py

@@ -53,9 +53,6 @@ setup(
     python_requires=">=3.8",
     dependencies=[
         "typing",
-        "pywin32>=300",
-    ],
-    install_requires=[
         "pandas",
         "pywin32>=300",
         "pillow",

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/CommandChamber.py

@@ -48,7 +48,7 @@ class CommandChamberBase(ICommand):
         self.instrument_name = instrument_name
 
         # State code dictionary
-        self.__state_dictionary = {
+        self._state_dictionary = {
             0: 'Unknown',
             1: 'Purged and Sealed',
             2: 'Vented and Sealed',
@@ -71,22 +71,22 @@ class CommandChamberBase(ICommand):
                              mode_setting: IntEnum,
                              mode_readback):
         if mode_setting == self.mode.seal:
-            returnTrue = [self.__state_dictionary[1],
-                          self.__state_dictionary[2],
-                          self.__state_dictionary[3],
+            returnTrue = [self._state_dictionary[1],
+                          self._state_dictionary[2],
+                          self._state_dictionary[3],
                           ]
             if mode_readback in returnTrue:
                 return True
         elif mode_setting == self.mode.purge_seal:
-            return (mode_readback == self.__state_dictionary[1])
+            return (mode_readback == self._state_dictionary[1])
         elif mode_setting == self.mode.vent_seal:
-            return (mode_readback == self.__state_dictionary[2])
+            return (mode_readback == self._state_dictionary[2])
         elif mode_setting == self.mode.pump_continuous:
-            return (mode_readback == self.__state_dictionary[8])
+            return (mode_readback == self._state_dictionary[8])
         elif mode_setting == self.mode.vent_continuous:
-            return (mode_readback == self.__state_dictionary[9])
+            return (mode_readback == self._state_dictionary[9])
         elif mode_setting == self.mode.high_vacuum:
-            return (mode_readback == self.__state_dictionary[7])
+            return (mode_readback == self._state_dictionary[7])
 
     def convert_result(self, response: Dict) -> Tuple:
         '''
@@ -121,7 +121,10 @@ class CommandChamberBase(ICommand):
         return f'{mode_as_int}'
 
     def convert_state_dictionary(self, status_number):
-        return self.__state_dictionary[status_number]
+        if isinstance(status_number, str):
+            return status_number
+        else:
+            return self._state_dictionary[status_number]
 
     @abstractmethod
     def get_state_server(self, value_variant, state_variant,  params=''):
@@ -148,7 +151,7 @@ class CommandChamberBase(ICommand):
         return self.set_state_server_imp(set_mode)
 
     def state_code_dict(self):
-        return self.__state_dictionary
+        return self._state_dictionary
 
 
 ############################
@@ -181,10 +184,16 @@ class CommandChamberImp(CommandChamberBase):
         return '', return_state
 
     def set_state_server_imp(self, mode: int) -> Union[str, int]:
-        error = self._mvu.SetChamber(mode)
-        if error > 0:
+        can_error = self._mvu.SetChamber(mode)
+        if self.instrument_name == 'PPMS':
+            if can_error > 1:
+                raise MultiPyVuError('Error when calling SetChamber()')
+            else:
+                # returning this string makes CommandMultiVu_base happy
+                return 'Call was successful'
+        elif can_error > 0:
             raise MultiPyVuError('Error when calling SetChamber()')
-        return error
+        return can_error
 
 
 ############################

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/CommandField.py

@@ -58,7 +58,7 @@ class CommandFieldBase(ICommand):
         self.instrument_name = instrument_name
 
         # Field state code dictionary
-        self.__state_dictionary = {
+        self._state_dictionary = {
             1: 'Stable',
             2: 'Switch Warming',
             3: 'Switch Cooling',
@@ -131,7 +131,10 @@ class CommandFieldBase(ICommand):
         return f'{set_point},{rate_per_sec},{approach.value},{mode}'
 
     def convert_state_dictionary(self, status_number):
-        return self.__state_dictionary[status_number]
+        if isinstance(status_number, str):
+            return status_number
+        else:
+            return self._state_dictionary[status_number]
 
     @abstractmethod
     def get_state_server(self, value_variant, state_variant, params=''):
@@ -193,7 +196,7 @@ class CommandFieldBase(ICommand):
         return error
 
     def state_code_dict(self):
-        return self.__state_dictionary
+        return self._state_dictionary
 
 
 ############################
@@ -240,14 +243,20 @@ class CommandFieldImp(CommandFieldBase):
                              set_driven: int
                              ) -> Union[str, int]:
         try:
-            error = self._mvu.setField(field,
+            can_error = self._mvu.setField(field,
                                        set_rate_per_sec,
                                        set_approach,
                                        set_driven
                                        )
-            if error > 0:
+            if self.instrument_name == 'PPMS':
+                if can_error > 1:
+                   raise MultiPyVuError('Error when calling SetField()')
+                else:
+                     # returning this string makes CommandMultiVu_base happy
+                    return 'Call was successful'
+            elif can_error > 0:
                 raise MultiPyVuError('Error when calling SetField()')
-            return error
+            return can_error
         except AttributeError:
             # this will raise a pywin_com_error if it is bad
             return str(self._mvu)

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/CommandMultiVu_base.py

@@ -67,7 +67,7 @@ class CommandMultiVuBase():
         result_string = result if type(result) == str else f'{result:.4f}'
         return f'{result_string},{mv_command.units},{code_in_words}'
 
-    def set_state(self, command, arg_string) -> str:
+    def set_state(self, command, arg_string):
         '''
         Sets the state for a given command using the arg_string for parameters
 
@@ -82,10 +82,6 @@ class CommandMultiVuBase():
                 FIELD: set point, rate, approach, and magnetic state.
                 CHAMBER: mode
 
-        Returns:
-        --------
-        str:  Error message
-
         Raises
         ------
         MultiVuExeException
@@ -105,7 +101,7 @@ class CommandMultiVuBase():
                     msg = f'Error when setting the {command} {arg_string}: '
                     msg += f'error = {err}'
                     raise MultiPyVuError(msg)
-                
+
             if isinstance(err, str):
                 can_error_msg = mv_command.convert_state_dictionary(err)
                 if can_error_msg == 'Call was successful':

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/CommandTemperature.py

@@ -44,7 +44,7 @@ class CommandTemperatureBase(ICommand):
         super().__init__()
 
         # Temperature state code dictionary
-        self.__state_dictionary = {
+        self._state_dictionary = {
             1: "Stable",
             2: "Tracking",
             5: "Near",
@@ -108,10 +108,13 @@ class CommandTemperatureBase(ICommand):
         return f'{set_point},{rate_per_minute},{approach_mode.value}'
 
     def convert_state_dictionary(self, status_number):
-        return self.__state_dictionary[status_number]
+        if isinstance(status_number, str):
+            return status_number
+        else:
+            return self._state_dictionary[status_number]
 
     def state_code_dict(self):
-        return self.__state_dictionary
+        return self._state_dictionary
 
     @abstractmethod
     def get_state_server(self, arg_string: str) -> Union[str, int]:
@@ -160,18 +163,20 @@ class CommandTemperatureBase(ICommand):
 ############################
 
 class CommandTemperatureImp(CommandTemperatureBase):
-    def __init__(self, multivu_win32com):
+    def __init__(self, multivu_win32com, instrument_name):
         '''
         Parameters:
         ----------
         multivu_win32com: Union[win32.dynamic.CDispatch, None]
+        mvu_flavor: str
         '''
         super().__init__()
         self._mvu = multivu_win32com
+        self.instrument_name = instrument_name
 
     def get_state_server(self, value_variant, state_variant, params=''):
-        error = self._mvu.GetTemperature(value_variant, state_variant)
-        if error > 0:
+        can_error = self._mvu.GetTemperature(value_variant, state_variant)
+        if can_error > 0:
             raise MultiPyVuError('Error when calling GetTemperature()')
         temperature = value_variant.value
         return_state = int(state_variant.value)
@@ -184,15 +189,21 @@ class CommandTemperatureImp(CommandTemperatureBase):
                        set_approach: int
                        ) -> Union[str, int]:
         try:
-            error = self._mvu.SetTemperature(temperature,
+            can_error = self._mvu.SetTemperature(temperature,
                                              set_rate_per_min,
                                              set_approach)
         except pywin_com_error:
             raise MultiPyVuError('No pywin32 connection to MultiVu.  Is MultiVu running?')
         else:
-            if error > 0:
+            if self.instrument_name == 'PPMS':
+                if can_error > 1:
+                    raise MultiPyVuError('Error when calling SetTemperature()')
+                else:
+                    # returning this string makes CommandMultiVu_base happy
+                    return 'Call was successful'
+            elif can_error > 0:
                 raise MultiPyVuError('Error when calling SetTemperature()')
-        return error
+        return can_error
 
 
 ############################

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/Command_factory.py

@@ -30,7 +30,7 @@ def create_command_mv(mvu_flavor, win32_dispatch=None):
     A CommandMultiVu object.  If win32_dispatch is None, it returns
     a simulated object.
     '''
-    cmd_dict = {'TEMP': create_command_temp(win32_dispatch),
+    cmd_dict = {'TEMP': create_command_temp(win32_dispatch, mvu_flavor),
                 'FIELD': create_command_field(win32_dispatch, mvu_flavor),
                 'CHAMBER': create_command_chamber(win32_dispatch, mvu_flavor),
                 'SDO': create_command_sdo(win32_dispatch),
@@ -42,7 +42,8 @@ def create_command_mv(mvu_flavor, win32_dispatch=None):
 
 
 def create_command_temp(
-        win32_dispatch=None
+        win32_dispatch=None,
+        mvu_flavor=''
         ) -> Union[temperature.CommandTemperatureSim,
                    temperature.CommandTemperatureImp]:
     '''
@@ -61,7 +62,7 @@ def create_command_temp(
     if win32_dispatch is None:
         return temperature.CommandTemperatureSim()
     else:
-        return temperature.CommandTemperatureImp(win32_dispatch)
+        return temperature.CommandTemperatureImp(win32_dispatch, mvu_flavor)
 
 
 def create_command_field(

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/MultiVuClient_base.py

@@ -31,6 +31,7 @@ from .exceptions import (MultiPyVuError,
                          ServerCloseError,
                          SocketError
                          )
+from .__version import __version__ as mpv_version
 
 if sys.platform == 'win32':
     import msvcrt    # Used to help detect the esc-key
@@ -88,6 +89,7 @@ class ClientBase():
         self.logger.info(response['result'])
         self._instr = self._message.instr
         self.instrument_name = self._message.instr.name
+        self.logger.debug(f'MultiPyVu Version: {mpv_version}')
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback) -> bool:

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/MultiVuServer.py

@@ -45,6 +45,14 @@ def catch_thread_error(func):
     def error_handler(*args, **kwargs):
         try:
             func(*args, **kwargs)
+        # ignore the errors handled in _exit()
+        except (
+            KeyboardInterrupt,
+            MultiPyVuError,
+            UserWarning,
+            ClientCloseError
+                ) as e:
+            raise e
         except BaseException:
             name = threading.current_thread().name
             msg = f'Exception in thread \'{name}\' '
@@ -188,8 +196,8 @@ class Server(Subject):
     def __enter__(self):
         try:
             sel = self.config_sock()
-        except OSError as e:
-            # invalide connection, so return None
+        except OSError:
+            # invalid connection, so return None
             return None
         quit_keys = "ctrl-c"
         if sys.platform == 'win32':

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/__version.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = "2.1.2"
+__version__ = "2.2.0"

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu/instrument.py

@@ -14,6 +14,7 @@ import time
 import re
 import logging
 from enum import Enum, auto
+from typing import Tuple
 
 from .Command_factory import create_command_mv
 from .project_vars import SERVER_NAME, PYWIN32_VERSION, MIN_PYWIN32_VERSION
@@ -108,14 +109,14 @@ class Instrument():
         self.multi_vu = None
         self._connect_to_MultiVu(self.name)
 
-    def _get_exe(self, inst: str) -> str:
+    def _exe_to_common_name(self, exe_name: str) -> str:
         '''
-        Returns the name of the MultiVu exe.
+        Returns the common name of the MultiVu flavor.
 
         Parameters
         ----------
-        inst : str
-            The name of the MultiVu flavor.
+        exe_name : str
+            The name of the MultiVu flavor executable.
 
         Returns
         -------
@@ -123,17 +124,18 @@ class Instrument():
             A string of the specific MultiVu flavor .exe
 
         '''
-        if inst.upper() == InstrumentList.PPMS.name:
-            name = inst.capitalize() + 'Mvu'
-        elif inst.upper() == InstrumentList.MPMS3.name:
-            name = 'SquidVsm'
-        elif inst.upper() == InstrumentList.VERSALAB.name:
-            name = 'VersaLab'
-        elif inst.upper() == InstrumentList.OPTICOOL.name:
-            name = 'OptiCool'
+        if exe_name.capitalize() == 'PpmsMvu.exe'.capitalize():
+            name = InstrumentList.PPMS.name
+        elif exe_name.capitalize() == 'SquidVsm.exe'.capitalize():
+            name = InstrumentList.MPMS3.name
+        elif exe_name.capitalize() == 'VersaLab.exe'.capitalize():
+            name = InstrumentList.VERSALAB.name
+        elif exe_name.capitalize() == 'OptiCool.exe'.capitalize():
+            name = InstrumentList.OPTICOOL.name
+        elif exe_name.capitalize() == 'DynaCool.exe'.capitalize():
+            name = InstrumentList.DYNACOOL.name
         else:
-            name = inst.capitalize()
-        name += '.exe'
+            raise ValueError(f'{exe_name} is not a recognized executable name')
         return name
 
     def _get_class_id(self, inst: str) -> str:
@@ -179,29 +181,28 @@ class Instrument():
                 err_msg += 'the MultiVu flavor.'
                 raise MultiPyVuError(err_msg)
 
-            detected_name = self.detect_multivu()
-            if detected_name != instrument_name:
+            self.name, self.exe_name = self.detect_multivu()
+            if self.name != instrument_name:
                 if instrument_name == '':
-                    msg = f'Found {detected_name} running.'
+                    msg = f'Found {self.name} running.'
                     self.logger.info(msg)
                     msg = f'MultiPyVu Version: {mpv_version}'
                     self.logger.debug(msg)
                 else:
                     msg = f'User specified {instrument_name}, but detected '
-                    msg += f'{detected_name} running. Either leave out a '
+                    msg += f'{self.name} running. Either leave out a '
                     msg += 'specific MultiVu flavor and use the detected '
                     msg += 'one, or have the specified flavor match the '
                     msg += 'running instance.'
                     raise ValueError(msg)
-            self.name = detected_name
-            self.exe_name = self._get_exe(self.name)
             self.class_id = self._get_class_id(self.name)
             self.initialize_multivu_win32com()
 
-    def detect_multivu(self) -> str:
+    def detect_multivu(self) -> Tuple[str, str]:
         '''
         This looks in the file system for a running version of
-        MultiVu.  Once it is found, the function returns the name.
+        MultiVu.  Once it is found, the function returns the a
+        tuple with the common name and the executable name.
 
         Raises
         ------
@@ -211,8 +212,8 @@ class Instrument():
 
         Returns
         -------
-        string
-            Returns the common name of the QD instrument.
+        tuple[str]
+            Returns the (common name, executable name) of the QD instrument.
 
         '''
         # Build a list of enum, instrumentType
@@ -220,6 +221,10 @@ class Instrument():
         # Remove the last item (called na)
         instrument_names.pop()
 
+        # declare these variables so that they are available to return
+        common_name = ''
+        exe_name = ''
+
         # Use WMIC to get the list of running programs with 'multivu'
         # in their path
         cmd = 'WMIC PROCESS WHERE "COMMANDLINE like \'%multivu%\'" GET '
@@ -235,15 +240,9 @@ class Instrument():
             exe_found = re.findall(exe_search, i)
             if len(exe_found) > 0:
                 name, location, process_id = exe_found[0]
-                open_mv_dict[name] = (location, process_id)
-
-        # Attempt to match the expected MV executable names with
-        # the programs in the list and instantiate the instrument
-        # and add to MultiVu_list.
-        # MultiVu_list = []
-        # for instr in instrument_names:
-        #     if instr.name in proc.stdout.upper():
-        #         MultiVu_list.append(instr.name)
+                exe_name = name + '.exe'
+                common_name = self._exe_to_common_name(exe_name)
+                open_mv_dict[common_name] = (location, process_id)
 
         # Declare errors if to few or too many are found; for one found,
         # declare which version is identified
@@ -268,8 +267,7 @@ class Instrument():
                 self.logger.info(msg)
             else:
                 self.logger.debug(msg)
-        self.name = name.upper()
-        return self.name
+        return common_name, exe_name
 
     def initialize_multivu_win32com(self):
         '''

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0/src/MultiPyVu.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MultiPyVu
-Version: 2.1.2
+Version: 2.2.0
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
@@ -38,9 +38,6 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pandas
-Requires-Dist: pywin32>=300
-Requires-Dist: pillow
 
 ![qd_logo](https://qdusa.com/images/QD_logo.png)
 # MultiPyVu
@@ -90,13 +87,13 @@ pip install update MultiPyVu
 Several examples have been uploaded to [Quantum Design's Pharos database](https://www.qdusa.com/pharos/view.php?fDocumentId=4339) as well as [GitHub](https://github.com/qdusa/MultiPyVu/tree/master/PharosExamples/).  These examples demonstrate various capabilities of the module, and serve as templates upon which users can add their own code to integrate external hardware operations with the environmental controls of the Quantum Design instrument.
 | Filename | Description|
 -----|-----
-example_Local.py | A simple script which starts the server, then the client, on the PC running MultiVu.  It relays instrument parameters and status to demonstrate communication, serving as a minimum working example useful for testing basic functionality.
-example_Remote-Server.py | For remote operation; this script must be running on the on the control PC along with the MultiVu executable.
-example_Remote-Client.py | For remote operation; this script runs on a separate PC and relays instrument parameters and status to demonstration communication.
-example_Command-Demos.py | Utilizes most functions of the module, setting temperature/field/chamber operations, reading back the values and status of those parameters, and waiting for stability conditions to be met.  As-written, it runs in local mode.
-example_MVDataFile-VISA.py | Simple example showing how to route environmental parameters and data from external instruments into a single MultiVu-readable *.dat* file.  As-written, it runs in local mode.
+example_local.py | A simple script which starts the server, then the client, on the PC running MultiVu.  It relays instrument parameters and status to demonstrate communication, serving as a minimum working example useful for testing basic functionality.
+example_remote_server.py | For remote operation; this script must be running on the on the control PC along with the MultiVu executable.
+example_remote_client.py | For remote operation; this script runs on a separate PC and relays instrument parameters and status to demonstration communication.
+example_command_demos.py | Utilizes most functions of the module, setting temperature/field/chamber operations, reading back the values and status of those parameters, and waiting for stability conditions to be met.  As-written, it runs in local mode.
+example_MVDataFile_VISA.py | Simple example showing how to route environmental parameters and data from external instruments into a single MultiVu-readable *.dat* file.  As-written, it runs in local mode.
 example_graph_dat.py | Script showing how to read a MultiVu *.dat* file into a Pandas DataFrame.
-whats_my_ip_address.cmd | This batch file script prints out the IP address for the computer, providing an easy way to get the server IP address needed for remote operation.
+whats_my_ip_address.cmd | This batch file script prints out the IP address for the computer, providing an easy way to get the server IP address needed for remote operation. Alternatively, the gui can be used to get the IP address by calling ```python -m MultiPyVu```.
 
 ### Getting Started<a class="anchor" id="getting-started"></a>
  Once the MultiPyVu module has been installed, be sure that the MultiVu executable is running on the PC connected to the cryostat before starting the server. For testing purposes, you can use MultiVu in simulation mode on an office computer.
@@ -297,8 +294,6 @@ Once configured, MultiPyVu gives access to the following commands:
 client.resistivity.get_resistance(bridge_number)
 client.resistivity.get_current(bridge_number)
 ```
-We also support reading back the temperature of the rotator thermometer. This reads off the calibration table of the resistor on the horizontal rotator that is programed onto the SROM of your BRT module. The rotator requires an extra connector that routes the thermometer to channel 1, channel 2 to be the new channel 1 and channel 3 to be the new channel 2. As such this command will only give a meaningful result with the horizontal rotator installed:
-```client.resistivity.get_temperature()```
 
 ### Saving & Opening a MultiVu Data File<a class="anchor" id="save"></a>
 The MultiPyVu.Client class can be used in conjunction with 3rd party tools in order to expand the capabilities of measurements from a Quantum Design cryostat. One can set up a VISA connection to a voltmeter, for example, and then collect information while controlling the cryostat temperature, field, and chamber status.  This data can be collected into a MultiVu data file using MultiPyVu.DataFile.  One can also use this to read a data file into a Pandas DataFrame.
@@ -388,7 +383,13 @@ client = mpv.Client(port=6000)
 - A log file named QdMultiVu.log shows the traffic between the server and client which can also be useful during troubleshooting.
 
 ## Changelog<a class="anchor" id="changelog"></a>
-**2.1.0**
+**2.2.0**
+- January 2024
+- Corrected a bug that prevented the Server from recognizing PPMS and MPMS3 MultiVu flavors
+- Log the version number when the Client connects to the Server
+- Remove unwanted warnings when quitting the Server using the esc-key.
+
+**2.1.4**
 - October 2023
 - Import full module as MultiPyVu. Instead of loading the three sub-modules as:
 ```python

{MultiPyVu-2.1.2 → MultiPyVu-2.2.0}/src/MultiPyVu.egg-info/SOURCES.txt

@@ -37,7 +37,6 @@ src/MultiPyVu/sdo_object.py
 src/MultiPyVu.egg-info/PKG-INFO
 src/MultiPyVu.egg-info/SOURCES.txt
 src/MultiPyVu.egg-info/dependency_links.txt
-src/MultiPyVu.egg-info/requires.txt
 src/MultiPyVu.egg-info/top_level.txt
 src/MultiPyVu/MultiVuDataFile/MultiVuDataFile.py
 src/MultiPyVu/MultiVuDataFile/__init__.py

MultiPyVu-2.1.2/src/MultiPyVu.egg-info/requires.txt

@@ -1,3 +0,0 @@
-pandas
-pywin32>=300
-pillow