improve instrument behaviour

env_functions.py
 - add function to find instrument from directory

config.py
 - get_config now replaces user values to beamline defaults when changing beamline

cli.py
 - added check for beamline in given directory

title_window.py
 - added time logging

Author: DanPorter

mmg_toolbox/tkguis/cli.py

@@ -5,7 +5,7 @@
 import sys
 import os
 
-from mmg_toolbox.utils.env_functions import get_beamline
+from mmg_toolbox.utils.env_functions import get_beamline, get_beamline_from_directory
 from .misc.config import BEAMLINE_CONFIG, get_config
 from .apps.experiment import create_title_window
 from .apps.data_viewer import create_data_viewer
@@ -26,13 +26,16 @@ def run(*args):
         return
 
     beamline = next((bm for bm in BEAMLINE_CONFIG if bm in args), get_beamline())
-    config = get_config(beamline=beamline)
 
     for n, arg in enumerate(args):
         if os.path.isdir(arg):
+            beamline = get_beamline_from_directory(os.path.abspath(arg), beamline)
+            config = get_config(beamline=beamline)
             create_data_viewer(arg, config=config)
             return
         elif os.path.isfile(arg):
+            beamline = get_beamline_from_directory(os.path.abspath(arg), beamline)
+            config = get_config(beamline=beamline)
             create_nexus_viewer(arg, config=config)
             return
     create_title_window(beamline)

mmg_toolbox/tkguis/misc/config.py

@@ -155,13 +155,15 @@ def check_config_filename(config_filename: str | None) -> str:
 
 
 def load_config(config_filename: str = CONFIG_FILE) -> dict:
+    """Loads a config dict from file, by default from the default location"""
     if os.path.isfile(config_filename):
         with open(config_filename, 'r') as f:
             return json.load(f)
     return {}
 
 
 def default_config(beamline: str | None = None) -> dict:
+    """Returns the default beamline config dict"""
     config = CONFIG.copy()
     if beamline is None:
         beamline = get_beamline()
@@ -171,9 +173,14 @@ def default_config(beamline: str | None = None) -> dict:
 
 
 def get_config(config_filename: str | None = None, beamline: str | None = None) -> dict:
+    """merge loaded config into default beamline config and return the config dict"""
     config_filename = check_config_filename(config_filename)
     user_config = load_config(config_filename)
     config = default_config(beamline)
+    if beamline and user_config.get(C.beamline) and beamline != user_config.get(C.beamline):
+        # default config overrides user config when changing beamline
+        user_config.update(config)
+        return user_config
     config.update(user_config)
     return config
 
@@ -186,13 +193,15 @@ def reset_config(config: dict) -> None:
 
 
 def save_config(config: dict):
+    """Save the config dict into the file location referenced in config['config_file']"""
     config_filename = config.get(C.conf_file, CONFIG_FILE)
     with open(config_filename, 'w') as f:
         json.dump(config, f)
     print('Saved config to {}'.format(config_filename))
 
 
 def save_config_as(config_filename: str | None = None, **kwargs):
+    """Save the config dict into a new file location"""
     config = get_config(config_filename)
     config.update(kwargs)
     config[C.conf_file] = config_filename

mmg_toolbox/tkguis/misc/styles.py

@@ -70,6 +70,7 @@ class RootWithStyle(tk.Tk):
 
 def create_root(window_title: str, parent: tk.Misc | RootWithStyle | None = None) -> RootWithStyle:
     """Create tkinter root object with style attribute"""
+    # TODO: this is the slow part of the startup, investigate further.
     if parent:
         root = tk.Toplevel(parent)
         # root.geometry(f"+{parent.winfo_x()+100}+{parent.winfo_y()+100}")

mmg_toolbox/tkguis/widgets/title_window.py

@@ -4,6 +4,8 @@
 import os
 import tkinter as tk
 from tkinter import ttk
+from time import time
+from threading import Thread
 
 from mmg_toolbox.utils.env_functions import get_dls_visits, MMG_BEAMLINES
 from mmg_toolbox.utils.file_functions import folder_summary_line
