- Added dialog to allow users to change the path of the data and tasks dir which is accessed from new settings menu. User path settings are saved as a json object in 'config/user_paths.json' which is not version controlled.

- All folder paths are now stored in a single 'dirs' dictionary defined in config.paths rather than as seperate variables (e.g. task_dir, data_dir).

Author: ThomasAkam

config/paths.py

@@ -1,12 +1,29 @@
 import os
+import json
+
+# Default paths.
 
 top_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # Top level pyControl folder.
 
-config_dir      = os.path.join(top_dir, 'config')
-framework_dir   = os.path.join(top_dir, 'pyControl')
-devices_dir     = os.path.join(top_dir, 'devices')
-tasks_dir       = os.path.join(top_dir, 'tasks')
-experiments_dir = os.path.join(top_dir, 'experiments')
-data_dir        = os.path.join(top_dir, 'data')
-transfer_dir    = None # Folder to copy data to at end of run experiment.
+dirs = {
+        'config'      : os.path.join(top_dir, 'config'),
+        'framework'   : os.path.join(top_dir, 'pyControl'),
+        'devices'     : os.path.join(top_dir, 'devices'),
+        'tasks'       : os.path.join(top_dir, 'tasks'), 
+        'experiments' : os.path.join(top_dir, 'experiments'),
+        'data'        : os.path.join(top_dir, 'data')
+        }
+
+# User paths - When paths.py is imported on opening GUI, load any 
+# saved user paths and update the dirs dict.
+
+def update_paths(user_paths):    
+    for name, path in user_paths.items():
+        if os.path.exists(path):
+            dirs[name] = path
 
+json_path = os.path.join(dirs['config'], 'user_paths.json')
+if os.path.exists(json_path):
+    with open(json_path,'r') as f:
+        user_paths = json.loads(f.read())
+        update_paths(user_paths)

gui/GUI_main.py

@@ -5,10 +5,10 @@
 from serial.tools import list_ports
 from pyqtgraph.Qt import QtGui, QtCore
 
-from config.paths import tasks_dir, experiments_dir, data_dir
+from config.paths import dirs
 from config.gui_settings import  VERSION
 from gui.run_task_tab import Run_task_tab
-from gui.dialogs import Board_config_dialog, Keyboard_shortcuts_dialog
+from gui.dialogs import Board_config_dialog, Keyboard_shortcuts_dialog, Paths_dialog
 from gui.configure_experiment_tab import Configure_experiment_tab
 from gui.run_experiment_tab import Run_experiment_tab
 from gui.setups_tab import Setups_tab
@@ -32,13 +32,15 @@ def __init__(self):
         self.available_tasks_changed = False
         self.available_experiments_changed = False
         self.available_ports_changed = False
+        self.data_dir_changed = False
         self.current_tab_ind = 0 # Which tab is currently selected.
         self.app = None # Overwritten with QtGui.QApplication instance in main.
 
         # Dialogs.
 
         self.config_dialog = Board_config_dialog(parent=self)
         self.shortcuts_dialog = Keyboard_shortcuts_dialog(parent=self)
+        self.paths_dialog = Paths_dialog(parent=self)
 
         # Widgets.
         self.tab_widget = QtGui.QTabWidget(self)
@@ -77,12 +79,18 @@ def __init__(self):
         data_action = QtGui.QAction("&Data", self)
         data_action.setShortcut("Ctrl+D")
         data_action.triggered.connect(self.go_to_data)
-        # View Task Directory
         folders_menu.addAction(data_action)
+        # View Task Directory
         task_action = QtGui.QAction("&Tasks", self)
         task_action.setShortcut("Ctrl+T")
         task_action.triggered.connect(self.go_to_tasks)
         folders_menu.addAction(task_action)
+        ## --------Settings menu--------
+        settings_menu = main_menu.addMenu('Settings')
+        # Folder paths
+        paths_action = QtGui.QAction("&Folder paths", self)
+        paths_action.triggered.connect(self.paths_dialog.exec)
+        settings_menu.addAction(paths_action)
         # ---------Help menu----------
         help_menu= main_menu.addMenu('Help')
         # Go to readthedocs
