Merge branch 'import_export_config'

Author: Ezetowers

MLC/GUI/Autogenerated/autogenerated.py

@@ -362,7 +362,7 @@ class Ui_ExperimentWindow(object):
     def setupUi(self, ExperimentWindow):
         ExperimentWindow.setObjectName("ExperimentWindow")
         ExperimentWindow.setWindowModality(QtCore.Qt.ApplicationModal)
-        ExperimentWindow.resize(961, 552)
+        ExperimentWindow.resize(961, 568)
         self.centralWidget = QtWidgets.QWidget(ExperimentWindow)
         self.centralWidget.setObjectName("centralWidget")
         self.horizontalLayout = QtWidgets.QHBoxLayout(self.centralWidget)
@@ -666,17 +666,20 @@ def setupUi(self, ExperimentWindow):
         self.frame_2.setFrameShape(QtWidgets.QFrame.StyledPanel)
         self.frame_2.setFrameShadow(QtWidgets.QFrame.Raised)
         self.frame_2.setObjectName("frame_2")
-        self.horizontalLayout_7 = QtWidgets.QHBoxLayout(self.frame_2)
-        self.horizontalLayout_7.setObjectName("horizontalLayout_7")
+        self.gridLayout_7 = QtWidgets.QGridLayout(self.frame_2)
+        self.gridLayout_7.setObjectName("gridLayout_7")
         self.import_config_button = QtWidgets.QPushButton(self.frame_2)
         self.import_config_button.setObjectName("import_config_button")
-        self.horizontalLayout_7.addWidget(self.import_config_button)
+        self.gridLayout_7.addWidget(self.import_config_button, 0, 0, 1, 1)
         self.export_config_button = QtWidgets.QPushButton(self.frame_2)
         self.export_config_button.setObjectName("export_config_button")
-        self.horizontalLayout_7.addWidget(self.export_config_button)
+        self.gridLayout_7.addWidget(self.export_config_button, 0, 1, 1, 1)
         self.save_config_button = QtWidgets.QPushButton(self.frame_2)
         self.save_config_button.setObjectName("save_config_button")
-        self.horizontalLayout_7.addWidget(self.save_config_button)
+        self.gridLayout_7.addWidget(self.save_config_button, 1, 0, 1, 1)
+        self.edit_config_button = QtWidgets.QPushButton(self.frame_2)
+        self.edit_config_button.setObjectName("edit_config_button")
+        self.gridLayout_7.addWidget(self.edit_config_button, 1, 1, 1, 1)
         self.verticalLayout_2.addWidget(self.frame_2)
         self.verticalLayout.addWidget(self.frame)
         self.tabWidget.addTab(self.config_tab, "")
@@ -709,6 +712,9 @@ def setupUi(self, ExperimentWindow):
         self.best_indiv_button.clicked.connect(ExperimentWindow.on_best_indiv_button_clicked)
         self.convergence_button.clicked.connect(ExperimentWindow.on_convergence_button_clicked)
         self.board_config_button.clicked.connect(ExperimentWindow.on_board_config_button_clicked)
+        self.edit_config_button.clicked.connect(ExperimentWindow.on_edit_config_button_clicked)
+        self.import_config_button.clicked.connect(ExperimentWindow.on_import_config_button_clicked)
+        self.export_config_button.clicked.connect(ExperimentWindow.on_export_config_button_clicked)
         # QtCore.QMetaObject.connectSlotsByName(ExperimentWindow)
 
     def retranslateUi(self, ExperimentWindow):
@@ -760,6 +766,7 @@ def retranslateUi(self, ExperimentWindow):
         self.import_config_button.setText(_translate("ExperimentWindow", "Import"))
         self.export_config_button.setText(_translate("ExperimentWindow", "Export"))
         self.save_config_button.setText(_translate("ExperimentWindow", "Save"))
+        self.edit_config_button.setText(_translate("ExperimentWindow", "Edit"))
         self.tabWidget.setTabText(self.tabWidget.indexOf(self.config_tab), _translate("ExperimentWindow", "Configuration"))
 
 # -*- coding: utf-8 -*-

MLC/GUI/Autogenerated/mlc_qtcreator/experiment.ui

@@ -10,7 +10,7 @@
     <x>0</x>
     <y>0</y>
     <width>961</width>
