ivoryos 1.0.1__py3-none-any.whl → 1.0.4__py3-none-any.whl

ivoryos/static/js/sortable_design.js

@@ -21,7 +21,7 @@ $(document).ready(function () {
                 success: function (data) {
                     $("#response").html(data);
                     $("#response").slideDown("slow");
-                    slideout();
+                    window.location.href = window.location.href;
                 }
             });
         }

ivoryos/utils/client_proxy.py

@@ -8,7 +8,7 @@ import os
 
 # Function to create class and methods dynamically
 def create_function(url, class_name, functions):
-    class_template = f'class {class_name.capitalize()}:\n    url = "{url}ivoryos/backend_control/deck.{class_name}"\n'
+    class_template = f'class {class_name.capitalize()}:\n    url = "{url}ivoryos/api/control/deck.{class_name}"\n'
 
     for function_name, details in functions.items():
         signature = details['signature']

ivoryos/utils/form.py

@@ -1,8 +1,9 @@
 from enum import Enum
+from typing import get_origin, get_args, Union, Any
 
 from wtforms.fields.choices import SelectField
 from wtforms.fields.core import Field
-from wtforms.validators import InputRequired, ValidationError
+from wtforms.validators import InputRequired, ValidationError, Optional
 from wtforms.widgets.core import TextInput
 
 from flask_wtf import FlaskForm
@@ -219,6 +220,26 @@ def format_name(name):
     text = ' '.join(word for word in name.split('_'))
     return text.capitalize()
 
