Merge branch 'main' of https://github.com/sandialabs/pyscan into docs

Author: rsbrost

CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.7.4](https://github.com/sandialabs/pyscan/compare/v0.7.3...v0.7.4) (2024-10-01)
+
+
+### Bug Fixes
+
+* **measurement:** fixed sparse experiment to use scan naming convention rather than loop. ([423ce39](https://github.com/sandialabs/pyscan/commit/423ce39cb05f751a09a313682c46c2254cc6472e))
+* **plotting:** updating loop nomenclature to scan in plot_generator. ([af27aa6](https://github.com/sandialabs/pyscan/commit/af27aa626df4cf0bc3b78f8cb6847ca9a5ec9c49))
+
+
+
 ## [0.7.3](https://github.com/sandialabs/pyscan/compare/v0.7.2...v0.7.3) (2024-09-24)
 
 

pyscan/VERSION.json

@@ -1,3 +1,3 @@
 {
-  "version": "0.7.3"
+  "version": "0.7.4"
 }

pyscan/drivers/testing/driver_test_logs/test_instrument_driver_test_log.txt

@@ -1 +1 @@
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.7.0 at 2024-08-20 12:26:41
+Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.7.0 at 2024-09-05 16:00:29

pyscan/drivers/testing/driver_test_logs/test_voltage_test_log.txt

@@ -1 +1 @@
-Passed with test_voltage version v0.1.0 tested on pyscan version v0.7.0 at 2024-08-20 12:26:41
+Passed with test_voltage version v0.1.0 tested on pyscan version v0.7.0 at 2024-09-05 16:00:29

pyscan/measurement/abstract_experiment.py

@@ -290,6 +290,11 @@ def default_trigger_function(self):
 
 # legacy naming convention
 class MetaSweep(AbstractExperiment):
-    ''' Present for backwards compatibility. Renamed to :class:`.AbstractExperiment`.
     '''
-    pass
+    Present for backwards compatibility. Renamed to :class:`.AbstractExperiment`.
+    '''
+    def __init__(self, runinfo, devices, data_dir):
+        warning_msg = ("Use of legacy nomenclature detected but no longer supported.\n"
+                       + "You entered MetaSweep, use AbstractExperiment instead.")
+        raise DeprecationWarning(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+        assert False, f"\033[93m*** WARNING! ***: {warning_msg} \033[0m"

pyscan/measurement/experiment.py

@@ -267,4 +267,12 @@ def run(self):
 
 # legacy naming convention
 class Sweep(Experiment):
-    pass
+    '''
+    Present for backwards compatibility. Renamed to :class:`.Experiment`.
+    '''
+
+    def __init__(self, runinfo, devices, data_dir=None, verbose=False, time=False):
+        warning_msg = ("Use of legacy nomenclature detected but no longer supported.\n"
+                       + "You entered Sweep, use Experiment instead.")
+        raise DeprecationWarning(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+        assert False, f"\033[93m*** WARNING! ***: {warning_msg} \033[0m"

pyscan/measurement/run_info.py

@@ -195,43 +195,55 @@ def has_average_scan(self):
 
         return self._has_average_scan
 
-    # These property's are strictly for backwards compatibility with old pyscan naming convention.
+    ####################### LEGACY SECTION ########################
+    # This section is set up to alert users who try to use legacy nomenclature
+    # of the updated naming convention that they must use instead.
     @property
     def loop0(self):
+        legacy_warning()
         return self.scan0
 
     @loop0.setter
     def loop0(self, value):
+        legacy_warning()
         self.scan0 = value
 
     @property
     def loop1(self):
+        legacy_warning()
         return self.scan1
 
     @loop1.setter
     def loop1(self, value):
+        legacy_warning()
         self.scan1 = value
 
     @property
     def loop2(self):
+        legacy_warning()
         return self.scan2
 
     @loop2.setter
     def loop2(self, value):
+        legacy_warning()
         self.scan2 = value
 
     @property
     def loop3(self):
+        legacy_warning()
         return self.scan3
 
     @loop3.setter
     def loop3(self, value):
+        legacy_warning()
         self.scan3 = value
 
     @property
     def loops(self):
-        ''' Returns array of all scans
         '''
+        Returns array of all scans
+        '''
+        legacy_warning()
         return [self.scan0, self.scan1, self.scan2, self.scan3]
 
 
@@ -252,3 +264,10 @@ def drop(array, index):
     '''
 
     return list(array[0:index]) + list(array[index + 1:])
+
+
+def legacy_warning():
+    warning_msg = ("Use of legacy nomenclature detected but no longer supported.\n"
+                   + "You entered 'loop', use 'scan' instead.")
+    raise DeprecationWarning(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    assert False, f"\033[93m*** WARNING! ***: {warning_msg} \033[0m"

pyscan/measurement/sparse_experiment.py

@@ -6,18 +6,18 @@
 
 
 class SparseExperiment(AbstractExperiment):
-    '''Experiment class that takes data after each loop0 iteration if
+    '''Experiment class that takes data after each scan0 iteration if
     runinfo.sparse_points[self.runinfo.indicies] = 1, allowing the experiment
     to skip taking data points. Inherits from :class:`pyscan.measurement.abstract_experiment.AbstractExperiment`.
 
     Parameters
     ----------
     runinfo: :class:`pyscan.measurement.runinfo.Runinfo`
-        Runinfo instance. The Runinfo loop containing the dependent variable
+        Runinfo instance. The Runinfo scan containing the dependent variable
         that you want to average should be an instance of
         :class:`AverageScan<pyscan.measurement.scans.AverageScan>`.
         There should be only one dependent variable to be averaged.
-        The loops representing independent variables can be instances of
+        The scans representing independent variables can be instances of
         :class:`PropertyScan<pyscan.measurement.scans.PropertyScan>`.
     devices :
         ItemAttribute instance containing all experiment devices
@@ -47,29 +47,29 @@ def run(self):
 
         self.runinfo.running = True
 
-        # Use for loop, but break if self.runinfo.running=False
-        for m in range(self.runinfo.loop3.n):
-            self.runinfo.loop3.i = m
-            self.runinfo.loop3.iterate(m, self.devices)
-            sleep(self.runinfo.loop3.dt)
+        # Use for scan, but break if self.runinfo.running=False
+        for m in range(self.runinfo.scan3.n):
+            self.runinfo.scan3.i = m
+            self.runinfo.scan3.iterate(m, self.devices)
+            sleep(self.runinfo.scan3.dt)
 
-            for k in range(self.runinfo.loop2.n):
-                self.runinfo.loop2.i = k
-                self.runinfo.loop2.iterate(k, self.devices)
-                sleep(self.runinfo.loop2.dt)
+            for k in range(self.runinfo.scan2.n):
+                self.runinfo.scan2.i = k
+                self.runinfo.scan2.iterate(k, self.devices)
+                sleep(self.runinfo.scan2.dt)
 
-                for j in range(self.runinfo.loop1.n):
-                    self.runinfo.loop1.i = j
-                    self.runinfo.loop1.iterate(j, self.devices)
-                    sleep(self.runinfo.loop1.dt)
+                for j in range(self.runinfo.scan1.n):
+                    self.runinfo.scan1.i = j
+                    self.runinfo.scan1.iterate(j, self.devices)
+                    sleep(self.runinfo.scan1.dt)
 
-                    for i in range(self.runinfo.loop0.n):
-                        self.runinfo.loop0.i = i
+                    for i in range(self.runinfo.scan0.n):
+                        self.runinfo.scan0.i = i
                         sample = self.runinfo.sparse_points[self.runinfo.indicies]
 
                         if (sample) or (np.all(np.array(self.runinfo.indicies) == 0)):
-                            self.runinfo.loop0.iterate(i, self.devices)
-                            sleep(self.runinfo.loop0.dt)
+                            self.runinfo.scan0.iterate(i, self.devices)
+                            sleep(self.runinfo.scan0.dt)
 
                             data = self.runinfo.measure_function(self)
                             if np.all(np.array(self.runinfo.indicies) == 0):
@@ -100,7 +100,7 @@ def run(self):
                     break
 
             if self.runinfo.verbose:
-                print('Scan {}/{} Complete'.format(m + 1, self.runinfo.loop3.n))
+                print('Scan {}/{} Complete'.format(m + 1, self.runinfo.scan3.n))
             if self.runinfo.running is False:
                 self.runinfo.complete = 'stopped'
                 break

pyscan/plotting/plot_generator.py

@@ -80,9 +80,9 @@ def get_x(self):
         '''
 
         if self.x_name is None:
-            self.x_name = first_string(list(self.expt.runinfo.loop0.scan_dict.keys()))
+            self.x_name = first_string(list(self.expt.runinfo.scan0.scan_dict.keys()))
 
-        self.other_x = set_difference(list(self.expt.runinfo.loop0.scan_dict.keys()), self.x_name)
+        self.other_x = set_difference(list(self.expt.runinfo.scan0.scan_dict.keys()), self.x_name)
         self.x = self.expt[self.x_name]
 
     def get_xlabel(self):
@@ -106,8 +106,8 @@ def get_y(self):
             self.other_y = ''
         else:
             if self.y_name is None:
-                self.y_name = first_string(list(self.expt.runinfo.loop1.scan_dict.keys()))
-            self.other_y = set_difference(list(self.expt.runinfo.loop1.scan_dict.keys()), self.y_name)
+                self.y_name = first_string(list(self.expt.runinfo.scan1.scan_dict.keys()))
+            self.other_y = set_difference(list(self.expt.runinfo.scan1.scan_dict.keys()), self.y_name)
             self.y = self.expt[self.y_name]
 
     def get_ylabel(self):
@@ -153,23 +153,23 @@ def get_title(self):
         if not self.expt.runinfo.running:
             return '{}, {}'.format(self.data_name, self.expt.runinfo.long_name)
         elif self.expt.runinfo.ndim == 4:
-            return '{}/{}, {}, {}'.format(self.expt.runinfo.loop4.i,
-                                          self.expt.runinfo.loop4.n,
+            return '{}/{}, {}, {}'.format(self.expt.runinfo.scan4.i,
+                                          self.expt.runinfo.scan4.n,
                                           self.data_name,
                                           self.expt.runinfo.long_name)
         elif self.expt.runinfo.ndim == 3:
-            return '{}/{}, {}, {}'.format(self.expt.runinfo.loop3.i,
-                                          self.expt.runinfo.loop3.n,
+            return '{}/{}, {}, {}'.format(self.expt.runinfo.scan3.i,
+                                          self.expt.runinfo.scan3.n,
                                           self.data_name,
                                           self.expt.runinfo.long_name)
         elif self.expt.runinfo.ndim == 2:
-            return '{}/{}, {}, {}'.format(self.expt.runinfo.loop2.i,
-                                          self.expt.runinfo.loop2.n,
+            return '{}/{}, {}, {}'.format(self.expt.runinfo.scan2.i,
+                                          self.expt.runinfo.scan2.n,
                                           self.data_name,
                                           self.expt.runinfo.long_name)
         elif self.expt.runinfo.ndim == 1:
-            return '{}/{}, {}, {}'.format(self.expt.runinfo.loop1.i,
-                                          self.expt.runinfo.loop1.n,
+            return '{}/{}, {}, {}'.format(self.expt.runinfo.scan1.i,
+                                          self.expt.runinfo.scan1.n,
                                           self.data_name,
                                           self.expt.runinfo.long_name)