Configure labscript-profile-create to compile the default connection table.

This will allow BLACS to run immediately using dummy devices,
without manual compilation required from the user.

Co-authored-by: NMFolks <[email protected]>

Author: dihm

labscript_profile/create.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 from subprocess import check_output
 from labscript_profile import LABSCRIPT_SUITE_PROFILE, default_labconfig_path
+import argparse
 
 _here = os.path.dirname(os.path.abspath(__file__))
 DEFAULT_PROFILE_CONTENTS = os.path.join(_here, 'default_profile')
@@ -21,7 +22,8 @@ def make_shared_secret(directory):
     raise RuntimeError("Could not parse output of zprocess.makesecret")
 
 
-def make_labconfig_file():
+def make_labconfig_file(apparatus_name):
+
     source_path = os.path.join(LABSCRIPT_SUITE_PROFILE, 'labconfig', 'example.ini')
     target_path = default_labconfig_path()
     if os.path.exists(target_path):
@@ -47,16 +49,58 @@ def make_labconfig_file():
         '%(labscript_suite)s', shared_secret.relative_to(LABSCRIPT_SUITE_PROFILE)
     )
     config.set('security', 'shared_secret', str(shared_secret_entry))
+    if apparatus_name is not None:
+        config.set('DEFAULT', 'apparatus_name', apparatus_name)
 
     with open(target_path, 'w') as f:
         config.write(f)
 
+def compile_connection_table():
+
+    try:
+        import runmanager
+    except ImportError:
+        # if runmanager doesn't import, skip compilation
+        return
+
+    config = configparser.ConfigParser(defaults = {'labscript_suite': str(LABSCRIPT_SUITE_PROFILE)})
+    config.read(default_labconfig_path())
+
+    # The path to the user's connection_table.py script
+    script_path = config['paths']['connection_table_py']
+    # path to the connection_table.h5 destination
+    output_h5_path = config['paths']['connection_table_h5']
+    # create output directory, if needed
+    Path(output_h5_path).parent.mkdir(parents=True, exist_ok=True)
+    # compile the h5 file
+    runmanager.new_globals_file(output_h5_path)
+
+    def dummy_callback(success):
+        pass
+
+    runmanager.compile_labscript_async(labscript_file = script_path,
+                                       run_file = output_h5_path,
+                                       stream_port = None,
+                                       done_callback = dummy_callback)
 
 def create_profile():
+
+    # capture CMD arguments
+    parser = argparse.ArgumentParser(prog='labscript-profile-create',
+                                     description='Initialises a default labscript profile'
+                                     )
+
+    parser.add_argument('-n', '--apparatus_name',
+                        type = str,
+                        help = 'Sets the apparatus_name in the labconfig file. Defaults to example_apparatus',
+                        )
+    
+    args = parser.parse_args()
+
     src = Path(DEFAULT_PROFILE_CONTENTS)
     dest = Path(LABSCRIPT_SUITE_PROFILE)
     # Profile directory may exist already, but we will error if it contains any of the
-    # files or directories we want to copy into it:
+    # sub-directories we want to copy into it:
     os.makedirs(dest, exist_ok=True)
     # Preferable to raise errors if anything exists before copying anything, rather than
     # do a partial copy before hitting an error:
@@ -71,4 +115,13 @@ def create_profile():
         else:
             shutil.copy2(src_file, dest_file)
 
-    make_labconfig_file()
+    make_labconfig_file(args.apparatus_name)
+        
+    # rename apparatus directories
+    if args.apparatus_name is not None:
+        for path in dest.glob('**/example_apparatus/'):
+            new_path = Path(str(path).replace('example_apparatus', args.apparatus_name))
+            path.rename(new_path)
+
+    # compile the initial example connection table
+    compile_connection_table()