first commit

Dockerfile

@@ -0,0 +1,20 @@
+# Base image with Python
+FROM python:3.10-slim
+
+# Set working directory
+WORKDIR /app
+
+# Copy the entire project into the container
+COPY . /app
+
+# Install dependencies
+RUN pip install --no-cache-dir -r requirements.txt
+
+# If your app has additional requirements:
+# RUN pip install --no-cache-dir -r requirements.txt
+
+# Expose the default port
+EXPOSE 7860
+
+# Run your app
+CMD ["python", "app.py"]

README.md

@@ -1,11 +1,3 @@
----
-title: IvoryOS
-emoji: 📊
-colorFrom: green
-colorTo: pink
-sdk: docker
-pinned: false
-license: mit
----
+# IvoryOS-HF Space
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+A demonstration of Ivory OS running in a Flask app inside a Hugging Face Space.

app.py

@@ -0,0 +1,14 @@
+from demo_code_plugin.demo_code import pump, sdl, balance
+from demo_code_plugin.plugin import source_code
+
+if __name__ == "__main__":
+    import ivoryos
+    from ivoryos.config import Config
+    _config = Config()
+    _config.SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:'
+    # from ivoryos_plugin.hello_world import plugin
+    # USE CASE 1 - start OS using current module
+    ivoryos.run(__name__, config=_config, blueprint_plugins=source_code, port=7860)
+
+    # # USE CASE 2 - start OS using current module and enable LLM with Ollama
+    # ivoryos.run(__name__, model="llama3.1", llm_server='localhost')

demo_code_plugin/demo_code.py

@@ -0,0 +1,115 @@
+import logging
+import time
+from abc import ABC
+
+import ivoryos
+
+
+class AbstractPump:
+
+    def __init__(self, com_port: str):
+        self.com_port = com_port
+        self.dictionary = {}
+        self.logger = logging.getLogger("pump")
+
+    def dose_liquid(self, amount_in_ml: float, rate_ml_per_minute: float = 1):
+        """dose liquid"""
+        self.logger.info("dosing liquid")
+        self.logger.info(f"pretending dosing {amount_in_ml} at {rate_ml_per_minute} ml/min")
+        return 1
+
+
+
+class AbstractBalance:
+
+    def __init__(self, com_port: str):
+        self.com_port = com_port
+        self._value = None
+        self.logger = logging.getLogger("balance")
+
+    @property
+    def setter_value(self):
+        return self._value
+
+    @setter_value.setter
+    def setter_value(self, value):
+        self._value = value
+
+    def weigh_sample(self):
+        time.sleep(1)
+        self.logger.info(f"Weighing sample using {self.com_port}")
+        return 1
+
+    def dose_solid(self, amount_in_mg: float):
+        """this function is used to dose solid"""
+        time.sleep(1)
+        self.logger.info(f"Dosing {amount_in_mg} mg using {self.com_port}")
+        return 1
+
+    def _helper(self):
+        """helper function will not be extracted and displayed over function panel"""
+        pass
+
+
+
+
+class AbstractSDL(ABC):
+    def __init__(self, pump: AbstractPump, balance: AbstractBalance):
+        self.pump = pump
+        self.balance = balance
+        self.logger = logging.getLogger(f"logger_name")
+
+    def analyze(self):
+        self.logger.info("analyze")
+        time.sleep(1)
+        return 1
+
+
+    def dose_solid(self,
+                   amount_in_mg: float = 5,
+                   solid_name: str = "Acetaminophen"
+                   ):
+        """dose current chemical"""
+        print("dosing solid")
+        self.balance.dose_solid(amount_in_mg=amount_in_mg)
+        self.balance.weigh_sample()
+        time.sleep(1)
+        self.logger.info(f"dosing solid {amount_in_mg} mg of {solid_name}")
+        return 1
+
+    def dose_solvent(self,
+                     solvent_name: str = "Methanol",
+                     amount_in_ml: float = 5,
+                     rate_ml_per_minute: float = 1
+                     ):
+        print("dosing liquid")
+        self.logger.info(f"dosing {amount_in_ml} ml of {solvent_name} solvent at {rate_ml_per_minute} ml/min")
+        time.sleep(1)
+        return 1
+
+
+    def equilibrate(self,
+                    temp: float,
+                    duration: float
+                    ):
+        print("equilibrate")
+        self.logger.info(f"equilibrate at {temp} for {duration}")
+        time.sleep(1)
+
+    def simulate_error(self):
+        raise ValueError("some error")
+
+    def _send_command(self):
+        """helper function"""
+        pass
+
+
+
+# initializing hardware
+balance = AbstractBalance("Fake com port 1")
+pump = AbstractPump("Fake com port 2")
+sdl = AbstractSDL(pump, balance)
+
+
+if __name__ == "__main__":
+    ivoryos.run(__name__)

demo_code_plugin/plugin.py

@@ -0,0 +1,16 @@
+import ivoryos
+from flask import render_template, Blueprint, current_app
+import os
+
+source_code = Blueprint("source_code", __name__, template_folder=os.path.join(os.path.dirname(__file__), "templates"))
+
+# # [main route] the route url can be anything, but "main" is needed as entry point
+@source_code.route('/')
+def main():
+    base_exists = "base.html" in current_app.jinja_loader.list_templates()
+    filepath = os.path.join(os.path.dirname(__file__), 'demo_code.py')
+    with open(filepath, 'r', encoding='utf-8') as f:
+        code = f.read()
+    return render_template('example.html', base_exists=base_exists, code=code)
+
+

demo_code_plugin/templates/example.html

@@ -0,0 +1,22 @@
+{% if base_exists %}
+    {% extends 'base.html' %}
+    {% block title %}Source code{% endblock %}
+{% else %}
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/css/bootstrap.min.css" integrity="sha384-aFq/bzH65dt+w6FI2ooMVUpc+21e0SRygnTpmBvdBgSdnuTN7QbdgL+OapgHtvPp" crossorigin="anonymous">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.css">
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/js/bootstrap.bundle.min.js" integrity="sha384-qKXV1j0HvMUeCBQ+QVp7JcfGl760yU08IQ+GpUo5hlbpg51QRiuqHAJz8+BrxE/N" crossorigin="anonymous"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+    </head>
+{% endif %}
+
+
+{% block body %}
+    <div class="container mt-4">
+        <h2>Source Code</h2>
+        <pre><code class="language-python">{{ code|e }}</code></pre>
+    </div>
+{% endblock %}

requirements.txt

@@ -0,0 +1 @@
+ivoryos>=1.0.4