Merge pull request #194 from sandialabs/saving-too-fast

Saving too fast issues fixed.

Author: rsbrost

pyscan/drivers/testing/driver_test_logs/test_instrument_driver_test_log.txt

@@ -1,8 +1 @@
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:07:38
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:07:38
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:07:38
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:07:38
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:06:58
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:06:57
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:06:57
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.3.0 at 2024-05-30 10:39:46
+Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.5.3 at 2024-07-05 11:41:28

pyscan/drivers/testing/driver_test_logs/test_voltage_test_log.txt

@@ -1,3 +1 @@
-Passed with test_voltage version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:07:38
-Passed with test_voltage version v0.1.0 tested on pyscan version v0.4.0 at 2024-06-05 15:06:58
-Passed with test_voltage version v0.1.0 tested on pyscan version v0.3.0 at 2024-05-30 10:39:46
+Passed with test_voltage version v0.1.0 tested on pyscan version v0.5.3 at 2024-07-05 11:41:28

pyscan/measurement/abstract_experiment.py

@@ -160,7 +160,16 @@ def check_runinfo(self):
         if num_repeat_scans > 1:
             assert False, "More than one repeat scan detected. This is not allowed."
 
-        self.runinfo.long_name = strftime("%Y%m%dT%H%M%S")
+        base_name = strftime("%Y%m%dT%H%M%S")
+        save_path = self.runinfo.data_path / '{}.hdf5'.format(base_name)
+        count = 0
+
+        while save_path.exists():
+            count += 1
+            save_path = self.runinfo.data_path / f'{base_name}-{count}.hdf5'
+
+        self.runinfo.long_name = save_path.stem
+
         self.runinfo.short_name = self.runinfo.long_name[8:]
 
         self.runinfo.check()

pyscan/measurement/experiment.py

@@ -82,6 +82,7 @@ def generic_experiment(self):
                             self.runinfo.t3[indicies] = (datetime.now()).timestamp()
 
                         if np.all(np.array(self.runinfo.indicies) == 0):
+                            self.runinfo.measured = []
                             for key, value in data.items():
                                 self.runinfo.measured.append(key)
                             self.preallocate(data)
@@ -172,6 +173,7 @@ def average_experiment(self):
 
                         # if on the first row of data, log the data names in self.runinfo.measured
                         if np.all(np.array(self.runinfo.indicies) == 0):
+                            self.runinfo.measured = []
                             for key, value in data.items():
                                 self.runinfo.measured.append(key)
                             self.preallocate(data)

test/legacy/measurement/test_legacy_abstract_experiment.py

@@ -12,6 +12,7 @@
 from io import StringIO
 import sys
 import shutil
+import re
 
 
 # for testing default trigger function with empty function
