MultiPyVu 3.3.0__tar.gz → 3.6.1__tar.gz

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

@@ -1,47 +1,30 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: MultiPyVu
-Version: 3.3.0
+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.8
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pandas
 Requires-Dist: pywin32>=300; platform_system == "Windows"
 Requires-Dist: pillow
 Requires-Dist: pyyaml
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ![qd_logo](https://qdusa.com/images/QD_logo.png)
 # MultiPyVu
@@ -60,6 +43,7 @@ Requires-Dist: pyyaml
     * [is_steady()](#is_steady)
     * [get_aux_temperature()](#aux_therm)
     * [resistivity option](#brt)
+    * [horizontal rotator option](#rotator)
 * [Saving & Opening a MultiVu Data File](#save)
 * [Querying the Server Status](#server_status)
 * [Testing the Server Using Scaffolding](#scaffolding)
@@ -77,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.8 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
 ```
@@ -104,8 +88,10 @@ 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```.
 UsefulBatchFiles\show_process_with_port.cmd | Shows that active processes are running and what port is being used. By default, this looks for processes running on port 5000.  To query a different port number, append it to the command line arguments.  ```$ show_processes_with_port.cmd 4567```
 UsefulBatchFiles\RunServer.cmd | This runs the server GUI.
@@ -138,22 +124,23 @@ $ python -m MultiPyVu -get_ip
 On the client PC, update the 'host' variable of the 'example_Remote-Client.py' script *with the same server PC IPV4 address* and run it.  The script will report the present temperature and field value/status a few times to show the connection is functioning.
 
 **Next Steps:**
-It may sometimes be desirable to combine the sample environment parameters (temperature, field) with readings from a user's own instrumentation into a single *.dat* file which can be plotted in MultiVu.  This functionality, accomplished using the MultiPyVu.DataFile module, is demonstrated using PyVISA to communicate with a VISA-compatible instrument in the  'example_MvDataFile_VISA.py' example.  Note that for this routine to execute properly, the correct instrument bus/address and query string need to be updated in the script.
+It may sometimes be desirable to combine the sample environment parameters (temperature, field) with readings from a user's own instrumentation into a single *.dat* file which can be plotted in MultiVu.  This functionality, accomplished using the MultiPyVu.DataFile module, is demonstrated using PyVISA to communicate with a VISA-compatible instrument in the  'Remote Connection/example_MvDataFile_VISA.py' example.  Note that for this routine to execute properly, the correct instrument bus/address and query string need to be updated in the script.
 
 For further information on the detailed operation of the components of the module, see the following sections.
 
 ### Using MultiPyVu.Server() and MultiPyVu.Client()<a class="anchor" id="using"></a>
-To start the server on localhost, open MultiVu, and then, using the example script _run_server.py_, go to a command prompt and type:
+To start the server on localhost, open MultiVu, and type:
 ```cmd
-$ python run_server.py
+$ python -m MultiPyVu
 ```
-The server can also be started using a gui:
+One can also use the example script _run_server.py_, go to a command prompt and type:
 ```cmd
-$ python -m MultiPyVu
+$ python run_server.py
 ```
+
 As mentioned above, if the client and the server are running on the same computer as MultiVu, then one can use example_local.py as a guide to set up the whole script in one file.
 
-There are a list of useful flags to specify settings.  These can be found by typing -h, which brings up help information:
+There are a list of flags to specify settings.  These can be found by typing -h, which brings up help information:
 ```cmd
 $ python -m MultiPyVu -h
 ```
@@ -170,8 +157,8 @@ Both the Server and the Client are context managers, which means to write a scri
 import MultiPyVu as mpv
 
 with mpv.Client('127.0.0.1') as client:
-    <put scripting commands here>
-<do post-processing once the client has been closed>
+    # put scripting commands here
+# do post-processing once the client has been closed
 ```
 
 If the host or port are not default values (localhost and 5000, respectively), then these parameters must be specified when instantiating MultiPyVu.Client().
@@ -180,16 +167,11 @@ Alternatively, one can start a connection to the server using:
 ```python
 client = mpv.Client(host='127.0.0.1')
 client.open()
-<put scripting commands here>
+# put scripting commands here
 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.
-
-If needed, one can turn off socket timeouts so that the client will wait indefinitely for a response from the server.  To do this, set the time in seconds using the 'socket_timeout' keyword when instantiating the client, or set the time to *None* to turn off the timeout. By default, the timeout is set to one second.
-```python
-client = mpv.Client(socket_timeout=None)
+# 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.  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
@@ -197,14 +179,14 @@ client.close_server()
 ```
 instead of client.close_client().  Note that once this is called, the server will need to be reopened.  Also, this can not be accessed from within a with-block.
 
-If the client and server are being run on the same computer, then one could also write one script to control them both.
+If the client and server are being run on the same computer, then a single script can control them both.
 ```python
 import MultiPyVu as mpv
 
 with mpv.Server() as server:
     with mpv.Client() as client:
-        <put scripting commands here>
-<do post-processing now that the client and server have been closed>
+        # put scripting commands here
+# do post-processing now that the client and server have been closed
 ```
 
 This is convenient as it does not require running two different scripts.
@@ -237,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
@@ -258,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
@@ -271,9 +261,9 @@ chamber = client.get_chamber()
 Note that this command is not used by the OptiCool.
 
 **Wait For**<a class="anchor" id="waitfor"></a>
-When a setting on a cryostat is configured, it will take time to reach the new set point.  If desired, one can wait for the setting to become stable using the .wait_for(delay, timeout, bitmask) command.  A delay will set the time in seconds after the setting is stable, which can be useful to make sure a sample has time to thermalize; timeout is the seconds until the command will give up; bitmask tells the system which settings need to be stable.  This can be set using the client.subsystem enum, and multiple parameters are combined using bit-wise or.  In the example below, the wait_for command will wait at least 90 seconds for the temperature, field, and chamber to stabilize, and will then immediately go on to the next command.
+When a setting on a cryostat is configured, it will take time to reach the new set point.  If desired, one can wait for the setting to become stable using the .wait_for(delay, timeout, bitmask) command.  A delay will set the time in seconds after the setting is stable, which can be useful to make sure a sample has time to thermalize; timeout is the seconds until the command will give up; bitmask tells the system which settings need to be stable.  This can be set using the waitfor handle, and multiple parameters are combined using bit-wise or.  In the example below, the wait_for command will wait at least 90 seconds for the temperature, field, and chamber to stabilize, and will then immediately go on to the next command.
 ```python
-client.wait_for(0, 90, client.temperature.waitfor | client.field.waitfor| 
+client.wait_for(0, 90, client.temperature.waitfor | client.field.waitfor | 
 client.chamber.waitfor)
 ```
 
@@ -316,6 +306,18 @@ client.resistivity.get_resistance(bridge_number)
 client.resistivity.get_current(bridge_number)
 ```
 
+**Horizontal Rotator Option**<a class="anchor" id="rotator"></a>
+
+For DynaCool, VersaLab, and PPMS customers with the horizontal rotator option, MultiPyVu can be used to adjust the rotator position.  The option must be configured before using MultiPyVu. Note that the rate_deg_per_sec is ignored for the PPMS.
+
+Once configured, the following commands are simple to use:
+```python
+position = 374.5
+rate_deg_per_sec = 100.0
+client.set_position(position, rate_deg_per_sec)
+pos, status = client.get_position()
+```
+
 ### 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.
 
@@ -419,8 +421,8 @@ import MultiPyVu as mpv
 
 with mpv.Server(flags=['-s', 'DYNACOOL']) as server:
     with mpv.Client() as client:
-        <put scripting commands here>
-<do post-processing now that the client and server have been closed>
+        # put scripting commands here
+# do post-processing now that the client and server have been closed
 ```
 
 ### Troubleshooting<a class="anchor" id="troubleshooting"></a>
@@ -435,6 +437,22 @@ 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.
+
+**3.4.0**
+- May 2025
+- Minimum python version now 3.9.
+- Implemented socket handshaking to improve the reliability of the socket
+communications.
+
 **3.3.0**
 - April 2025
 - Bugfix which didn't allow this to be run on Mac or Linux platforms.

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

@@ -15,6 +15,7 @@
     * [is_steady()](#is_steady)
     * [get_aux_temperature()](#aux_therm)
     * [resistivity option](#brt)
+    * [horizontal rotator option](#rotator)
 * [Saving & Opening a MultiVu Data File](#save)
 * [Querying the Server Status](#server_status)
 * [Testing the Server Using Scaffolding](#scaffolding)
@@ -32,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.8 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
 ```
@@ -59,8 +60,10 @@ 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```.
 UsefulBatchFiles\show_process_with_port.cmd | Shows that active processes are running and what port is being used. By default, this looks for processes running on port 5000.  To query a different port number, append it to the command line arguments.  ```$ show_processes_with_port.cmd 4567```
 UsefulBatchFiles\RunServer.cmd | This runs the server GUI.
@@ -93,22 +96,23 @@ $ python -m MultiPyVu -get_ip
 On the client PC, update the 'host' variable of the 'example_Remote-Client.py' script *with the same server PC IPV4 address* and run it.  The script will report the present temperature and field value/status a few times to show the connection is functioning.
 
 **Next Steps:**
-It may sometimes be desirable to combine the sample environment parameters (temperature, field) with readings from a user's own instrumentation into a single *.dat* file which can be plotted in MultiVu.  This functionality, accomplished using the MultiPyVu.DataFile module, is demonstrated using PyVISA to communicate with a VISA-compatible instrument in the  'example_MvDataFile_VISA.py' example.  Note that for this routine to execute properly, the correct instrument bus/address and query string need to be updated in the script.
+It may sometimes be desirable to combine the sample environment parameters (temperature, field) with readings from a user's own instrumentation into a single *.dat* file which can be plotted in MultiVu.  This functionality, accomplished using the MultiPyVu.DataFile module, is demonstrated using PyVISA to communicate with a VISA-compatible instrument in the  'Remote Connection/example_MvDataFile_VISA.py' example.  Note that for this routine to execute properly, the correct instrument bus/address and query string need to be updated in the script.
 
 For further information on the detailed operation of the components of the module, see the following sections.
 
 ### Using MultiPyVu.Server() and MultiPyVu.Client()<a class="anchor" id="using"></a>
-To start the server on localhost, open MultiVu, and then, using the example script _run_server.py_, go to a command prompt and type:
+To start the server on localhost, open MultiVu, and type:
 ```cmd
-$ python run_server.py
+$ python -m MultiPyVu
 ```
-The server can also be started using a gui:
+One can also use the example script _run_server.py_, go to a command prompt and type:
 ```cmd
-$ python -m MultiPyVu
+$ python run_server.py
 ```
+
 As mentioned above, if the client and the server are running on the same computer as MultiVu, then one can use example_local.py as a guide to set up the whole script in one file.
 
-There are a list of useful flags to specify settings.  These can be found by typing -h, which brings up help information:
+There are a list of flags to specify settings.  These can be found by typing -h, which brings up help information:
 ```cmd
 $ python -m MultiPyVu -h
 ```
@@ -125,8 +129,8 @@ Both the Server and the Client are context managers, which means to write a scri
 import MultiPyVu as mpv
 
 with mpv.Client('127.0.0.1') as client:
-    <put scripting commands here>
-<do post-processing once the client has been closed>
+    # put scripting commands here
+# do post-processing once the client has been closed
 ```
 
 If the host or port are not default values (localhost and 5000, respectively), then these parameters must be specified when instantiating MultiPyVu.Client().
@@ -135,16 +139,11 @@ Alternatively, one can start a connection to the server using:
 ```python
 client = mpv.Client(host='127.0.0.1')
 client.open()
-<put scripting commands here>
+# put scripting commands here
 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.
-
-If needed, one can turn off socket timeouts so that the client will wait indefinitely for a response from the server.  To do this, set the time in seconds using the 'socket_timeout' keyword when instantiating the client, or set the time to *None* to turn off the timeout. By default, the timeout is set to one second.
-```python
-client = mpv.Client(socket_timeout=None)
+# 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.  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
@@ -152,14 +151,14 @@ client.close_server()
 ```
 instead of client.close_client().  Note that once this is called, the server will need to be reopened.  Also, this can not be accessed from within a with-block.
 
-If the client and server are being run on the same computer, then one could also write one script to control them both.
+If the client and server are being run on the same computer, then a single script can control them both.
 ```python
 import MultiPyVu as mpv
 
 with mpv.Server() as server:
     with mpv.Client() as client:
-        <put scripting commands here>
-<do post-processing now that the client and server have been closed>
+        # put scripting commands here
+# do post-processing now that the client and server have been closed
 ```
 
 This is convenient as it does not require running two different scripts.
@@ -192,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
@@ -213,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
@@ -226,9 +233,9 @@ chamber = client.get_chamber()
 Note that this command is not used by the OptiCool.
 
 **Wait For**<a class="anchor" id="waitfor"></a>
-When a setting on a cryostat is configured, it will take time to reach the new set point.  If desired, one can wait for the setting to become stable using the .wait_for(delay, timeout, bitmask) command.  A delay will set the time in seconds after the setting is stable, which can be useful to make sure a sample has time to thermalize; timeout is the seconds until the command will give up; bitmask tells the system which settings need to be stable.  This can be set using the client.subsystem enum, and multiple parameters are combined using bit-wise or.  In the example below, the wait_for command will wait at least 90 seconds for the temperature, field, and chamber to stabilize, and will then immediately go on to the next command.
+When a setting on a cryostat is configured, it will take time to reach the new set point.  If desired, one can wait for the setting to become stable using the .wait_for(delay, timeout, bitmask) command.  A delay will set the time in seconds after the setting is stable, which can be useful to make sure a sample has time to thermalize; timeout is the seconds until the command will give up; bitmask tells the system which settings need to be stable.  This can be set using the waitfor handle, and multiple parameters are combined using bit-wise or.  In the example below, the wait_for command will wait at least 90 seconds for the temperature, field, and chamber to stabilize, and will then immediately go on to the next command.
 ```python
-client.wait_for(0, 90, client.temperature.waitfor | client.field.waitfor| 
+client.wait_for(0, 90, client.temperature.waitfor | client.field.waitfor | 
 client.chamber.waitfor)
 ```
 
@@ -271,6 +278,18 @@ client.resistivity.get_resistance(bridge_number)
 client.resistivity.get_current(bridge_number)
 ```
 
+**Horizontal Rotator Option**<a class="anchor" id="rotator"></a>
+
+For DynaCool, VersaLab, and PPMS customers with the horizontal rotator option, MultiPyVu can be used to adjust the rotator position.  The option must be configured before using MultiPyVu. Note that the rate_deg_per_sec is ignored for the PPMS.
+
+Once configured, the following commands are simple to use:
+```python
+position = 374.5
+rate_deg_per_sec = 100.0
+client.set_position(position, rate_deg_per_sec)
+pos, status = client.get_position()
+```
+
 ### 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.
 
@@ -374,8 +393,8 @@ import MultiPyVu as mpv
 
 with mpv.Server(flags=['-s', 'DYNACOOL']) as server:
     with mpv.Client() as client:
-        <put scripting commands here>
-<do post-processing now that the client and server have been closed>
+        # put scripting commands here
+# do post-processing now that the client and server have been closed
 ```
 
 ### Troubleshooting<a class="anchor" id="troubleshooting"></a>
@@ -390,6 +409,22 @@ 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.
+
+**3.4.0**
+- May 2025
+- Minimum python version now 3.9.
+- Implemented socket handshaking to improve the reliability of the socket
+communications.
+
 **3.3.0**
 - April 2025
 - Bugfix which didn't allow this to be run on Mac or Linux platforms.

{multipyvu-3.3.0 → 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.3.0 → multipyvu-3.6.1}/setup.py

@@ -5,12 +5,12 @@ https://packaging.python.org/guides/distributing-packages-using-setuptools/
 https://github.com/pypa/sampleproject
 """
 
-# Always prefer setuptools over distutils
-from setuptools import setup, find_packages
-import pathlib
 import codecs
 import os.path
+import pathlib
 
+# Always prefer setuptools over distutils
+from setuptools import find_packages, setup
 
 here = pathlib.Path(__file__).parent.resolve()
 
@@ -51,11 +51,11 @@ setup(
             "logging_config.yaml"
             ]
         },
-    python_requires=">=3.8",
+    python_requires=">=3.7",
     install_requires=[
         "pandas",
         "pywin32>=300; platform_system=='Windows'",
         "pillow",
-        "pyyaml",
+        "pyyaml"
     ],
 )

{multipyvu-3.3.0 → multipyvu-3.6.1}/src/MultiPyVu/BRT.py

@@ -20,6 +20,23 @@ class Brt():
         self.client = client
         self.stabilize_time = 5
 
+    def _make_bridge_number_error(self, bridge_number: int) -> str:
+        """
+        This creates a simple error message saying that the
+        selected bridge number is out of range
+
+        Arguments:
+            bridge_number
+
+        Returns:
+            error message
+        """
+        msg = 'bridge_number must be 1, 2, or 3 '
+        # Note that python version 3.7 does not allow formatting
+        # strings using {bridge_number = }
+        msg += f'(bridge_number = {bridge_number})'
+        return msg
+
     def bridge_setup(self,
                      bridge_number: int,
                      channel_on: bool,
@@ -74,8 +91,7 @@ class Brt():
 
         sdo = enable_sdo.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         self.client._set_sdo(sdo, int(enable))
         # Pause to let the SDO go through.  The pause time is
         # somewhat arbitrary.
@@ -113,8 +129,7 @@ class Brt():
 
         sdo = const_current_sdo.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         self.client._set_sdo(sdo, int(const_current))
         for timeout in range(0, 4):
             time.sleep(0.6)
@@ -149,8 +164,7 @@ class Brt():
 
         sdo = resistance.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         res, status = self.client._get_sdo(sdo)
         return float(res), status
 
@@ -181,8 +195,7 @@ class Brt():
 
         sdo = current.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         res, status = self.client._get_sdo(sdo)
         return float(res), status
 
@@ -222,8 +235,7 @@ class Brt():
 
         sdo = current_sdo.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         self.client._set_sdo(sdo, current_uA)
         # Put in constant current mode
         self._constant_current(bridge_number, True)
@@ -265,8 +277,7 @@ class Brt():
 
         sdo = current_sdo.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         self.client._set_sdo(sdo, current_uA)
 
     def power_limit(self, bridge_number: int, power_uW: float) -> None:
@@ -306,8 +317,7 @@ class Brt():
 
         sdo = current_sdo.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         self.client._set_sdo(sdo, power_uW)
 
     def voltage_limit(self, bridge_number: int, voltage_mV: float) -> None:
@@ -347,8 +357,7 @@ class Brt():
 
         sdo = current_sdo.get(bridge_number, None)
         if sdo is None:
-            msg = f'bridge_number must be 1, 2, or 3 ({bridge_number = })'
-            raise ValueError(msg)
+            raise ValueError(self._make_bridge_number_error(bridge_number))
         self.client._set_sdo(sdo, voltage_mV)
 
     # This works, but is not used for the resistivity option, so currently commented out