-    <height>552</height>
+    <height>568</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -591,28 +591,35 @@
              <property name="frameShadow">
               <enum>QFrame::Raised</enum>
              </property>
-             <layout class="QHBoxLayout" name="horizontalLayout_7">
-              <item>
+             <layout class="QGridLayout" name="gridLayout_7">
+              <item row="0" column="0">
                <widget class="QPushButton" name="import_config_button">
                 <property name="text">
                  <string>Import</string>
                 </property>
                </widget>
               </item>
-              <item>
+              <item row="0" column="1">
                <widget class="QPushButton" name="export_config_button">
                 <property name="text">
                  <string>Export</string>
                 </property>
                </widget>
               </item>
-              <item>
+              <item row="1" column="0">
                <widget class="QPushButton" name="save_config_button">
                 <property name="text">
                  <string>Save</string>
                 </property>
                </widget>
               </item>
+              <item row="1" column="1">
+               <widget class="QPushButton" name="edit_config_button">
+                <property name="text">
+                 <string>Edit</string>
+                </property>
+               </widget>
+              </item>
              </layout>
             </widget>
            </item>
@@ -1012,6 +1019,54 @@
     </hint>
    </hints>
   </connection>
+  <connection>
+   <sender>edit_config_button</sender>
+   <signal>clicked()</signal>
+   <receiver>ExperimentWindow</receiver>
+   <slot>on_edit_config_button_clicked()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>702</x>
+     <y>517</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>480</x>
+     <y>283</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>import_config_button</sender>
+   <signal>clicked()</signal>
+   <receiver>ExperimentWindow</receiver>
+   <slot>on_import_config_button_clicked()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>258</x>
+     <y>489</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>480</x>
+     <y>283</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>export_config_button</sender>
+   <signal>clicked()</signal>
+   <receiver>ExperimentWindow</receiver>
+   <slot>on_export_config_button_clicked()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>702</x>
+     <y>489</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>480</x>
+     <y>283</y>
+    </hint>
+   </hints>
+  </connection>
  </connections>
  <slots>
   <slot>on_closed_dialog()</slot>
@@ -1035,5 +1090,6 @@
   <slot>on_convergence_button_clicked()</slot>
   <slot>on_genealogy_button_clicked()</slot>
   <slot>on_board_config_button_clicked()</slot>
+  <slot>on_edit_config_button_clicked()</slot>
  </slots>
 </ui>

MLC/GUI/Experiment/ExperimentWindow.py

@@ -2,9 +2,9 @@
 
 import os
 import numpy as np
+import shutil
 import sys
 import time
-sys.path.append(os.path.abspath(".") + "/../..")
 
 from MLC.Log.log import get_gui_logger
 from MLC.GUI.Autogenerated.autogenerated import Ui_ExperimentWindow
@@ -21,10 +21,13 @@
 from MLC.Population.Evaluation.EvaluatorFactory import EvaluatorFactory
 from MLC.Population.Population import Population
 from PyQt5.QtCore import pyqtSignal
+from PyQt5.QtCore import QFileSystemWatcher
+# from PyQt5.QtCore import QHeaderView
 from PyQt5.QtCore import Qt
 from PyQt5.QtCore import QUrl
 from PyQt5.QtGui import QDesktopServices
 from PyQt5.QtWidgets import QAbstractItemView
+from PyQt5.QtWidgets import QFileDialog
 from PyQt5.QtWidgets import QMainWindow
 from PyQt5.QtWidgets import QMessageBox
 from PyQt5.QtWidgets import QInputDialog
