MultiPyVu 3.5.4__tar.gz → 3.6.1__tar.gz

{multipyvu-3.5.4/src/MultiPyVu.egg-info → multipyvu-3.6.1}/PKG-INFO

@@ -1,41 +1,20 @@
 Metadata-Version: 2.4
 Name: MultiPyVu
-Version: 3.5.4
+Version: 3.6.1
 Summary: Control MultiVu using Python
 Author-email: Damon D Jackson <djackson@qdusa.com>
 Maintainer-email: "Quantum Design, Inc." <apps@qdusa.com>
-License: MIT License (MIT)
-        
-        Copyright (c) 2023 Quantum Design, Inc
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
+License-Expression: MIT
 Project-URL: Quantum Design, https://qdusa.com
 Project-URL: Pharos, https://www.qdusa.com/register/account/login
 Keywords: Quantum Design,QD,MultiVu,PPMS,DynaCool,MPMS3,VersaLab,OptiCool
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Scientific/Engineering :: Chemistry
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pandas
@@ -82,13 +61,13 @@ The components of MultiPyVu enable access to the set and read the temperature, f
 
 ### Module Requirements<a class="anchor" id="requirements"></a>
 MultiPyVu uses the following modules:
-- python version 3.10 or higher
+- python version 3.7 or higher
 - pywin32 - version 300 or higher.
 - pandas - data read back from a *.dat* file is a Pandas Dataframe
 - pillow - supports server gui
 - pyyaml - supports logging
 