@@ -105,10 +113,10 @@ def __init__(self):
         self.show()
 
     def go_to_data(self):
-        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(data_dir))
+        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(dirs['data']))
 
     def go_to_tasks(self):
-        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(tasks_dir))
+        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(dirs['tasks']))
 
     def view_docs(self):
         QtGui.QDesktopServices.openUrl(QtCore.QUrl("https://pycontrol.readthedocs.io/en/latest/"))
@@ -122,12 +130,12 @@ def view_github(self):
     def refresh(self):
         '''Called regularly when framework not running.'''
         # Scan task folder.
-        tasks =  [t.split('.')[0] for t in os.listdir(tasks_dir) if t[-3:] == '.py']
+        tasks = [t.split('.')[0] for t in os.listdir(dirs['tasks']) if t[-3:] == '.py']
         self.available_tasks_changed = tasks != self.available_tasks
         if self.available_tasks_changed:    
             self.available_tasks = tasks
         # Scan experiments folder.
-        experiments = [t.split('.')[0] for t in os.listdir(experiments_dir) if t[-4:] == '.pcx']
+        experiments = [t.split('.')[0] for t in os.listdir(dirs['experiments']) if t[-4:] == '.pcx']
         self.available_experiments_changed = experiments != self.available_experiments
         if self.available_experiments_changed:    
             self.available_experiments = experiments
@@ -141,6 +149,8 @@ def refresh(self):
         self.run_task_tab.refresh()
         self.configure_experiment_tab.refresh()
         self.setups_tab.refresh()
+        # Clear flags.
+        self.data_dir_changed = False
 
     def tab_changed(self, new_tab_ind):
         '''Called whenever the active tab is changed.'''

gui/configure_experiment_tab.py

@@ -3,7 +3,7 @@
 import json
 from pyqtgraph.Qt import QtGui, QtCore
 
-from config.paths import data_dir, tasks_dir, experiments_dir
+from config.paths import dirs
 from gui.dialogs import invalid_experiment_dialog
 from gui.utility import TableCheckbox, cbox_update_options, cbox_set_item, null_resize, variable_constants, init_keyboard_shortcuts
 
@@ -20,7 +20,7 @@ def __init__(self, parent=None):
 
         # Variables
         self.GUI_main = self.parent()
-        self.custom_dir = False # True if data_dir field has been manually edited.
+        self.custom_dir = False    # True if data_dir field has been manually edited.
         self.saved_exp_path = None # Path of last saved/loaded experiment file.
         self.saved_exp_dict = {}   # Dict of last saved/loaded experiment.
 
@@ -50,7 +50,7 @@ def __init__(self, parent=None):
         self.hardware_test_select = QtGui.QComboBox()
         self.hardware_test_select.setFixedWidth(150)
         self.data_dir_label = QtGui.QLabel('Data dir:')
-        self.data_dir_text = QtGui.QLineEdit(data_dir)
+        self.data_dir_text = QtGui.QLineEdit(dirs['data'])
         self.data_dir_button = QtGui.QPushButton('...')
         self.data_dir_button.setFixedWidth(30)
 
@@ -115,12 +115,13 @@ def __init__(self, parent=None):
 
     def name_edited(self):
         if not self.custom_dir:
-            self.data_dir_text.setText(os.path.join(data_dir, self.name_text.text()))
+            self.data_dir_text.setText(os.path.join(dirs['data'], self.name_text.text()))
 
     def select_data_dir(self):
-        self.data_dir_text.setText(
-            QtGui.QFileDialog.getExistingDirectory(self, 'Select data folder', data_dir))
-        self.custom_dir = True
+        new_path = QtGui.QFileDialog.getExistingDirectory(self, 'Select data folder', dirs['data'])
+        if new_path:
+            self.data_dir_text.setText(new_path)
+            self.custom_dir = True
 
     def experiment_changed(self, experiment_name):
         if experiment_name in self.GUI_main.available_experiments:
