ivoryos 0.1.18__tar.gz → 0.1.19__tar.gz

{ivoryos-0.1.18/ivoryos.egg-info → ivoryos-0.1.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ivoryos
-Version: 0.1.18
+Version: 0.1.19
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Home-page: https://gitlab.com/heingroup/ivoryos
 Author: Ivory Zhang
@@ -157,6 +157,15 @@ Intro + Tutorial + Demo with PurPOSE platform
 https://youtu.be/dFfJv9I2-1g 
 
 
+## Roadmap
+
+- [x] Allow plugin pages ✅  
+- [ ] pause, resume, abort current and pending workflows
+- [ ] snapshot version control
+- [ ] dropdown input
+- [ ] show line number option
+
+
 ## Authors and Acknowledgement
 Ivory Zhang, Lucy Hao
 

{ivoryos-0.1.18 → ivoryos-0.1.19}/README.md

@@ -145,6 +145,15 @@ Intro + Tutorial + Demo with PurPOSE platform
 https://youtu.be/dFfJv9I2-1g 
 
 
+## Roadmap
+
+- [x] Allow plugin pages ✅  
+- [ ] pause, resume, abort current and pending workflows
+- [ ] snapshot version control
+- [ ] dropdown input
+- [ ] show line number option
+
+
 ## Authors and Acknowledgement
 Ivory Zhang, Lucy Hao
 

{ivoryos-0.1.18 → ivoryos-0.1.19}/ivoryos/routes/design/design.py

@@ -24,10 +24,22 @@ global_config = GlobalConfig()
 runner = ScriptRunner()
 
 
-@socketio.on('abort_action')
-def handle_abort_action():
+@socketio.on('abort_pending')
+def handle_abort_pending():
+    runner.abort_pending()
+    socketio.emit('log', {'message': "aborted pending iterations"})
+
+
+@socketio.on('abort_current')
+def handle_abort_current():
     runner.stop_execution()
-    socketio.emit('log', {'message': "aborted pending tasks"})
+    socketio.emit('log', {'message': "stopped next task"})
+
+
+@socketio.on('pause')
+def handle_pause():
+    msg = runner.toggle_pause()
+    socketio.emit('log', {'message': msg})
 
 
 @socketio.on('connect')
@@ -266,9 +278,10 @@ def experiment_run():
         config_preview = config[1:6]
         arg_type = config.pop(0)  # first entry is types
     try:
-        exec(exec_string)
+        for key, func_str in exec_string.items():
+            exec(func_str)
     except Exception:
-        flash("Please check syntax!!")
+        flash(f"Please check {key} syntax!!")
         return redirect(url_for("design.experiment_builder"))
     # runner.globals_dict.update(globals())
     run_name = script.name if script.name else "untitled"
@@ -313,7 +326,8 @@ def experiment_run():
     return render_template('experiment_run.html', script=script.script_dict, filename=filename, dot_py=exec_string,
                            return_list=return_list, config_list=config_list, config_file_list=config_file_list,
                            config_preview=config_preview, data_list=data_list, config_type_list=config_type_list,
-                           no_deck_warning=no_deck_warning, dismiss=dismiss, design_buttons=design_buttons, history=deck_list)
+                           no_deck_warning=no_deck_warning, dismiss=dismiss, design_buttons=design_buttons,
+                           history=deck_list)
 
 
 @design.route("/toggle_script_type/<stype>")
@@ -547,4 +561,4 @@ def duplicate_action(id: int):
     script = utils.get_script_file()
     script.duplicate_action(id)
     utils.post_script_file(script)
-    return redirect(back)
+    return redirect(back)

{ivoryos-0.1.18 → ivoryos-0.1.19}/ivoryos/routes/design/templates/design/experiment_run.html

@@ -219,10 +219,24 @@
                             </div>
                             <div class="col-lg-6 col-sm-12 logging-panel">
                                 <p>
