Merged in cbillington/labscript_devices/arbitrary_subfolders (pull request #51)

Arbitrary subfolders for device code within labscript_devices

Author: chrisjbillington

AlazarTechBoard.py

@@ -78,7 +78,6 @@
     'ATS9462': 'a 200mV sine (conservatively peak-to-peak) between 9.5 and 10.5 MHz.'
 }
 
-from labscript_devices import labscript_device
 from labscript import Device, AnalogIn, bitfield, config, LabscriptError, set_passed_properties
 import labscript_utils.h5_lock
 import h5py
@@ -177,7 +176,7 @@ def generate_code(self, hdf5_file):
                 input_attrs), location='device_properties')
 
 
-from labscript_devices import BLACS_tab, BLACS_worker
+from labscript_devices import BLACS_tab
 from blacs.tab_base_classes import Worker, define_state
 from blacs.tab_base_classes import MODE_MANUAL, MODE_TRANSITION_TO_BUFFERED, MODE_TRANSITION_TO_MANUAL, MODE_BUFFERED
 from blacs.device_base_class import DeviceTab
@@ -274,7 +273,6 @@ def ats9462_clock(f):
 # to aborts never seeming to raise exceptions and the acquisition thread continuing on.
 
 
-@BLACS_worker
 class GuilessWorker(Worker):
     def init(self):
         global h5py

Camera.py

@@ -18,11 +18,11 @@
 
 check_version('labscript', '2.0.1', '3')
 
-from labscript_devices import labscript_device, BLACS_tab, BLACS_worker
+from labscript_devices import BLACS_tab
 from labscript import TriggerableDevice, LabscriptError, set_passed_properties
 import numpy as np
 
-@labscript_device
+
 class Camera(TriggerableDevice):
     description = 'Generic Camera'        
 
@@ -203,7 +203,7 @@ def update_responding_indicator(self, responding):
         self.ui.status_icon.setPixmap(pixmap)
         self.ui.server_status.setText(status_text)
 
-@BLACS_worker            
+
 class CameraWorker(Worker):
     def init(self):#, port, host, use_zmq):
 #        self.port = port

DummyPseudoclock.py

@@ -0,0 +1,24 @@
+#####################################################################
+#                                                                   #
+# /labscript_devices/DummyPseudoclock/__init__.py                   #
+#                                                                   #
+# Copyright 2017, Christopher Billington                            #
+#                                                                   #
+# This file is part of labscript_devices, in the labscript suite    #
+# (see http://labscriptsuite.org), and is licensed under the        #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+from __future__ import division, unicode_literals, print_function, absolute_import
+from labscript_utils import PY2
+if PY2:
+    str = unicode
+
+from labscript_devices import deprecated_import_alias
+
+
+# For backwards compatibility with old experiment scripts:
+DummyPseudoclock = deprecated_import_alias(
+    "labscript_devices.DummyPseudoclock.labscript_device.DummyPseudoclock"
+)

DummyPseudoclock/__init__.py

@@ -0,0 +1,44 @@
+#####################################################################
+#                                                                   #
+# /labscript_devices/DummyPseudoclock/blacs_tab.py                  #
+#                                                                   #
+# Copyright 2017, Christopher Billington                            #
+#                                                                   #
+# This file is part of labscript_devices, in the labscript suite    #
+# (see http://labscriptsuite.org), and is licensed under the        #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+from __future__ import division, unicode_literals, print_function, absolute_import
+from labscript_utils import PY2
+if PY2:
+    str = unicode
+from blacs.device_base_class import DeviceTab, define_state, MODE_BUFFERED
+
+class DummyPseudoclockTab(DeviceTab):
+    def initialise_workers(self):
+        worker_initialisation_kwargs = {}
+        self.create_worker(
+            "main_worker",
+            "labscript_devices.DummyPseudoclock.blacs_worker.DummyPseudoclockWorker",
+            worker_initialisation_kwargs,
+        )
+        self.primary_worker = "main_worker"
+
+    @define_state(MODE_BUFFERED, True)
+    def start_run(self, notify_queue):
+        self.wait_until_done(notify_queue)
+
+    @define_state(MODE_BUFFERED, True)
+    def wait_until_done(self, notify_queue):
+        """Call check_if_done repeatedly in the worker until the shot is complete"""
+        done = yield (self.queue_work(self.primary_worker, 'check_if_done'))
+        # Experiment is over. Tell the queue manager about it:
+        if done:
+            notify_queue.put('done')
+        else:
+            # Not actual recursion since this just queues up another call
+            # after we return:
+            self.wait_until_done(notify_queue)
+    

DummyPseudoclock/blacs_tab.py

@@ -0,0 +1,51 @@
+#####################################################################
+#                                                                   #
+# /labscript_devices/DummyPseudoclock/blacs_worker.py               #
+#                                                                   #
+# Copyright 2017, Christopher Billington                            #
+#                                                                   #
+# This file is part of labscript_devices, in the labscript suite    #
+# (see http://labscriptsuite.org), and is licensed under the        #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+from __future__ import division, unicode_literals, print_function, absolute_import
+from labscript_utils import PY2
+if PY2:
+    str = unicode
+import time
+import labscript_utils.h5_lock
+import h5py
+from blacs.tab_base_classes import Worker
+import labscript_utils.properties as properties
+
+class DummyPseudoclockWorker(Worker):
+    def program_manual(self, values):
+        return {}
+
+    def transition_to_buffered(self, device_name, h5file, initial_values, fresh):
+        # get stop time:
+        with h5py.File(h5file, 'r') as f:
+            props = properties.get(f, self.device_name, 'device_properties')
+            self.stop_time = props.get('stop_time', None) # stop_time may be absent if we are not the master pseudoclock
+        return {}
+    
+    def check_if_done(self):
+        # Wait up to 1 second for the shot to be done, returning True if it is
+        # or False if not.
+        if getattr(self, 'start_time', None) is None:
+            self.start_time = time.time()
+        timeout = min(self.start_time + self.stop_time - time.time(), 1)
+        if timeout < 0:
+            return True
+        time.sleep(timeout)
+        return self.start_time + self.stop_time < time.time()
+
+    def transition_to_manual(self):
+        self.start_time = None
+        self.stop_time = None
+        return True
+
+    def shutdown(self):
+        return