-For the Python 3 distribution Quantum Design recommends [Anaconda](https://www.anaconda.com/products/individual) as it includes most modules needed for this server and other packages useful for scientific computing.  This code was built and tested using Python 3.8.  If you are not sure which version of Python you are using, from a command prompt type:
+For the Python 3 distribution Quantum Design recommends [Anaconda](https://www.anaconda.com/products/individual) as it includes most modules needed for this server and other packages useful for scientific computing.  To find which version of Python is used, from a command prompt type:
 ```
 python --version
 ```
@@ -109,7 +88,8 @@ Remote Connection\example_MVDataFile_VISA.py | Simple example showing how to rou
 Data Processing\example_save_open_dat.py | Script showing how to save and read a MultiVu *.dat* file into a Pandas DataFrame, then plot with matplotlib.
 Measuring\example_stabilize.py | Measures the temperature while stabilizing at each temperature.
 Measuring\example_sweep.py | Measures the temperature while sweeping the temperature.
-Options\example_aux_therm.py | Gets the temperature of the auxilary thermometer from the OptiCool.
+Measuring\example_get_setpoints.py | Shows how to get the temperature and magnetic field setpoints.
+Options\example_aux_therm.py | Gets the temperature of the auxiliary thermometer from the OptiCool.
 Options\example_resistivity_option.py | Demonstrates how to set up the BRT module bridges for resistivity measurements and how to save the data.
 Options\example_horizontal_rotator.py | Demonstrates how to move the horizontal rotator to a new position.
 UsefulBatchFiles\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```.
@@ -191,7 +171,7 @@ client.open()
 client.close_client()
 # do post-processing once the client has been closed
 ```
-Using the above method could end up with the server hung up because errors need to be correctly accounted for.  It is safer to use the Client as a context manager using a with-block.
+Using the above method could end up with the server hung up because errors need to be correctly accounted for.  It is safer to use the Client as a context manager using a with-block.  In addition, a client object can only connect to the server once.  For a second connection, one must instantiate a new client instance.
 
 The client can also close the server directly using:
 ```python
@@ -239,6 +219,10 @@ The <enum_options> mode is set using the client.temperature.approach_mode enum,
 ```python
 temperature, status = client.get_temperature()
 ```
+One can also retrieve the setpoint, rate, and approach mode:
+```python
+temperature, rate, approach = client.get_temperature_setpoints()
+```
 
 **Field**<a class="anchor" id="field"></a>
 ```python
@@ -260,6 +244,10 @@ The field and status are read back using:
 ```python
 field, status = client.get_field()
 ```
+One can also retrieve the setpoint, rate, and approach mode:
+```python
+field, rate, approach, driven = client.get_field_setpoints()
+```
 
 **Chamber**<a class="anchor" id="chamber"></a>
 ```python
@@ -449,6 +437,12 @@ 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>
+**3.6.1**
+- August 2025
+- Add commands to get the temperature and field setpoints.
+- Remove dependencies on the distutils module.
+- Minimum python version 3.7
+
 **3.5.4**
 - June 2025
 - Add the horizontal rotator option for DynaCool, VersaLab, and PPMS.

{multipyvu-3.5.4 → multipyvu-3.6.1}/README.md

@@ -33,13 +33,13 @@ The components of MultiPyVu enable access to the set and read the temperature, f
 
 ### Module Requirements<a class="anchor" id="requirements"></a>
 MultiPyVu uses the following modules:
-- python version 3.10 or higher
+- python version 3.7 or higher
 - pywin32 - version 300 or higher.
 - pandas - data read back from a *.dat* file is a Pandas Dataframe
 - pillow - supports server gui
 - pyyaml - supports logging
 
-For the Python 3 distribution Quantum Design recommends [Anaconda](https://www.anaconda.com/products/individual) as it includes most modules needed for this server and other packages useful for scientific computing.  This code was built and tested using Python 3.8.  If you are not sure which version of Python you are using, from a command prompt type:
+For the Python 3 distribution Quantum Design recommends [Anaconda](https://www.anaconda.com/products/individual) as it includes most modules needed for this server and other packages useful for scientific computing.  To find which version of Python is used, from a command prompt type:
 ```
 python --version
 ```
@@ -60,7 +60,8 @@ Remote Connection\example_MVDataFile_VISA.py | Simple example showing how to rou
 Data Processing\example_save_open_dat.py | Script showing how to save and read a MultiVu *.dat* file into a Pandas DataFrame, then plot with matplotlib.
 Measuring\example_stabilize.py | Measures the temperature while stabilizing at each temperature.
 Measuring\example_sweep.py | Measures the temperature while sweeping the temperature.
-Options\example_aux_therm.py | Gets the temperature of the auxilary thermometer from the OptiCool.
+Measuring\example_get_setpoints.py | Shows how to get the temperature and magnetic field setpoints.
+Options\example_aux_therm.py | Gets the temperature of the auxiliary thermometer from the OptiCool.
 Options\example_resistivity_option.py | Demonstrates how to set up the BRT module bridges for resistivity measurements and how to save the data.
 Options\example_horizontal_rotator.py | Demonstrates how to move the horizontal rotator to a new position.
 UsefulBatchFiles\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```.
@@ -142,7 +143,7 @@ client.open()
 client.close_client()
 # do post-processing once the client has been closed
 ```
-Using the above method could end up with the server hung up because errors need to be correctly accounted for.  It is safer to use the Client as a context manager using a with-block.
+Using the above method could end up with the server hung up because errors need to be correctly accounted for.  It is safer to use the Client as a context manager using a with-block.  In addition, a client object can only connect to the server once.  For a second connection, one must instantiate a new client instance.
 
 The client can also close the server directly using:
 ```python
@@ -190,6 +191,10 @@ The <enum_options> mode is set using the client.temperature.approach_mode enum,
 ```python
 temperature, status = client.get_temperature()
 ```
+One can also retrieve the setpoint, rate, and approach mode:
+```python
+temperature, rate, approach = client.get_temperature_setpoints()
+```
 
 **Field**<a class="anchor" id="field"></a>
 ```python
@@ -211,6 +216,10 @@ The field and status are read back using:
 ```python
 field, status = client.get_field()
 ```
+One can also retrieve the setpoint, rate, and approach mode:
+```python
+field, rate, approach, driven = client.get_field_setpoints()
+```
 
 **Chamber**<a class="anchor" id="chamber"></a>
 ```python
@@ -400,6 +409,12 @@ 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>
+**3.6.1**
+- August 2025
+- Add commands to get the temperature and field setpoints.
+- Remove dependencies on the distutils module.
+- Minimum python version 3.7
+
 **3.5.4**
 - June 2025
 - Add the horizontal rotator option for DynaCool, VersaLab, and PPMS.

{multipyvu-3.5.4 → multipyvu-3.6.1}/pyproject.toml

@@ -15,10 +15,9 @@ maintainers = [
     { name = "Quantum Design, Inc.", email = "apps@qdusa.com" },
     ]
 readme = "README.md"
-license = {file = "LICENSE"}
+license = "MIT"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Intended Audience :: Science/Research",
     "Topic :: Scientific/Engineering :: Physics",

{multipyvu-3.5.4 → multipyvu-3.6.1}/setup.py

@@ -51,11 +51,11 @@ setup(
             "logging_config.yaml"
             ]
         },
-    python_requires=">=3.9",
+    python_requires=">=3.7",
     install_requires=[
         "pandas",
         "pywin32>=300; platform_system=='Windows'",
         "pillow",
-        "pyyaml",
+        "pyyaml"
     ],
 )