@@ -143,6 +144,11 @@ def refresh(self):
             self.subjects_table.update_available_setups()
         if self.saved_exp_dict != self.experiment_dict():
             self.save_button.setEnabled(True)
+        else:
+            self.save_button.setEnabled(False)
+        if self.GUI_main.data_dir_changed:
+            if (str(self.name_text.text()) == '') and not self.custom_dir:
+                self.data_dir_text.setText(dirs['data'])
 
     def experiment_dict(self):
         '''Return the current state of the experiments tab as a dictionary.'''
@@ -158,7 +164,7 @@ def new_experiment(self, dialog=True):
         if dialog:
             if not self.save_dialog(): return
         self.name_text.setText('')
-        self.data_dir_text.setText(data_dir)
+        self.data_dir_text.setText(dirs['data'])
         self.custom_dir = False
         self.subjects_table.reset()
         self.variables_table.reset()
@@ -170,7 +176,7 @@ def new_experiment(self, dialog=True):
 
     def delete_experiment(self):
         '''Delete an experiment file after dialog to confirm deletion.'''
-        exp_path = os.path.join(experiments_dir, self.name_text.text()+'.pcx')
+        exp_path = os.path.join(dirs['experiments'], self.name_text.text()+'.pcx')
         if os.path.exists(exp_path):
             reply = QtGui.QMessageBox.question(self, 'Delete experiment', 
                 "Delete experiment '{}'".format(self.name_text.text()),
@@ -184,7 +190,7 @@ def save_experiment(self, from_dialog=False):
         saved in the experiments folder as .pcx file.'''
         experiment = self.experiment_dict()
         file_name = self.name_text.text()+'.pcx'
-        exp_path = os.path.join(experiments_dir, file_name)
+        exp_path = os.path.join(dirs['experiments'], file_name)
         if os.path.exists(exp_path) and (exp_path != self.saved_exp_path):
             reply = QtGui.QMessageBox.question(self, 'Replace file', 
                 "File '{}' already exists, do you want to replace it?".format(file_name),
@@ -201,7 +207,7 @@ def save_experiment(self, from_dialog=False):
 
     def load_experiment(self, experiment_name):
         '''Load experiment  .pcx file and set fields of experiment tab.'''
-        exp_path = os.path.join(experiments_dir, experiment_name +'.pcx')
+        exp_path = os.path.join(dirs['experiments'], experiment_name +'.pcx')
         with open(exp_path,'r') as exp_file:
             experiment = json.loads(exp_file.read())
         self.name_text.setText(experiment['name'])
@@ -275,7 +281,7 @@ def save_dialog(self):
         cancel is selected, True otherwise.'''
         if self.saved_exp_dict == self.experiment_dict():
             return True # Experiment has not been edited.  
-        exp_path = os.path.join(experiments_dir, self.name_text.text()+'.pcx')
+        exp_path = os.path.join(dirs['experiments'], self.name_text.text()+'.pcx')
         dialog_text = None
         if not os.path.exists(exp_path):
             dialog_text = 'Experiment not saved, save experiment?'
@@ -513,7 +519,7 @@ def task_changed(self, task):
         '''Remove variables that are not defined in the new task.'''
         pattern = "[\n\r]v\.(?P<vname>\w+)\s*\="
         try:
-            with open(os.path.join(tasks_dir, task+'.py'), "r") as file:
+            with open(os.path.join(dirs['tasks'], task+'.py'), "r") as file:
                 file_content = file.read()
         except FileNotFoundError:
             return

gui/dialogs.py

@@ -1,8 +1,9 @@
 import os
+import json
 
 from pyqtgraph.Qt import QtGui, QtCore
 
-from config.paths import config_dir
+from config.paths import dirs, update_paths
 from gui.utility import variable_constants
 
 # Board_config_dialog -------------------------------------------------
@@ -44,7 +45,7 @@ def load_framework(self):
 
     def load_hardware_definition(self):
         hwd_path = QtGui.QFileDialog.getOpenFileName(self, 'Select hardware definition:',
-                    os.path.join(config_dir, 'hardware_definition.py'), filter='*.py')[0]
+                    os.path.join(dirs['config'], 'hardware_definition.py'), filter='*.py')[0]
         self.accept()
         self.board.load_hardware_definition(hwd_path)
 
