Added clone button functionality

* Also, DAC Adapter Circuit modifications are comitted #34

Author: Ezetowers

MLC/GUI/ExperimentsManager.py

@@ -21,6 +21,7 @@
 
 import os
 import sys
+import shutil
 import time
 
 from MLC.api.mlc import DuplicatedExperimentError
@@ -142,6 +143,7 @@ def import_experiment(self, experiment_path):
             raise
 
         self._experiment_list.append(experiment_name)
+        self._experiment_list.sort()
         self.load_experiment_info(experiment_name)
 
     def export_experiment(self, export_dir, experiment_name):
@@ -158,6 +160,15 @@ def export_experiment(self, export_dir, experiment_name):
                          "Error {1}".format(experiment_name, err))
             raise
 
+    def clone_experiment(self, experiment_name, cloned_experiment):
+        if not self._mlc_local.clone_experiment(experiment_name, cloned_experiment):
+            return False
+
+        self._experiment_list.append(cloned_experiment)
+        self._experiment_list.sort()
+        self.load_experiment_info(cloned_experiment)
+        return True
+
     def get_experiment_list(self):
         return self._experiment_list
 

MLC/GUI/mlc_gui.py

@@ -119,13 +119,16 @@ def on_new_button_clicked(self):
                     else:
                         break
 
-                # Create the new experiment and refresh the View
+                # Create the new experiment and refresh the view
                 if not self._experiments_manager.add_experiment(experiment_name):
+                    logger.error('[MLC_MANAGER] [NEW_EXPERIMENT] - Experiment {0} could not be created. '
+                                 'Check it to be correct in your workspace'.format(experiment_name))
                     QMessageBox.critical(self, 'New Experiment',
-                                         ('Experiment {0} already exists but has errors. '
-                                          'Check it to be correct in your workspace'
-                                          .format(experiment_name)))
+                                         'Experiment {0} could not be created. '
+                                         'Check the experiment to be correct in your workspace'
+                                         .format(experiment_name))
                     return
+
                 self._refresh_experiment_list_view()
                 self._clean_experiment_selection()
 
@@ -151,8 +154,68 @@ def on_open_button_clicked(self):
         experiment.show()
 
     def on_clone_button_clicked(self):
-        logger.debug("[MLC_MANAGER] [CLONE_BUTTON] - Open button clicked")
-        # TODO
+        logger.debug("[MLC_MANAGER] [CLONE_BUTTON] - Clone button clicked")
+        cloned_experiment = ""
+        dialog_ok = False
+
+        if self._experiment_selected is None:
+            logger.info("[MLC MANAGER] [OPEN_BUTTON] - No experiment was selected yet. Don't do anything")
+            return
+        experiment_name = self._experiment_selected
+
+        while True:
+            cloned_experiment, dialog_ok = QInputDialog.getText(self, 'Clone Experiment',
+                                                              'Enter the name of the new cloned experiment:')
+
+            if dialog_ok:
+                if cloned_experiment == "":
+                    logger.info('[MLC_MANAGER] [CLONE_EXPERIMENT] - Cloned experiment name cannot an empty string.')
+                    msg_ok = QMessageBox.information(self, 'Clone Experiment',
+                                                     'Cloned experiment name experiment cannot be an empty string. '
+                                                     'Please, insert a valid name',
+                                                     QMessageBox.Ok | QMessageBox.Cancel,
+                                                     QMessageBox.Ok)
+
+                    if msg_ok == QMessageBox.Ok:
+                        continue
+                    else:
+                        break
+
+                # Check if the experiment already exists
+                if cloned_experiment in self._experiments_manager.get_experiment_list():
+                    msg_ok = QMessageBox.question(self, 'Clone Experiment',
+                                                  ('The cloned experiment name has already been taken. '
+                                                   'Do you want to create the project with a different name?'),
+                                                  QMessageBox.Yes | QMessageBox.No,
+                                                  QMessageBox.Yes)
+                    if msg_ok == QMessageBox.Yes:
+                        continue
+                    else:
+                        break
+
+                # Create the new experiment and refresh the View
+                if not self._experiments_manager.clone_experiment(experiment_name, cloned_experiment):
+                    logger.error('[MLC_MANAGER] [CLONE_EXPERIMENT] - Experiment {0} could not be created. '
+                                 'Check it to be correct in your workspace'.format(experiment_name))
+                    QMessageBox.critical(self, 'Clone Experiment',
+                                         'Experiment {0} could not be cloned. '
+                                         'Check the experiment to be correct in your workspace'
+                                         .format(experiment_name))
+                    return
+
+                self._refresh_experiment_list_view()
+                self._clean_experiment_selection()
+
+                QMessageBox.information(self, 'Clone Experiment',
+                                        'Experiment {0} was succesfully cloned. Cloned Experiment: {1}'
+                                        .format(experiment_name, cloned_experiment))
+                logger.debug('[MLC_MANAGER] [CLONE_EXPERIMENT] - Experiment {0} was succesfully cloned. '
+                             'Cloned Experiment {1}'.format(experiment_name, cloned_experiment))
+                return
+            else:
+                break
+        logger.debug('[MLC_MANAGER] New experiment could not be cloned')
+
 
     def on_remove_button_clicked(self):
         logger.debug("[MLC_MANAGER] [REMOVE_EXPERIMENT] - Remove button clicked")