{multipyvu-3.5.4 → multipyvu-3.6.1}/src/MultiPyVu/CommandChamber.py

@@ -90,7 +90,7 @@ class CommandChamberBase(ICommand):
 
     def convert_result(self, response: Dict[str, str]) -> Tuple:
         """
-        Converts the CommandMultiVu response from get_state()
+        Converts the CommandMultiVu response from get_state_server()
         to something usable for the user.
 
         Parameters:
@@ -131,7 +131,7 @@ class CommandChamberBase(ICommand):
         raise NotImplementedError
 
     @abstractmethod
-    def _set_state_imp(self, mode: int) -> Union[str, int]:
+    def _set_state_imp(self, mode: modeEnum) -> Union[str, int]:
         raise NotImplementedError
 
     def set_state_server(self, arg_string) -> Union[str, int]:
@@ -148,8 +148,8 @@ class CommandChamberBase(ICommand):
             for m in modeEnum:
                 err_msg += f'\n\t{m.value}: {m.name}'
             raise MultiPyVuError(err_msg)
-        self.state = set_mode
-        return self._set_state_imp(set_mode)
+        self.state = modeEnum(set_mode)
+        return self._set_state_imp(self.state)
 
     def state_code_dict(self):
         return STATE_DICT
@@ -195,7 +195,7 @@ class CommandChamberImp(ICommandImp, CommandChamberBase):
         if self.instrument_name == 'OPTICOOL':
             err_msg = 'get_chamber() is not available for the OptiCool'
             raise MultiPyVuError(err_msg)
-        error = self._mvu.GetChamber(state_variant)
+        can_error = self._mvu.GetChamber(state_variant)
         # On 6/10/25, I found that the PPMS was returning something greater
         # than 1 with the GetTemperature() command.  After talking with Mark,
         # I have decided to only check for a value greater than 1 for all
@@ -206,7 +206,7 @@ class CommandChamberImp(ICommandImp, CommandChamberBase):
 
         return 0.0, self.state
 
-    def _set_state_imp(self, mode: int) -> Union[str, int]:
+    def _set_state_imp(self, mode: modeEnum) -> Union[str, int]:
         can_error = self._mvu.SetChamber(mode)
         self.set_point = mode
 
@@ -216,7 +216,7 @@ class CommandChamberImp(ICommandImp, CommandChamberBase):
             else:
                 # returning this string makes CommandMultiVu_base happy
                 return 'Call was successful'
-        elif can_error > 0:
+        elif can_error > 1:
             raise MultiPyVuError('Error when calling SetChamber()')
         return can_error
 
@@ -401,8 +401,8 @@ class CommandChamberSim(CommandChamberBase,
             raise MultiPyVuError(err_msg)
         return 0.0, self.state
 
-    def _set_state_imp(self, mode: int) -> Union[str, int]:
-        self.change_thread = self.get_sim_instance()
+    def _set_state_imp(self, mode: modeEnum) -> Union[str, int]:
+        self.change_thread: SimulateChamberChange = self.get_sim_instance()
         state_string = STATE_DICT[self.state]
         self.change_thread.set_params('',
                                       mode,

{multipyvu-3.5.4 → multipyvu-3.6.1}/src/MultiPyVu/CommandField.py

@@ -15,7 +15,7 @@ from typing import Dict, List, Tuple, Union
 from .check_windows_esc import _check_windows_esc
 from .exceptions import MultiPyVuError
 from .ICommand import (ICommand, ICommandImp, ICommandObserverSim,
-                       ISimulateChange, catch_thread_error)
+                       ISimulateChange, catch_thread_error, floats_equal)
 from .IEventManager import IObserver
 from .project_vars import CLOCK_TIME
 
@@ -72,12 +72,14 @@ class CommandFieldBase(ICommand):
     _current_val: float = 0.0
     _rate: float = 1
     _state: int = 1
-    _approach: Union[ApproachEnum, int] = ApproachEnum.no_overshoot
-    _driven = drivenEnum.driven
+    _approach: ApproachEnum = ApproachEnum.no_overshoot
+    _driven: drivenEnum = drivenEnum.driven
 
     def __init__(self, instrument_name: str):
         super().__init__()
         self.instrument_name = instrument_name
+        self.approach_mode = ApproachEnum
+        self.drive_mode = drivenEnum
 
         self.units = units
 
@@ -114,24 +116,24 @@ class CommandFieldBase(ICommand):
         CommandFieldBase._state = new
 
     @property
-    def approach_mode(self):
+    def approach(self) -> ApproachEnum:
         return CommandFieldBase._approach
 
-    @approach_mode.setter
-    def approach_mode(self, new):
+    @approach.setter
+    def approach(self, new):
         CommandFieldBase._approach = new
 
     @property
-    def driven_mode(self) -> drivenEnum:
+    def driven(self) -> drivenEnum:
         return CommandFieldBase._driven
 
-    @driven_mode.setter
-    def driven_mode(self, new: drivenEnum):
+    @driven.setter
+    def driven(self, new: drivenEnum):
         CommandFieldBase._driven = new
 
     def convert_result(self, response: Dict[str, str]) -> Tuple[float, str]:
         """