+def parse_annotation(annotation):
+    """
+    Given a type annotation, return:
+    - a list of all valid types (excluding NoneType)
+    - a boolean indicating if the value can be None (optional)
+    """
+    origin = get_origin(annotation)
+    args = get_args(annotation)
+
+    if annotation is Any:
+        return [str], True  # fallback: accept any string, optional
+
+    if origin is Union:
+        types = list(set(args))
+        is_optional = type(None) in types
+        non_none_types = [t for t in types if t is not type(None)]
+        return non_none_types, is_optional
+
+    # Not a Union, just a regular type
+    return [annotation], False
 
 def create_form_for_method(method, autofill, script=None, design=True):
     """
@@ -258,7 +279,7 @@ def create_form_for_method(method, autofill, script=None, design=True):
         field_kwargs = {
             "label": formatted_param_name,
             "default": default_value,
-            "validators": [InputRequired()] if param.default is param.empty else None,
+            "validators": [InputRequired()] if param.default is param.empty else [Optional()],
             **({"script": script} if (autofill or design) else {})
         }
         if isinstance(param.annotation, type) and issubclass(param.annotation, Enum):
@@ -267,11 +288,17 @@ def create_form_for_method(method, autofill, script=None, design=True):
             placeholder_text = f"Choose or type a value for {param.annotation.__name__} (start with # for custom)"
             extra_kwargs = {"choices": param.annotation}
         else:
+            # print(param.annotation)
+            annotation, optional = parse_annotation(param.annotation)
+            annotation = annotation[0]
             field_class, placeholder_text = annotation_mapping.get(
-                param.annotation,
+                annotation,
                 (VariableOrStringField if design else StringField, f'Enter {param.annotation} value')
             )
             extra_kwargs = {}
+            if optional:
+                field_kwargs["filters"] = [lambda x: x if x != '' else None]
+
 
         render_kwargs = {"placeholder": placeholder_text}
 

ivoryos/utils/script_runner.py

@@ -69,7 +69,7 @@ class ScriptRunner:
 
         if self.current_app is None:
             self.current_app = current_app
-        time.sleep(1)  # Optional: may help ensure deck readiness
+        # time.sleep(1)  # Optional: may help ensure deck readiness
 
         # Try to acquire lock without blocking
         if not self.lock.acquire(blocking=False):
@@ -240,6 +240,7 @@ class ScriptRunner:
             for i in config:
                 try:
                     i = utils.convert_config_type(i, arg_type)
+                    compiled = True
                 except Exception as e:
                     logger.info(e)
                     compiled = False

ivoryos/utils/utils.py

@@ -4,6 +4,7 @@ import inspect
 import logging
 import os
 import pickle
+import socket
 import subprocess
 import sys
 from collections import Counter
@@ -407,3 +408,15 @@ def get_method_from_workflow(function_string, func_name="workflow"):
 #         method = get_method_from_workflow(compiled_strs, func_name=workflow.name)
 #         setattr(RegisteredWorkflows, workflow.name, staticmethod(method))
 #     global_config.registered_workflows = RegisteredWorkflows()
+
+
+def get_local_ip():
+    try:
+        s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        s.connect(('10.255.255.255', 1))  # Dummy address to get interface IP
+        ip = s.getsockname()[0]
+    except Exception:
+        ip = '127.0.0.1'
+    finally:
+        s.close()
+    return ip

ivoryos/version.py

@@ -1 +1 @@
-__version__ = "1.0.1"
+__version__ = "1.0.4"

{ivoryos-1.0.1.dist-info → ivoryos-1.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ivoryos
-Version: 1.0.1
+Version: 1.0.4
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Home-page: https://gitlab.com/heingroup/ivoryos
 Author: Ivory Zhang
@@ -176,6 +176,42 @@ When you run the application for the first time, it will automatically create th
 - [x] show line number option ✅  
 - [ ] snapshot version control
 
+## Citing
+
+If you find this project useful, please consider citing the following manuscript:
+
+> Zhang, W., Hao, L., Lai, V. et al. [IvoryOS: an interoperable web interface for orchestrating Python-based self-driving laboratories.](https://www.nature.com/articles/s41467-025-60514-w) Nat Commun 16, 5182 (2025).
+
+```bibtex
+@article{zhang_et_al_2025,
+  author       = {Wenyu Zhang and Lucy Hao and Veronica Lai and Ryan Corkery and Jacob Jessiman and Jiayu Zhang and Junliang Liu and Yusuke Sato and Maria Politi and Matthew E. Reish and Rebekah Greenwood and Noah Depner and Jiyoon Min and Rama El-khawaldeh and Paloma Prieto and Ekaterina Trushina and Jason E. Hein},
+  title        = {{IvoryOS}: an interoperable web interface for orchestrating {Python-based} self-driving laboratories},
+  journal      = {Nature Communications},
+  year         = {2025},
+  volume       = {16},
+  number       = {1},
+  pages        = {5182},
+  doi          = {10.1038/s41467-025-60514-w},
+  url          = {https://doi.org/10.1038/s41467-025-60514-w}
+}
+```
+
+For an additional perspective related to the development of the tool, please see:
+
+> Zhang, W., Hein, J. [Behind IvoryOS: Empowering Scientists to Harness Self-Driving Labs for Accelerated Discovery](https://communities.springernature.com/posts/behind-ivoryos-empowering-scientists-to-harness-self-driving-labs-for-accelerated-discovery). Springer Nature Research Communities (2025).
+
+```bibtex
+@misc{zhang_hein_2025,
+  author       = {Wenyu Zhang and Jason Hein},
+  title        = {Behind {IvoryOS}: Empowering Scientists to Harness Self-Driving Labs for Accelerated Discovery},
+  howpublished = {Springer Nature Research Communities},
+  year         = {2025},
+  month        = {Jun},
+  day          = {18},
+  url          = {https://communities.springernature.com/posts/behind-ivoryos-empowering-scientists-to-harness-self-driving-labs-for-accelerated-discovery}
+}
+```
+
 ## Authors and Acknowledgement
 Ivory Zhang, Lucy Hao
 

{ivoryos-1.0.1.dist-info → ivoryos-1.0.4.dist-info}/RECORD

@@ -1,26 +1,26 @@
-ivoryos/__init__.py,sha256=1v6LwuIao8WbmSskifzdfde7E_gH3PWCYaNpLaRtYZk,7341
+ivoryos/__init__.py,sha256=6zTQ5B7Pu99pv33LMpyYb6u0dz_TVSY9TVShXKAkrFs,7959
 ivoryos/config.py,sha256=3FPBYTIBhQTKDvsEoR8ZeTmg65D-CSFEdGmOuIL4pSI,1311
-ivoryos/version.py,sha256=d4QHYmS_30j0hPN8NmNPnQ_Z0TphDRbu4MtQj9cT9e8,22
+ivoryos/version.py,sha256=acuR_XSJzp4OrQ5T8-Ac5gYe48mUwObuwjRmisFmZ7k,22
 ivoryos/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ivoryos/routes/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ivoryos/routes/auth/auth.py,sha256=7CdXjGAr1B_xsmwweakTWOoROgsOJf0MNTzlMP_5Nus,3240
+ivoryos/routes/auth/auth.py,sha256=pvrYQN2XqH2OpZMxirFQZr9-c8yO29CpvQg9VR6JFsE,3256
 ivoryos/routes/auth/templates/auth/login.html,sha256=WSRrKbdM_oobqSXFRTo-j9UlOgp6sYzS9tm7TqqPULI,1207
 ivoryos/routes/auth/templates/auth/signup.html,sha256=b5LTXtpfTSkSS7X8u1ldwQbbgEFTk6UNMAediA5BwBY,1465
 ivoryos/routes/control/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ivoryos/routes/control/control.py,sha256=AbJA1dwWAWZi3eGnsbNObPASVsN7pZbL6la25xB52hI,14209
+ivoryos/routes/control/control.py,sha256=AaXqXqaIIed9xBVQsk52CNnNDTSofje5qQAfDGWd1Q0,16404
 ivoryos/routes/control/templates/control/controllers.html,sha256=iIp0h6WA68gQj9OsoiB7dU1BqH8CGomTueR73F4C8eY,4274
-ivoryos/routes/control/templates/control/controllers_home.html,sha256=VQ77HRvBlyBrQ3al5fcKF5Y6_vKtU8WeAhilqQQltAo,2997
+ivoryos/routes/control/templates/control/controllers_home.html,sha256=qAM4iZBEuXvSgGUWWVVIe2E9MPJOeG7U214hYM84jIE,2976
 ivoryos/routes/control/templates/control/controllers_new.html,sha256=uOQo9kYmwX2jk3KZDkMUF_ylfNUIs_oIWb_kk_MMVDM,4921
 ivoryos/routes/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ivoryos/routes/database/database.py,sha256=97387fF6tQIfb-BF6krILRP4a4_8jOJmGcE7BoPgjmk,9127
-ivoryos/routes/database/templates/database/experiment_database.html,sha256=edlCcKfrS91gGG1dPFQjC9xD7F7nWNNqS3S6Oa7apzs,3460
-ivoryos/routes/database/templates/database/experiment_step_view.html,sha256=u8_XYhiZ98PzglMzFEkuM1Tk9hVWf79xXIrpHVDxKa0,3618
+ivoryos/routes/database/database.py,sha256=JwFuWf9WHju0CepkuSz6OaOwV6O2f76Vv_0myCFMPFc,9833
+ivoryos/routes/database/templates/database/scripts_database.html,sha256=tEpKOj1UGz7mcDq11guwP48XJxwawjxjPvxRhKiIG2I,3640
 ivoryos/routes/database/templates/database/step_card.html,sha256=F4JRfacrEQfk2rrEbcI_i7G84nzKKDmCrMSmStLb4W4,290
-ivoryos/routes/database/templates/database/workflow_run_database.html,sha256=MczK9my9u0SyQsMFLbc6CXeZqKaBo5vk1SpwjkcZdqk,3571
+ivoryos/routes/database/templates/database/workflow_database.html,sha256=fsJHrYeEHGBKRn1pIxWITE6e93tdZsXH3zRs9Ob5FX0,4467
+ivoryos/routes/database/templates/database/workflow_view.html,sha256=u8_XYhiZ98PzglMzFEkuM1Tk9hVWf79xXIrpHVDxKa0,3618
 ivoryos/routes/design/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ivoryos/routes/design/design.py,sha256=ameAcgTLlrfOENUa48xxp64psuh2aZ0JuVfIj7zj-LM,28968
-ivoryos/routes/design/templates/design/experiment_builder.html,sha256=rEdcHj5onJG_4MejdFBPnJVzsvCMp1KDteqNkpx24kQ,29430
-ivoryos/routes/design/templates/design/experiment_run.html,sha256=7VP0Vo98phcYnFennd5vqaMK1M1QBwDmM-b9aZb8jOw,26282
+ivoryos/routes/design/design.py,sha256=ui9GvLoJ-0XNZT6q13KPgDh4NEEbVxaHKYcBtDqEkao,29866
+ivoryos/routes/design/templates/design/experiment_builder.html,sha256=4JjkwdMAWZA1XrGtoqBKykDikf-Qg7RbjqedqY_J-fU,32326
+ivoryos/routes/design/templates/design/experiment_run.html,sha256=UFqg6GMgkyYJfc1Ifg1jhyJggdZkCYpgQrNotiXWzwc,25582
 ivoryos/routes/main/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ivoryos/routes/main/main.py,sha256=yuVJzXAob1kc1dfflkTBIZQ0tdf6kChfuq-uQlN1e9Q,957
 ivoryos/routes/main/templates/main/help.html,sha256=IOktMEsOPk0SCiMBXZ4mpffClERAyX8W82fel71M3M0,9370
@@ -33,20 +33,20 @@ ivoryos/static/gui_annotation/Slide2.PNG,sha256=z3wQ9oVgg4JTWVLQGKK_KhtepRHUYP1e
 ivoryos/static/js/overlay.js,sha256=dPxop19es0E0ZUSY3d_4exIk7CJuQEnlW5uTt5fZfzI,483
 ivoryos/static/js/socket_handler.js,sha256=2Iyv_3METjhSlSavs_L9FE3PKY4xDEpfzJpd2FywY9o,5300
 ivoryos/static/js/sortable_card.js,sha256=ifmlGe3yy0U_KzMphV4ClRhK2DLOvkELYMlq1vECuac,807
-ivoryos/static/js/sortable_design.js,sha256=wwpKfIzZGDxfX3moNz0cvPvm9YyHmopZK3wmkUdnBiw,4333
+ivoryos/static/js/sortable_design.js,sha256=d55AEz8LpPX_j-hREom-I19i4l-SOG2RVSR4CnozRtY,4366
 ivoryos/templates/base.html,sha256=sDdwqOIUP2Get-py4E59PkieoGWLFpX6wAJe93s4aRo,8518
 ivoryos/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ivoryos/utils/bo_campaign.py,sha256=CVs7q15Pm2SRuJNaCvZKIxOFuv1xibM2yymtpAMAWOk,3285
-ivoryos/utils/client_proxy.py,sha256=AzcSQGMqeCqVULP1a7vEKNe135NZYryVX63ke0wgK04,2099
+ivoryos/utils/client_proxy.py,sha256=0OT2xTMkqh_2ybgCxMV_71ZVUThWwrsnAhTIBY5vDR8,2095
 ivoryos/utils/db_models.py,sha256=zlmmD2600CYyn79gQq8k0Vra7BDBKJBAyNLYclIWdvs,27382
-ivoryos/utils/form.py,sha256=b3JKxRc1jN45-bXyfzSJT1lcssUuxT86FhRmNUDv5-U,20973
+ivoryos/utils/form.py,sha256=k9d4AZz74FeOh4gkhDsZx3g4LZti_aJm9ZPRBkpOsE0,21933
 ivoryos/utils/global_config.py,sha256=OqfDrPgOzRdIUMD4V3pA9t6b-BATMjGZl8Jn7nkI56k,2138
 ivoryos/utils/llm_agent.py,sha256=-lVCkjPlpLues9sNTmaT7bT4sdhWvV2DiojNwzB2Lcw,6422
-ivoryos/utils/script_runner.py,sha256=k7bH9AeFGhx2tns-81q0JZFLCM9cvXCpZF7bH80RVzo,14504
+ivoryos/utils/script_runner.py,sha256=0b5hLKAF2o0SQKiArhUsG8-4MA-eniAcjwi8gCNVwtY,14542
 ivoryos/utils/task_runner.py,sha256=u4nF0wOADu_HVlGYVTOXnUm1woWGgYAccr-ZCzgtb6Q,2899
-ivoryos/utils/utils.py,sha256=OBwrRu02yh7pqG_lyl10zWr_RYes3xhMporxIz8lGYI,13579
-ivoryos-1.0.1.dist-info/LICENSE,sha256=p2c8S8i-8YqMpZCJnadLz1-ofxnRMILzz6NCMIypRag,1084
-ivoryos-1.0.1.dist-info/METADATA,sha256=KEh9s448whM6VP-Knc5UUjl7DpoME989pKBfwLxFcHM,6992
-ivoryos-1.0.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-ivoryos-1.0.1.dist-info/top_level.txt,sha256=FRIWWdiEvRKqw-XfF_UK3XV0CrnNb6EmVbEgjaVazRM,8
-ivoryos-1.0.1.dist-info/RECORD,,
+ivoryos/utils/utils.py,sha256=nGSw3vHkxXedX4T-AFEWGzDIU7h0NjrAf0wBt0Og9pk,13886
+ivoryos-1.0.4.dist-info/LICENSE,sha256=p2c8S8i-8YqMpZCJnadLz1-ofxnRMILzz6NCMIypRag,1084
+ivoryos-1.0.4.dist-info/METADATA,sha256=Z1w1rUuHTx3MWyDwSYo3dIj6bdoUhcSHgUvVYnSVU74,8906
+ivoryos-1.0.4.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+ivoryos-1.0.4.dist-info/top_level.txt,sha256=FRIWWdiEvRKqw-XfF_UK3XV0CrnNb6EmVbEgjaVazRM,8
+ivoryos-1.0.4.dist-info/RECORD,,