@@ -73,6 +76,16 @@ def __init__(self, mlc_local,
         # Signal to be emitted when the experiment is closed
         self._experiment_closed_signal = experiment_closed_signal
 
+        # Watch changes in the experiment config file
+        self._file_watcher = QFileSystemWatcher()
+        conf_path_list = [self._mlc_local.get_working_dir(),
+                          self._experiment_name,
+                          self._experiment_name + ".conf"]
+        # Use the splat operator to dearrange the list
+        self._experiment_conf_path = os.path.join(*conf_path_list)
+        self._file_watcher.addPath(self._experiment_conf_path)
+        self._file_watcher.fileChanged.connect(self._reload_experiment_config)
+
         # Experiment in progress chart configuration
         self._chart_conf = ChartConfiguration(self._autogenerated_object)
         indivs_per_gen = Config.get_instance().getint("POPULATION", "size")
@@ -83,6 +96,7 @@ def closeEvent(self, event):
         logger.debug('[EXPERIMENT {0}] [CLOSE_DIALOG] - Executing overriden closeEvent function'.format(self._experiment_name))
         self._ask_if_experiment_config_must_be_saved()
         # Close the experiment
+        self._file_watcher.removePath(self._experiment_conf_path)
         self._mlc_local.close_experiment(self._experiment_name)
         self._experiment_closed_signal.emit(self._experiment_name)
 
@@ -204,7 +218,12 @@ def on_dimension_check_clicked(self):
     def on_save_config_button_clicked(self):
         logger.debug('[EXPERIMENT {0}] [SAVE_CONFIG_BUTTON_CLICKED] - Executing on_save_config_button_clicked function'
                      .format(self._experiment_name))
+
+        # Remove the config file from the Qt File watcher momentarily
+        # to avoid rendering unnecesary warnings
+        self._file_watcher.removePath(self._experiment_conf_path)
         self._persist_experiment_config()
+        self._file_watcher.addPath(self._experiment_conf_path)
 
     def on_tab_changed(self, tab_index):
         logger.debug('[EXPERIMENT {0}] [TAB_CHANGED] - Executing on_tab_changed function'
@@ -215,10 +234,52 @@ def on_import_config_button_clicked(self):
         logger.debug('[EXPERIMENT {0}] [IMPORT_CONFIG_BUTTON_CLICKED] - Executing on_import_config_button_clicked function'
                      .format(self._experiment_name))
 
+        # Get the path of the experiment to import
+        config_file_path = QFileDialog.getOpenFileName(self, "Import Experiment", ".",
+                                                       "Config File (*.conf)")[0]
+        if not config_file_path:
+            # User clicked 'Cancel' or simply closed the Dialog
+            return
+
+        self._file_watcher.removePath(self._experiment_conf_path)
+        self._mlc_local.set_experiment_configuration_from_file(self._experiment_name,
+                                                               config_file_path)
+        self._load_experiment_config()
+        QMessageBox.information(self, "Config File Imported",
+                                "New config file {0} was succesfully imported".format(config_file_path))
+        logger.info("[EXPERIMENT {0}] [EXPORT_CONFIG] - New config file {1} was "
+                    "succesfully imported.".format(self._experiment_name, config_file_path))
+        self._autogenerated_object.save_config_button.setDisabled(True)
+        self._file_watcher.addPath(self._experiment_conf_path)
+
     def on_export_config_button_clicked(self):
         logger.debug('[EXPERIMENT {0}] [EXPORT_CONFIG_BUTTON_CLICKED] - Executing on_export_config_button_clicked function'
                      .format(self._experiment_name))
 
+        export_dir = QFileDialog.getExistingDirectory(self, 'Choose the directory where to export the configuration file',
+                                                      '.', QFileDialog.ShowDirsOnly)
+        if not export_dir:
+            # User clicked 'Cancel' or simply closed the Dialog
+            return
+
+        export_file_name = os.path.join(export_dir, self._experiment_name + ".conf")
+        try:
+            shutil.copyfile(self._experiment_conf_path, export_file_name)
+        except Exception, err:
+            QMessageBox.critical(self, "Config File Not Exported",
+                                 "Config File could not be exported. "
+                                 "Error {0}".format(err))
+            logger.error("[EXPERIMENT {0}] [EXPORT_CONFIG] - Config file could not "
+                         "be exported. Error: {0}".format(err))
+            return
+
+        logger.info("[EXPERIMENT {0}] [EXPORT_CONFIG] - Config file was "
+                    "succesfully exported. Location: {1}"
+                    .format(self._experiment_name, export_file_name))
+        QMessageBox.information(self, "Config File Exported",
+                                "Config File was succesfully exported. You can find it at {0}"
+                                .format(export_file_name))
+
     def on_ev_edit_button_clicked(self):
         logger.debug('[EXPERIMENT {0}] [EV_EDIT_BUTTON_CLICKED] - Executing on_ev_edit_button_clicked function'
                      .format(self._experiment_name))
@@ -313,6 +374,12 @@ def on_board_config_button_clicked(self):
         board_config_window = BoardConfigurationWindow(parent=self)
         board_config_window.show()
 
+    def on_edit_config_button_clicked(self):
+        logger.debug('[EXPERIMENT {0}] [EDIT_CONFIG_BUTTON] - '
+                     'Executing on_edit_config_button_clicked function'
+                     .format(self._experiment_name))
+        QDesktopServices.openUrl(QUrl(self._experiment_conf_path))
+
     def _config_table_edited(self, left, right):
         config_table = self._autogenerated_object.config_table
         table_model = config_table.model()
@@ -472,15 +539,23 @@ def _update_experiment_info(self):
         number_of_gens = experiment_info["generations"]
         if number_of_gens == 0:
             from_gen_combo.addItems([str(1)])
-            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS)])
+            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS + 1)])
         else:
             from_gen_combo.addItems([str(x) for x in xrange(1, number_of_gens + 1)])