-        Converts the CommandMultiVu response from get_state()
+        Converts the CommandMultiVu response from get_state_server()
         to something usable for the user.
 
         Parameters:
@@ -193,8 +195,8 @@ class CommandFieldBase(ICommand):
     def _set_state_imp(self,
                        field: float,
                        set_rate_per_sec: float,
-                       set_approach: int,
-                       set_driven: int,
+                       set_approach: ApproachEnum,
+                       set_driven: drivenEnum,
                        ) -> Union[str, int]:
         raise NotImplementedError
 
@@ -211,26 +213,30 @@ class CommandFieldBase(ICommand):
         field = float(field)
         set_rate_per_sec = float(rate)
         set_approach = int(approach)
-        set_driven = int(driven)
-        if set_approach > len(ApproachEnum) - 1:
-            err_msg = f'The approach, {approach}, is out of bounds.  Must be '
-            err_msg += 'one of the following:'
+        set_approach_number = int(approach)
+        if set_approach_number > len(ApproachEnum) - 1:
+            err_msg = f'The approach, {set_approach_number}, is out of bounds.'
+            err_msg += ' Must be one of the following:'
             for mode in ApproachEnum:
-                print(f'\n\t{mode.value}: {mode.name}')
+                err_msg += f'\n\t{mode.value}: {mode.name}'
             raise MultiPyVuError(err_msg)
+        set_approach = ApproachEnum(set_approach_number)
 
+        set_driven_number = int(driven)
         if self.instrument_name != 'PPMS':
+            set_driven = drivenEnum(set_driven_number)
             if set_driven == drivenEnum.persistent:
                 err_msg = f'{self.instrument_name} can only drive the magnet '
                 err_msg += 'in driven mode.'
                 raise MultiPyVuError(err_msg)
         else:
-            if set_driven > len(drivenEnum) - 1:
-                err_msg = f'The mode, {driven}, is out of bounds.  Must be '
-                err_msg += 'one of the following:'
+            if set_driven_number > len(drivenEnum) - 1:
+                err_msg = f'The driven mode, {set_driven_number}, is out of '
+                err_msg += 'bounds. Must be one of the following:'
                 for mode in drivenEnum:
                     err_msg += f'\n\t{mode.value}: {mode.name}'
                 raise MultiPyVuError(err_msg)