-                                <div class="p d-flex justify-content-between align-items-center">
-                                    <h5>Progress：</h5>
-                                    <button id="abort" class="btn btn-danger ">Abort Pending Actions</button>
-                                </div>
+                                    <div class="p d-flex justify-content-between align-items-center">
+                                        <h5>Progress：</h5>
+                                        <div class="d-flex gap-2 ms-auto">
+                                            <button id="pause-resume" class="btn btn-info text-white" data-bs-toggle="tooltip" title="Pause execution">
+                                                <i class="bi bi-pause-circle"></i> <!-- Icon for Pause -->
+                                            </button>
+                                            <button id="abort-current" class="btn btn-danger text-white" data-bs-toggle="tooltip" title="Stop execution after current step">
+                                                <i class="bi bi-stop-circle"></i> <!-- Icon for Stop After This Step -->
+                                            </button>
+                                            <button id="abort-pending" class="btn btn-warning text-white" data-bs-toggle="tooltip" title="Stop execution after current iteration">
+                                                <i class="bi bi-hourglass-split"></i> <!-- Icon for Stop After This Iteration -->
+                                            </button>
+                                        </div>
+                                    </div>
+                                    <div class="text-muted mt-2">
+                                        <small><strong>Note:</strong> The current step cannot be paused or stopped until it completes. </small>
+                                    </div>
+
                                 </p>
                                 <div class="progress" role="progressbar" aria-label="Animated striped example" aria-valuenow="10" aria-valuemin="0" aria-valuemax="100">
                                     <div id="progress-bar-inner" class="progress-bar progress-bar-striped progress-bar-animated"></div>
@@ -295,7 +309,9 @@
             </h2>
             <div id="python" class="accordion-collapse collapse">
                 <div class="accordion-body">
-                    <pre><code class="python" >{{dot_py}}</code></pre>
+                    {% for stype, script in dot_py.items() %}
+                        <pre><code class="python" >{{script}}</code></pre>
+                    {% endfor %}
                     <a href="{{ url_for('design.download', filetype='python') }}">Download <i class="bi bi-download"></i></a>
                 </div>
             </div>

ivoryos-0.1.19/ivoryos/static/js/socket_handler.js

@@ -0,0 +1,62 @@
+document.addEventListener("DOMContentLoaded", function() {
+    var socket = io.connect('http://' + document.domain + ':' + location.port);
+    socket.on('connect', function() {
+        console.log('Connected');
+    });
+    socket.on('progress', function(data) {
+        var progress = data.progress;
+        console.log(progress);
+        // Update the progress bar's width and appearance
+        var progressBar = document.getElementById('progress-bar-inner');
+        progressBar.style.width = progress + '%';
+        progressBar.setAttribute('aria-valuenow', progress);
+
+        if (progress === 100) {
+            // Remove animation and set green color when 100% is reached
+            progressBar.classList.remove('progress-bar-animated');
+            progressBar.classList.add('bg-success'); // Bootstrap class for green color
+        }
+    });
+    socket.on('log', function(data) {
+        var logMessage = data.message;
+        console.log(logMessage);
+        $('#logging-panel').append(logMessage + "<br>");
+        $('#logging-panel').scrollTop($('#logging-panel')[0].scrollHeight);
+    });
+
+    document.getElementById('abort-pending').addEventListener('click', function() {
+        var confirmation = confirm("Are you sure you want to stop after this iteration?");
+        if (confirmation) {
+            socket.emit('abort_pending');
+            console.log('Abort action sent to server.');
+        }
+    });
+    document.getElementById('abort-current').addEventListener('click', function() {
+        var confirmation = confirm("Are you sure you want to stop after this step?");
+        if (confirmation) {
+            socket.emit('abort_current');
+            console.log('Stop action sent to server.');
+    }
+    });
+
+    document.getElementById('pause-resume').addEventListener('click', function() {
+
+        socket.emit('pause');
+        console.log('Pause/Resume is toggled.');
+        var button = this;
+        var icon = button.querySelector("i");
+
+        // Toggle between Pause and Resume
+        if (icon.classList.contains("bi-pause-circle")) {
+            icon.classList.remove("bi-pause-circle");
+            icon.classList.add("bi-play-circle");
+            button.innerHTML = '<i class="bi bi-play-circle"></i>';
+            button.setAttribute("title", "Resume execution");
+        } else {
+            icon.classList.remove("bi-play-circle");
+            icon.classList.add("bi-pause-circle");
+            button.innerHTML = '<i class="bi bi-pause-circle"></i>';
+            button.setAttribute("title", "Pause execution");
+        }
+    });
+});

{ivoryos-0.1.18 → ivoryos-0.1.19}/ivoryos/utils/db_models.py

@@ -398,35 +398,16 @@ class Script(db.Model):
         self.sort_actions()
         run_name = self.name if self.name else "untitled"
         run_name = self.validate_function_name(run_name)
-        exec_string = ''
+        exec_str_collection = {}
 
         for i in self.stypes:
-            exec_string += self._generate_function_header(run_name, i)
-            exec_string += self._generate_function_body(i)
-
+            func_str = self._generate_function_header(run_name, i) + self._generate_function_body(i)
+            exec_str_collection[i] = func_str
         if script_path:
-            self._write_to_file(script_path, run_name, exec_string)
+            self._write_to_file(script_path, run_name, exec_str_collection)
 
-        return exec_string
+        return exec_str_collection
 
-    def compile_steps(self, script_path=None):
-        """
-        Compile the current script to steps.
-        :return: {"prep":[], "script":[], "cleanup":[],}.
-        """
-        self.sort_actions()
-        run_name = self.name if self.name else "untitled"
-        run_name = self.validate_function_name(run_name)
-        exec_string = ''
-        steps = {}
-        for i in self.stypes:
-            # exec_string += self._generate_function_header(run_name, i)
-            exec_string += self._generate_function_body(i)
-
-        if script_path:
-            self._write_to_file(script_path, run_name, exec_string)
-
-        return exec_string
 
 
     @staticmethod
@@ -447,7 +428,7 @@ class Script(db.Model):
         configure = [param + f":{param_type}" if not param_type == "any" else "" for param, param_type in
                      config_type.items()]
 
-        function_header = f"\n\ndef {run_name}_{stype}("
+        function_header = f"def {run_name}_{stype}("
 
         if stype == "script":
             function_header += ", ".join(configure)
@@ -471,21 +452,6 @@ class Script(db.Model):
             body += self.indent(indent_unit) + return_str
         return body
 