@@ -231,4 +232,70 @@ def __init__(self, parent):
             label.setFont(QtGui.QFont('Helvetica', 10))
             self.Vlayout.addWidget(label)
 
-        self.setFixedSize(self.sizeHint())
+        self.setFixedSize(self.sizeHint())
+
+# Paths dialog. ---------------------------------------------------------
+
+class Path_setter():
+    def __init__(self, name, path, edited, dialog):
+        self.name = name
+        self.path = os.path.normpath(path)
+        self.edited = edited
+        self.dialog = dialog
+        # Instantiate widgets
+        self.name_label = QtGui.QLabel(name +' folder:')
+        self.path_text = QtGui.QLineEdit(self.path)
+        self.path_text.setReadOnly(True)
+        self.path_text.setFixedWidth(400)
+        self.change_button = QtGui.QPushButton('Change')
+        self.change_button.clicked.connect(self.select_path)
+        # Layout
+        self.hlayout = QtGui.QHBoxLayout()
+        self.hlayout.addWidget(self.name_label)
+        self.hlayout.addWidget(self.path_text)
+        self.hlayout.addWidget(self.change_button)
+        self.dialog.Vlayout.addLayout(self.hlayout)
+
+        self.dialog.setters.append(self)
+
+    def select_path(self):
+        new_path = QtGui.QFileDialog.getExistingDirectory(
+            self.dialog, 'Select {} folder'.format(self.name), self.path)
+        if new_path:
+            new_path = os.path.normpath(new_path)
+            if new_path != self.path:
+                self.path = new_path
+                self.edited = True
+                self.path_text.setText(new_path)
+
+class Paths_dialog(QtGui.QDialog):
+    '''Dialog for displaying information about keyboard shortcuts.'''
+    def __init__(self, parent):
+        super(QtGui.QDialog, self).__init__(parent)
+        self.setWindowTitle('Paths')
+
+        self.Vlayout = QtGui.QVBoxLayout(self)
+        self.setters = []
+
+        # Instantiate setters
+        self.tasks_setter = Path_setter('tasks', dirs['tasks'], False, self)
+        self.data_setter  = Path_setter('data' , dirs['data'] , False, self)
+
+        self.setFixedSize(self.sizeHint())
+
+    def closeEvent(self, event):
+        '''Save any user edited paths as json in config folder.'''
+        edited_paths = {s.name: s.path for s in self.setters if s.edited}
+        if edited_paths:
+            # Store newly edited paths.
+            json_path = os.path.join(dirs['config'],'user_paths.json')
+            if os.path.exists(json_path):
+                with open(json_path,'r') as f:
+                    user_paths = json.loads(f.read())
+            else:
+                user_paths = {}
+            user_paths.update(edited_paths)
+            with open(json_path, 'w') as f:
+                f.write(json.dumps(user_paths))
+            self.parent().data_dir_changed = True
+            update_paths(user_paths)

gui/run_experiment_tab.py

@@ -8,7 +8,7 @@
 from serial import SerialException
 
 from config.gui_settings import  update_interval
-from config.paths import tasks_dir
+from config.paths import dirs
 from com.pycboard import Pycboard, PyboardError
 from com.data_logger import Data_logger
 from gui.plotting import Experiment_plot
@@ -187,7 +187,7 @@ def setup_experiment(self, experiment):
                     self.abort_experiment()
                     return
         # Copy task file to experiments data folder.
-        self.boards[0].data_logger.copy_task_file(self.experiment['data_dir'], tasks_dir)
+        self.boards[0].data_logger.copy_task_file(self.experiment['data_dir'], dirs['tasks'])
         # Configure GUI ready to run.
         for i, board in enumerate(self.boards):
             self.subjectboxes[i].assign_board(board)