@@ -104,7 +105,8 @@ def test_ms_diff_inputs(data_dir=None, measure_function=measure_point, allocate=
 
         assert hasattr(ms.runinfo, 'long_name'), "Meta Sweep runinfo long name is not initialized by check_runinfo()"
         assert isinstance(ms.runinfo.long_name, str), "Meta Sweep runinfo long name is not initialized as a string"
-        assert len(ms.runinfo.long_name) == 15, "Meta Sweep runinfo long name is not 15 characters"
+        # check that the long name is formatted with values for YYYYMMDDTHHMMSS, and optionally a - followed by digits.
+        assert re.match(r'^\d{8}T\d{6}(-\d+)?$', ms.runinfo.long_name), "runinfo long_name is not properly formatted"
 
         assert hasattr(ms.runinfo, 'short_name'), "Meta Sweep runinfo long name is not initialized by check_runinfo()"
         assert isinstance(ms.runinfo.short_name, str), "Meta Sweep runinfo short name is not initialized as a string"

test/legacy/measurement/test_legacy_experiment.py

@@ -8,6 +8,8 @@
 import shutil
 import numpy as np
 import pytest
+import re
+import os
 
 
 ##################### FUNCTIONS USED BY TEST CASES #####################
@@ -1098,3 +1100,61 @@ def check_load_expt(temp):
     check_load_expt(temp)
 
     shutil.rmtree('./backup')
+
+
+def test_fast_experiments():
+    devices = ps.ItemAttribute()
+
+    devices.v1 = ps.TestVoltage()  # Device 1
+    devices.v2 = ps.TestVoltage()  # Device 2
+    devices.v3 = ps.TestVoltage()  # Device 3
+
+    def get_voltage_data(ms):
+        """
+        Reads the voltage from v1, v2, and v3 devices. Also adds a calculated value vsum.
+        """
+
+        devices = ms.devices
+
+        d = ps.ItemAttribute()
+
+        d.v1_readout = devices.v1.voltage
+        d.v2_readout = devices.v2.voltage
+        d.v3_readout = devices.v3.voltage
+
+        d.vsum = d.v1_readout + d.v2_readout + d.v3_readout
+
+        return d
+
+    # Create RunInfo instance and set scan0 to PropertyScan
+    runinfo = ps.RunInfo()
+    runinfo.scan0 = ps.RepeatScan(1, dt=0.0000001)
+
+    # Set RunInfo measure_function (remember, it takes a Experiment object as a parameter and
+    # returns an ItemAttribute containing data).
+    runinfo.measure_function = get_voltage_data
+
+    # Create a Experiment class with the RunInfo and Devices just created
+    ms = ps.Sweep(runinfo, devices, time=True)
+
+    long_names = []
+
+    while len(long_names) < 3:
+        ms.run()
+        if len(long_names) == 0:
+            long_names.append(ms.runinfo.long_name)
+        elif (ms.runinfo.long_name[:15] == long_names[0][:15]):
+            long_names.append(ms.runinfo.long_name)
+        else:
+            long_names = [ms.runinfo.long_name]
+
+    err_str = f"First long name '{long_names[0]}' does not match expected date/time format."
+    assert re.match(r'^\d{8}T\d{6}$', long_names[0]), err_str
+    err_str = f"-1 long name '{long_names[1]}' does not match expected increment or format."
+    assert long_names[1] == long_names[0] + '-1', err_str
+    err_str = f"-2 long name '{long_names[1]}' does not match expected increment or format."
+    assert long_names[2] == long_names[0] + '-2', err_str
+
+    for name in long_names:
+        save_path = ms.runinfo.data_path / '{}.hdf5'.format(name)
+        assert os.path.exists(save_path), f"Expected file at path'{save_path}' was not found."

test/measurement/test_abstract_experiment.py

@@ -12,6 +12,7 @@
 from io import StringIO
 import sys
 import shutil
+import re
 
 
 # for testing default trigger function with empty function
@@ -104,7 +105,8 @@ def test_ms_diff_inputs(data_dir=None, measure_function=measure_point, allocate=
 
         assert hasattr(ms.runinfo, 'long_name'), "Meta Sweep runinfo long name is not initialized by check_runinfo()"
         assert isinstance(ms.runinfo.long_name, str), "Meta Sweep runinfo long name is not initialized as a string"
-        assert len(ms.runinfo.long_name) == 15, "Meta Sweep runinfo long name is not 15 characters"
+        # check that the long name is formatted with values for YYYYMMDDTHHMMSS, and optionally a - followed by digits.
+        assert re.match(r'^\d{8}T\d{6}(-\d+)?$', ms.runinfo.long_name), "runinfo long_name is not properly formatted"
 
         assert hasattr(ms.runinfo, 'short_name'), "Meta Sweep runinfo long name is not initialized by check_runinfo()"
         assert isinstance(ms.runinfo.short_name, str), "Meta Sweep runinfo short name is not initialized as a string"

test/measurement/test_experiment.py

@@ -8,6 +8,8 @@
 import shutil
 import numpy as np
 import pytest
+import re
+import os
 
 
 ##################### FUNCTIONS USED BY TEST CASES #####################
@@ -1093,3 +1095,61 @@ def check_load_expt(temp):
     check_load_expt(temp)
 
     shutil.rmtree('./backup')
+
+
+def test_fast_experiments():
+    devices = ps.ItemAttribute()
+
+    devices.v1 = ps.TestVoltage()  # Device 1
+    devices.v2 = ps.TestVoltage()  # Device 2
+    devices.v3 = ps.TestVoltage()  # Device 3
+
+    def get_voltage_data(expt):
+        """
+        Reads the voltage from v1, v2, and v3 devices. Also adds a calculated value vsum.
+        """
+
+        devices = expt.devices
+
+        d = ps.ItemAttribute()
+
+        d.v1_readout = devices.v1.voltage
+        d.v2_readout = devices.v2.voltage
+        d.v3_readout = devices.v3.voltage
+
+        d.vsum = d.v1_readout + d.v2_readout + d.v3_readout
+
+        return d
+
+    # Create RunInfo instance and set scan0 to PropertyScan
+    runinfo = ps.RunInfo()
+    runinfo.scan0 = ps.RepeatScan(1, dt=0.0000001)
+
+    # Set RunInfo measure_function (remember, it takes a Experiment object as a parameter and
+    # returns an ItemAttribute containing data).
+    runinfo.measure_function = get_voltage_data
+
+    # Create a Experiment class with the RunInfo and Devices just created
+    expt = ps.Experiment(runinfo, devices, time=True)
+
+    long_names = []
+
+    while len(long_names) < 3:
+        expt.run()
+        if len(long_names) == 0:
+            long_names.append(expt.runinfo.long_name)
+        elif (expt.runinfo.long_name[:15] == long_names[0][:15]):
+            long_names.append(expt.runinfo.long_name)
+        else:
+            long_names = [expt.runinfo.long_name]
+
+    err_str = f"First long name '{long_names[0]}' does not match expected date/time format."
+    assert re.match(r'^\d{8}T\d{6}$', long_names[0]), err_str
+    err_str = f"-1 long name '{long_names[1]}' does not match expected increment or format."
+    assert long_names[1] == long_names[0] + '-1', err_str
+    err_str = f"-2 long name '{long_names[1]}' does not match expected increment or format."
+    assert long_names[2] == long_names[0] + '-2', err_str
+
+    for name in long_names:
+        save_path = expt.runinfo.data_path / '{}.hdf5'.format(name)
+        assert os.path.exists(save_path), f"Expected file at path'{save_path}' was not found."