-    # def _generate_function_body(self, stype):
-    #     """
-    #     Generate the function body for each type in stypes.
-    #     """
-    #     steps = []
-    #     indent_unit = 1
-    #
-    #     for index, action in enumerate(self.script_dict[stype]):
-    #         text, indent_unit = self._process_action(indent_unit, action, index, stype)
-    #         body += text
-    #     return_str, return_list = self.config_return()
-    #     if return_list and stype == "script":
-    #         body += self.indent(indent_unit) + return_str
-    #     return body
-
     def _process_action(self, indent_unit, action, index, stype):
         """
         Process each action within the script dictionary.
@@ -631,7 +597,8 @@ class Script(db.Model):
             else:
                 s.write("deck = None")
             s.write("\nimport time")
-            s.write(exec_string)
+            for i in exec_string.values():
+                s.write(f"\n\n\n{i}")
 
 
 if __name__ == "__main__":

{ivoryos-0.1.18 → ivoryos-0.1.19}/ivoryos/utils/script_runner.py

@@ -1,3 +1,4 @@
+import ast
 import os
 import csv
 import threading
@@ -17,25 +18,40 @@ class ScriptRunner:
         if globals_dict is None:
             globals_dict = globals()
         self.globals_dict = globals_dict
-
-        self.stop_event = threading.Event()
+        self.pause_event = threading.Event()  # A threading event to manage pause/resume
+        self.pause_event.set()
+        self.stop_pending_event = threading.Event()
+        self.stop_current_event = threading.Event()
         self.is_running = False
         self.lock = threading.Lock()
 
+    def toggle_pause(self):
+        """Toggles between pausing and resuming the script"""
+        if self.pause_event.is_set():
+            self.pause_event.clear()  # Pause the script
+            return "Paused"
+        else:
+            self.pause_event.set()  # Resume the script
+            return "Resumed"
+
     def reset_stop_event(self):
-        self.stop_event.clear()
+        self.stop_pending_event.clear()
+        self.stop_current_event.clear()
 
-    def stop_execution(self):
-        self.stop_event.set()
+    def abort_pending(self):
+        self.stop_pending_event.set()
         # print("Stop pending tasks")
 
+    def stop_execution(self):
+        """Force stop everything, including ongoing tasks."""
+        self.stop_current_event.set()
+        self.abort_pending()
+
     def run_script(self, script, repeat_count=1, run_name=None, logger=None, socketio=None, config=None, bo_args=None,
                    output_path=""):
         global deck
         if deck is None:
             deck = global_config.deck
-        exec_string = script.compile()
-        exec(exec_string)
         time.sleep(1)
         with self.lock:
             if self.is_running:
@@ -50,24 +66,61 @@ class ScriptRunner:
         thread.start()
         return thread
 
+    def execute_function_line_by_line(self, script, section_name, logger, **kwargs):
+        """
+        Executes a function defined in a string line by line.
+
+        :param func_str: The function as a string
+        :param kwargs: Arguments to pass to the function
+        :return: The final result of the function execution
+        """
+        global deck
+        if deck is None:
+            deck = global_config.deck
+        # func_str = script.compile()
+        # Parse function body from string
+        module = ast.parse(script)
+        func_def = next(node for node in module.body if isinstance(node, ast.FunctionDef))
+
+        # Extract function body as source lines
+        lines = [ast.unparse(node) for node in func_def.body if not isinstance(node, ast.Return)]
+        # Prepare execution environment
+        exec_globals = {"deck": deck}  # Add required global objects
+        exec_locals = {}  # Local execution scope
+
+        # Define function arguments manually in exec_locals
+        exec_locals.update(kwargs)
+
+        # Execute each line dynamically
+        for line in lines:
+            if self.stop_current_event.is_set():
+                logger.info(f'Stopping execution during {section_name}')
+                break
+            logger.info(f"Executing: {line}")  # Debugging output
+            exec(line, exec_globals, exec_locals)
+            self.pause_event.wait()
+
+        return exec_locals  # Return the 'results' variable
+
     def _run_with_stop_check(self, script: Script, repeat_count, run_name, logger, socketio, config, bo_args,
                              output_path):
         time.sleep(1)
+        func_str = script.compile()
         self._emit_progress(socketio, 1)
         try:
             # Run "prep" section once
             script_dict = script.script_dict
-            self._run_actions(script_dict.get("prep", []), section_name="prep", run_name=run_name, logger=logger)
+            self._run_actions(script_dict.get("prep", []), func_str.get("prep", ''), section_name="prep", logger=logger)
             output_list = []
             _, arg_type = script.config("script")
             _, return_list = script.config_return()
             # Run "script" section multiple times
             if repeat_count:
-                self._run_repeat_section(repeat_count, arg_type, bo_args, output_list, return_list, run_name, logger, socketio)
+                self._run_repeat_section(repeat_count, arg_type, bo_args, output_list,  func_str.get("script", ''), run_name, return_list, logger, socketio)
             elif config:
-                self._run_config_section(config, arg_type, output_list, return_list, run_name, logger, socketio)
+                self._run_config_section(config, arg_type, output_list, func_str.get("script", ''), run_name, logger, socketio)
             # Run "cleanup" section once
-            self._run_actions(script_dict.get("cleanup", []), section_name="cleanup", run_name=run_name, logger=logger)
+            self._run_actions(script_dict.get("cleanup", []), func_str.get("cleanup", ''), section_name="cleanup", logger=logger)
             # Save results if necessary
             if output_list:
                 self._save_results(run_name, arg_type, return_list, output_list, logger, output_path)
@@ -78,21 +131,14 @@ class ScriptRunner:
                 self.is_running = False  # Reset the running flag when done
             self._emit_progress(socketio, 100)
 
-    def _run_actions(self, actions, section_name="", run_name=None, logger=None):
+    def _run_actions(self, actions, func_str, section_name="", logger=None):
         logger.info(f'Executing {section_name} steps') if actions else logger.info(f'No {section_name} steps')
-        if self.stop_event.is_set():
+        if self.stop_pending_event.is_set():
             logger.info(f"Stopping execution during {section_name} section.")
             return
-            # for action in actions:
-            #     if self.stop_event.is_set():
-            #         logger.info(f"Stopping execution during {section_name} section.")
-            #         break
-            #     logger.info(f'Executing {action.get("action", "")} action')
-        fname = f"{run_name}_{section_name}"
-        function = self.globals_dict[fname]
-        function()
-
-    def _run_config_section(self, config, arg_type, output_list, return_list, run_name, logger, socketio):
+        self.execute_function_line_by_line(func_str, section_name, logger)
+
+    def _run_config_section(self, config, arg_type, output_list, func_str, run_name, logger, socketio):
         compiled = True
         for i in config:
             try:
@@ -104,25 +150,25 @@ class ScriptRunner:
         if compiled:
             for i, kwargs in enumerate(config):
                 kwargs = dict(kwargs)
-                if self.stop_event.is_set():
+                if self.stop_pending_event.is_set():
                     logger.info(f'Stopping execution during {run_name}: {i + 1}/{len(config)}')
                     break
                 logger.info(f'Executing {i + 1} of {len(config)} with kwargs = {kwargs}')
                 progress = (i + 1) * 100 / len(config)
                 self._emit_progress(socketio, progress)
-                fname = f"{run_name}_script"
-                function = self.globals_dict[fname]
-                output = function(**kwargs)
+                # fname = f"{run_name}_script"
+                # function = self.globals_dict[fname]
+                output = self.execute_function_line_by_line(func_str, "script", logger, **kwargs)
                 if output:
-                    kwargs.update(output)
-                    output_list.append(kwargs)
+                    # kwargs.update(output)
+                    output_list.append(output)
 
-    def _run_repeat_section(self, repeat_count, arg_types, bo_args, output_list, return_list, run_name, logger, socketio):
+    def _run_repeat_section(self, repeat_count, arg_types, bo_args, output_list,  func_str, run_name, return_list, logger, socketio):
         if bo_args:
             logger.info('Initializing optimizer...')
             ax_client = utils.ax_initiation(bo_args, arg_types)
         for i in range(int(repeat_count)):
-            if self.stop_event.is_set():
+            if self.stop_pending_event.is_set():
                 logger.info(f'Stopping execution during {run_name}: {i + 1}/{int(repeat_count)}')
                 break
             logger.info(f'Executing {run_name} experiment: {i + 1}/{int(repeat_count)}')
@@ -132,20 +178,20 @@ class ScriptRunner:
                 try:
                     parameters, trial_index = ax_client.get_next_trial()
                     logger.info(f'Output value: {parameters}')
-                    fname = f"{run_name}_script"
-                    function = self.globals_dict[fname]
-                    output = function(**parameters)
-                    # output = eval(f"{run_name}_script(**{parameters})")
-                    _output = output.copy()
+                    # fname = f"{run_name}_script"
+                    # function = self.globals_dict[fname]
+                    output = self.execute_function_line_by_line(func_str, "script", logger, **parameters)
+
+                    _output = {key: value for key, value in output.items() if key in return_list}
                     ax_client.complete_trial(trial_index=trial_index, raw_data=_output)
                     output.update(parameters)
                 except Exception as e:
                     logger.info(f'Optimization error: {e}')
                     break
             else:
-                fname = f"{run_name}_script"
-                function = self.globals_dict[fname]
-                output = function()
+                # fname = f"{run_name}_script"
+                # function = self.globals_dict[fname]
+                output = self.execute_function_line_by_line(func_str, "script", logger)
 
             if output:
                 output_list.append(output)

ivoryos-0.1.19/ivoryos/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.19"

{ivoryos-0.1.18 → ivoryos-0.1.19/ivoryos.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ivoryos
-Version: 0.1.18
+Version: 0.1.19
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Home-page: https://gitlab.com/heingroup/ivoryos
 Author: Ivory Zhang
@@ -157,6 +157,15 @@ Intro + Tutorial + Demo with PurPOSE platform
 https://youtu.be/dFfJv9I2-1g 
 
 
+## Roadmap
+
+- [x] Allow plugin pages ✅  
+- [ ] pause, resume, abort current and pending workflows
+- [ ] snapshot version control
+- [ ] dropdown input
+- [ ] show line number option
+
+
 ## Authors and Acknowledgement
 Ivory Zhang, Lucy Hao
 

ivoryos-0.1.18/ivoryos/static/js/socket_handler.js

@@ -1,34 +0,0 @@
-document.addEventListener("DOMContentLoaded", function() {
-    var socket = io.connect('http://' + document.domain + ':' + location.port);
-    socket.on('connect', function() {
-        console.log('Connected');
-    });
-    socket.on('progress', function(data) {
-        var progress = data.progress;
-        console.log(progress);
-        // Update the progress bar's width and appearance
-        var progressBar = document.getElementById('progress-bar-inner');
-        progressBar.style.width = progress + '%';
-        progressBar.setAttribute('aria-valuenow', progress);
-
-        if (progress === 100) {
-            // Remove animation and set green color when 100% is reached
-            progressBar.classList.remove('progress-bar-animated');
-            progressBar.classList.add('bg-success'); // Bootstrap class for green color
-        }
-    });
-    socket.on('log', function(data) {
-        var logMessage = data.message;
-        console.log(logMessage);
-        $('#logging-panel').append(logMessage + "<br>");
-        $('#logging-panel').scrollTop($('#logging-panel')[0].scrollHeight);
-    });
-
-    document.getElementById('abort').addEventListener('click', function() {
-        var confirmation = confirm("Are you sure you want to abort pending actions?");
-        if (confirmation) {
-            socket.emit('abort_action');
-            console.log('Abort action sent to server.');
-        }
-    });
-});

ivoryos-0.1.18/ivoryos/version.py

@@ -1 +0,0 @@
-__version__ = "0.1.18"