+            set_driven = drivenEnum(set_driven_number)
         if self.instrument_name == 'VERSALAB':
             if set_approach == ApproachEnum.no_overshoot:
                 err_msg = f'{self.instrument_name} does not support the '
@@ -266,7 +272,10 @@ class CommandFieldImp(ICommandImp, CommandFieldBase):
         CommandFieldBase.__init__(self, instrument_name)
         self._mvu = multivu_win32com
 
-    def get_state_server(self, value_variant, state_variant, params=''):
+    def get_state_server(self,
+                         value_variant,
+                         state_variant,
+                         params='') -> Tuple[float, int]:
         """
         Retrieves information from MultiVu
 
@@ -297,8 +306,8 @@ class CommandFieldImp(ICommandImp, CommandFieldBase):
     def _set_state_imp(self,
                        field: float,
                        set_rate_per_sec: float,
-                       set_approach: int,
-                       set_driven: int
+                       set_approach: ApproachEnum,
+                       set_driven: drivenEnum
                        ) -> Union[str, int]:
         can_error = self._mvu.setField(field,
                                        set_rate_per_sec,
@@ -307,17 +316,16 @@ class CommandFieldImp(ICommandImp, CommandFieldBase):
                                        )
         self.set_point = field
         self.rate = set_rate_per_sec
-        self.approach_mode = set_approach
-        self.driven_mode = drivenEnum(set_driven)
+        self.approach = set_approach
+        self.driven = drivenEnum(set_driven)
 
+        if can_error > 1:
+            raise MultiPyVuError('Error when calling SetField()')
+        # It is odd that sometimes a can_error of 1 is okay.  So far I have
+        # only seen this behavior with a few flavors.
         if self.instrument_name in ('PPMS', 'MPMS3'):
-            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 can_error
 
     def test(self) -> bool:
@@ -335,12 +343,12 @@ class CommandFieldImp(ICommandImp, CommandFieldBase):
         steady = False
         self._get_values()
         state_name = self.convert_state_dictionary(self.state)
-        if state_name == 'Holding (driven)' or state_name == 'Stable':
-            steady = self.floats_equal(self.current_val,
-                                       self.set_point,
-                                       accept_pct,
-                                       abs_tol,
-                                       )
+        if state_name in ('Holding (driven)', 'Stable'):
+            steady = floats_equal(self.current_val,
+                                  self.set_point,
+                                  accept_pct,
+                                  abs_tol,
+                                  )
         return steady
 
 
@@ -434,7 +442,7 @@ class SimulateFieldChange(ISimulateChange):
 
         # set state to ramping
         start_time = time.time()
-        self.state = STATE_DICT[2]
+        self.state = STATE_DICT[6]
         self.notify_observers(self.current_val, self.state)
 
         # simulate the ramp
@@ -500,20 +508,22 @@ class CommandFieldSim(CommandFieldBase,
     def _set_state_imp(self,
                        field: float,
                        set_rate_per_sec: float,
-                       set_approach: int,
-                       set_driven: int
+                       set_approach: ApproachEnum,
+                       set_driven: drivenEnum
                        ) -> Union[str, int]:
-        self.change_thread = self.get_sim_instance()
+        self.change_thread: SimulateFieldChange = self.get_sim_instance()
         state_string = STATE_DICT[self.state]
         self.change_thread.set_params(self.current_val,
                                       field,
                                       set_rate_per_sec,
                                       state_string,
                                       )
-        self.set_approach = set_approach
+        self.set_point = field
+        self.rate = set_rate_per_sec
+        self.approach = set_approach
         self.change_thread.approach = set_approach
-        self.driven_mode = drivenEnum(set_driven)
-        self.change_thread.driven_mode = self.driven_mode
+        self.driven = set_driven
+        self.change_thread.driven_mode = self.driven
 
         self.change_thread.subscribe(self)
         self.change_thread.start()