@@ -16,6 +18,7 @@
 
 class TitleWindow:
     def __init__(self, root: tk.Misc, config: dict | None = None):
+        t0 = time()
         self.root = root
         self.config = config or get_config()
 
@@ -66,11 +69,15 @@ def __init__(self, root: tk.Misc, config: dict | None = None):
         ttk.Button(frm, text='Log Viewer', command=self.open_log_viewer, width=20).pack(side=tk.LEFT)
         ttk.Button(frm, text='Notebook Browser', command=self.open_notebook_browser, width=20).pack(side=tk.LEFT)
         ttk.Button(frm, text='Processing', command=self.open_script_runner, width=20).pack(side=tk.LEFT)
-
-        self.choose_beamline(self.config.get(C.beamline, 'i16'))
+        t1 = time()
+        logger.info(f"init time: {t1-t0}s")
+        # run file-system functions in a thread to speed up the start time
+        th = Thread(target=lambda: self.choose_beamline(self.config.get(C.beamline, 'i16')))
+        th.start()
 
     def choose_beamline(self, beamline: str):
         from ..misc.config import BEAMLINE_CONFIG
+        t0 = time()
         bl_config = BEAMLINE_CONFIG[beamline].copy()
         self.config.update(bl_config)
         self.beamline.set('MMG Toolbox: ' + beamline)
@@ -79,6 +86,8 @@ def choose_beamline(self, beamline: str):
         current_visit = next(iter(self.visits.keys()))
         self.visit_menu.set_menu(current_visit, *self.visits)
         self.visit.set(current_visit)
+        t1 = time()
+        logger.info(f"choose_beamline time: {t1-t0}s")
         self.dls_directories(self.visits[current_visit])
 
     def menu_items(self):
@@ -95,6 +104,7 @@ def menu_items(self):
         return menu
 
     def dls_directories(self, data_dir: str):
+        t0 = time()
         if not os.access(data_dir, os.R_OK):
             show_error(f"Warning path is not readable: '{data_dir}'", self.root, raise_exception=False)
         self.summary.set(folder_summary_line(data_dir))
@@ -105,6 +115,8 @@ def dls_directories(self, data_dir: str):
             self.proc_dir.set(proc_dir)
         if os.path.isdir(notebook_dir) and os.access(notebook_dir, os.R_OK):
             self.notebook_dir.set(notebook_dir)
+        t1 = time()
+        logger.info(f"dls_directories time: {t1-t0}s")
 
     def update_config(self):
         save_config(self.config)

mmg_toolbox/utils/env_functions.py

@@ -2,9 +2,10 @@
 Environment functions
 """
 
+import sys
 import os
+import re
 import subprocess
-import sys
 import tempfile
 from datetime import datetime
 
@@ -57,6 +58,14 @@ def get_beamline(default=''):
     return os.environ.get(BEAMLINE, default)
 
 
+def get_beamline_from_directory(directory: str, default: str = ''):
+    """Return current beamline from given directory"""
+    beamlines = re.findall('/([a-zA-Z][0-9]{2}-?[1-9]?)', directory)
+    if beamlines:
+        return beamlines[0]
+    return default
+
+
 def get_user(default=''):
     """Return current user from environment variable"""
     return next((os.environ[u] for u in USER if u in os.environ), default)

start_dataviewer.py

@@ -6,8 +6,11 @@
 
 # start_gui('/dls/science/groups/das/ExampleData/i16/azimuths/1108750.nxs')
 # start_gui('/dls/science/groups/das/ExampleData/i16/azimuths')
+# start_gui('/dls/b07/data/2025/cm40617-5')
 start_gui()
 
 # from mmg_toolbox.tkguis.apps.nexus import create_nexus_plot_and_image
 # create_nexus_plot_and_image('/dls/science/groups/das/ExampleData/i16/azimuths/1108750.nxs')
 # create_nexus_plot_and_image('/dls/i16/data/2025/nt43883-1/1113041.nxs')
+
+