MLC/GUI/util.py

@@ -20,6 +20,8 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>
 
 import os
+import sys
+import traceback
 
 from MLC.Common.LispTreeExpr.LispTreeExpr import LispTreeExpr
 from MLC.Common.LispTreeExpr.LispTreeExpr import ExprException
@@ -63,12 +65,14 @@ def test_individual_value(parent, experiment_name, log_prefix, indiv_value, conf
         QMessageBox.critical(parent,
                              "Invalid Evaluation Script",
                              "Check the evaluation script to be correct. "
-                             "Error Msg: {0}.".format(err))
+                             "Error Msg: {0}. \n Traceback: {1}"
+                             .format(err, traceback.format_exc()))
+
         logger.error("{0} Experiment {1} - "
                      "Individual inserted is not a valid individual. "
                      "Check the evaluation script to be correct. "
-                     "Error Msg: {2}."
-                     .format(log_prefix, experiment_name, err))
+                     "Error Msg: {2}. Traceback:\n{3}"
+                     .format(log_prefix, experiment_name, err, traceback.format_exc()))
 
     return None
 

MLC/api/Experiment.py

@@ -45,6 +45,8 @@ class Experiment:
     __last_simulation = None
 
     def __init__(self, working_dir, experiment_name):
+        logger.info("[EXPERIMENT {0}] Proceed to load {1} experiment"
+                    .format(experiment_name, os.path.join(working_dir)))
         Experiment.check_configuration(working_dir, experiment_name)
         cfg, db = Experiment.get_experiment_files(working_dir, experiment_name)
         self._name = experiment_name

MLC/api/MLCLocal.py

@@ -178,6 +178,37 @@ def new_experiment(self, experiment_name,
                                   evaluation_script,
                                   preevaluation_script)
 
+    def clone_experiment(self, experiment_name, cloned_experiment):
+        source_path = os.path.join(self._working_dir, experiment_name)
+        cloned_path = os.path.join(self._working_dir, cloned_experiment)
+
+        # Copy the desired experiment and then change the config and db files names
+        try:
+            shutil.copytree(source_path, cloned_path)
+            shutil.move(os.path.join(cloned_path, experiment_name + ".conf"),
+                        os.path.join(cloned_path, cloned_experiment + ".conf"))
+
+            shutil.move(os.path.join(cloned_path, experiment_name + ".db"),
+                        os.path.join(cloned_path, cloned_experiment + ".db"))
+
+            # Change the DB name inside the experiment
+            experiment_config = ConfigParser.ConfigParser()
+            experiment_config.read(os.path.join(cloned_path, cloned_experiment + ".conf"))
+            experiment_config.set('BEHAVIOUR', 'savedir', cloned_experiment + ".db")
+            with open(os.path.join(cloned_path, cloned_experiment + ".conf"), "w") as f:
+                experiment_config.write(f)
+
+            # Add the experiment to the list of experiments
+            self._experiments[cloned_experiment] = Experiment(cloned_path, cloned_experiment)
+
+        except Exception, err:
+            logger.error("[MLC_LOCAL] [CLONE] - "
+                         "An error ocurred while cloning project {0}. "
+                         "Error {1}".format(experiment_name, err))
+            return False
+
+        return True
+
     def delete_experiment(self, experiment_name):
         if experiment_name not in self._experiments:
             raise ExperimentNotExistException(experiment_name)
@@ -293,7 +324,6 @@ def save_board_configuration(self, experiment_name, board_configuration, connect
             mlc_repo.save_board_configuration(board_configuration, board_id=board_id)
             mlc_repo.save_serial_connection(connection, board_id=board_id, connection_id=board_id)
 
-
     def go(self, experiment_name, to_generation, from_generation=0, callbacks={}, gen_creator=None):
         if experiment_name not in self._experiments:
             raise ExperimentNotExistException(experiment_name)

MLC/api/mlc.py

@@ -112,6 +112,14 @@ def delete_experiment(self, experiment_name):
         """
         raise NotImplementedError("MLC::delete_experiment not implemented")
 
+    def clone_experiment(self, experiment_name, cloned_experiment):
+        """
+            Clone an experiment from the workspace.
+            :param experiment_name:
+            :param cloned_experiment
+        """
+        raise NotImplementedError("MLC::cloned_experiment not implemented")
+
     def import_experiment(self, experiment_path):
         """
             Import an experiment and add it to the workspace