DummyPseudoclock/blacs_worker.py

@@ -0,0 +1,41 @@
+#####################################################################
+#                                                                   #
+# /labscript_devices/DummyPseudoclock/DummyPseudoclock.py           #
+#                                                                   #
+# Copyright 2017, Christopher Billington                            #
+#                                                                   #
+# This file is part of labscript_devices, in the labscript suite    #
+# (see http://labscriptsuite.org), and is licensed under the        #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+from __future__ import division, unicode_literals, print_function, absolute_import
+from labscript_utils import PY2
+if PY2:
+    str = unicode
+
+# This file represents a dummy labscript device for purposes of testing BLACS
+# and labscript. The device is a PseudoclockDevice, and can be the sole device
+# in a connection table or experiment.
+
+import labscript_utils.h5_lock
+import h5py
+from labscript import PseudoclockDevice, Pseudoclock, ClockLine
+
+
+class DummyPseudoclock(PseudoclockDevice):
+
+    description = 'Dummy pseudoclock'
+    clock_limit = 1e6
+    clock_resolution = 1e-6
+
+    def __init__(self, name='dummy_pseudoclock', BLACS_connection='dummy_connection', **kwargs):
+        self.BLACS_connection = BLACS_connection
+        PseudoclockDevice.__init__(self, name, None, None, **kwargs)
+        self.pseudoclock = Pseudoclock(self.name + '_pseudoclock', self, 'pseudoclock')
+        self.clockline = ClockLine(name='clockline', pseudoclock=self.pseudoclock, connection='dummy')
+
+    def generate_code(self, hdf5_file):
+        group = self.init_device_group(hdf5_file)
+        self.set_property('stop_time', self.stop_time, location='device_properties')

DummyPseudoclock/labscript_device.py

@@ -0,0 +1,19 @@
+#####################################################################
+#                                                                   #
+# /labscript_devices/DummyPseudoclock/register_classes.py           #
+#                                                                   #
+# Copyright 2017, Christopher Billington                            #
+#                                                                   #
+# This file is part of labscript_devices, in the labscript suite    #
+# (see http://labscriptsuite.org), and is licensed under the        #
+# Simplified BSD License. See the license.txt file in the root of   #
+# the project for the full license.                                 #
+#                                                                   #
+#####################################################################
+import labscript_devices
+
+labscript_devices.register_classes(
+    'DummyPseudoclock',
+    BLACS_tab='labscript_devices.DummyPseudoclock.blacs_tab.DummyPseudoclockTab',
+    runviewer_parser=None, #TODO make a runviwer parser for Dummy pseudoclock!
+)

DummyPseudoclock/register_classes.py

@@ -16,14 +16,14 @@
     str = unicode
 
 from labscript import LabscriptError, AnalogOut
-from labscript_devices import labscript_device, BLACS_tab, BLACS_worker, runviewer_parser
+from labscript_devices import BLACS_tab, runviewer_parser
 import labscript_devices.NIBoard as parent
 
 import numpy as np
 import labscript_utils.h5_lock, h5py
 import labscript_utils.properties
 
-@labscript_device
+
 class NI_PCI_6733(parent.NIBoard):
     description = 'NI-PCI-6733'
     n_analogs = 8
@@ -109,9 +109,8 @@ def do_sort(channel):
         # Set the capabilities of this device
         self.supports_remote_value_check(False)
         self.supports_smart_programming(False) 
-    
-    
-@BLACS_worker
+
+
 class NiPCI6733Worker(Worker):
     def init(self):
         exec('from PyDAQmx import Task', globals())

NI_PCI_6733.py

@@ -16,7 +16,7 @@
     str = unicode
 
 from labscript import LabscriptError
-from labscript_devices import labscript_device, BLACS_tab, BLACS_worker, runviewer_parser
+from labscript_devices import BLACS_tab, runviewer_parser
 import labscript_devices.NIBoard as parent
 from labscript_utils.numpy_dtype_workaround import dtype_workaround
 
@@ -26,7 +26,6 @@
 from labscript_utils.connections import _ensure_str
 
 
-@labscript_device
 class NI_PCIe_6363(parent.NIBoard):
     description = 'NI-PCIe-6363'
     n_analogs = 4
@@ -111,8 +110,8 @@ def pfi_sort(channel):
         # Set the capabilities of this device
         self.supports_remote_value_check(False)
         self.supports_smart_programming(False) 
-    
-@BLACS_worker
+
+
 class NiPCIe6363Worker(Worker):
     def init(self):
         exec('from PyDAQmx import Task, DAQmxGetSysNIDAQMajorVersion, DAQmxGetSysNIDAQMinorVersion, DAQmxGetSysNIDAQUpdateVersion, DAQmxResetDevice', globals())