-            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS)])
+            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS + 1)])
 
             # Set the from gen combo to the last generation evaluated
             index = from_gen_combo.findText(str(number_of_gens), Qt.MatchFixedString)
             from_gen_combo.setCurrentIndex(index)
 
+            # set the to_gen_combo to the lest generation evaluated + 1
+            to_gen_index = number_of_gens + 1
+            if number_of_gens == ExperimentWindow.MAX_GENERATIONS:
+                to_gen_index = ExperimentWindow.MAX_GENERATIONS
+
+            index = to_gen_combo.findText(str(to_gen_index), Qt.MatchFixedString)
+            to_gen_combo.setCurrentIndex(index)
+
         # Fill the db_view
         gen_count_group = self._autogenerated_object.gen_count_group
         if number_of_gens != 0:
@@ -557,6 +632,23 @@ def _update_individuals_figure(self):
             # Add the Indiv Canvas
             chart_layout.addWidget(indiv_canvas)
 
+    def _reload_experiment_config(self, some_string):
+        logger.debug('[EXPERIMENT {0}] [EXPERIMENT_CONF_FILE_CHANGED] - '
+                     'Executing _experiment_conf_file_changed function'
+                     .format(self._experiment_name))
+
+        self._mlc_local.reload_experiment_configuration(self._experiment_name)
+        self._load_experiment_config()
+
+        QMessageBox.warning(self, "Experiment Config Changed", "The Experiment config file "
+                                  "has changed. The configuration will be reloaded. "
+                                  "The changes made will be discarded")
+        logger.info('[EXPERIMENT {0}] [RELOAD_CONFIG] - Config file has changed. Configuration will be reloaded')
+        self._autogenerated_object.save_config_button.setDisabled(True)
+        # FIXME: Dunno why?, but I have to add the config file to the
+        # watcher in order to work again the next time
+        self._file_watcher.addPath(self._experiment_conf_path)
+
     def _persist_experiment_config(self):
         try:
             self._mlc_local.set_experiment_configuration(self._experiment_name, self._experiment_config)
@@ -579,7 +671,9 @@ def _ask_if_experiment_config_must_be_saved(self):
                                             QMessageBox.Yes | QMessageBox.No,
                                             QMessageBox.Yes)
             if response == QMessageBox.Yes:
+                self._file_watcher.removePath(self._experiment_conf_path)
                 self._persist_experiment_config()
+                self._file_watcher.addPath(self._experiment_conf_path)
             else:
                 self._load_experiment_config()
 

MLC/api/Experiment.py

@@ -18,6 +18,7 @@
 
 logger = get_gui_logger()
 
+
 class Experiment:
     # FIXME: one simulation at a time
     __last_simulation = None
@@ -48,6 +49,15 @@ def get_simulation(self):
     def get_configuration(self):
         return Config.to_dictionary(self._configuration)
 
+    def reload_configuration(self):
+        """
+        Load again the experiment configuration, reading the config file from disk
+        """
+        self._configuration = ConfigParser.ConfigParser()
+        self._configuration.read(self._config_file)
+        Config.get_instance().read(self._config_file)
+        return Config.to_dictionary(self._configuration)
+
     def set_configuration(self, new_configuration):
         self._configuration = Config.from_dictionary(new_configuration, config_type=ConfigParser.ConfigParser)
         self._configuration.write(open(self._config_file, "wt"))