Merge pull request #84 from festim-dev/fix-bubbler-to-python

Fix bubbler block not having reset times in python script

Author: RemDelaporteMathurin

saved_graphs/baby.json

@@ -175,7 +175,7 @@
         "label": "IV bubbler",
         "conversion_efficiency": "0.95",
         "vial_efficiency": "0.9",
-        "replacement_time": "np.arange(5, 50, step=3)"
+        "replacement_times": "np.arange(5, 50, step=3)"
       },
       "measured": {
         "width": 230,
@@ -233,7 +233,7 @@
         "label": "OV bubbler",
         "conversion_efficiency": "0.95",
         "vial_efficiency": "0.9",
-        "replacement_time": "np.arange(5, 50, step=5)"
+        "replacement_times": "np.arange(5, 50, step=5)"
       },
       "measured": {
         "width": 230,

src/App.jsx

@@ -601,7 +601,7 @@ export default function App() {
         nodeData = { ...nodeData, f1: '1/3', f2: '1/3', f3: '1/3' };
         break;
       case 'bubbler':
-        nodeData = { ...nodeData, conversion_efficiency: '0.95', vial_efficiency: '0.9', replacement_time: '' };
+        nodeData = { ...nodeData, conversion_efficiency: '0.95', vial_efficiency: '0.9', replacement_times: '' };
       default:
         // For any other types, just use basic data
         break;

src/custom_pathsim_blocks.py

@@ -169,4 +169,5 @@ def create_reset_events(self) -> list[pathsim.blocks.Schedule]:
             )
         for i, vial in enumerate(self.vials):
             events.extend(self._create_reset_events_one_vial(vial, reset_times[i]))
+
         return events

src/pathsim_utils.py

@@ -144,8 +144,8 @@ def create_bubbler(node: dict) -> Bubbler:
     block = Bubbler(
         conversion_efficiency=eval(node["data"]["conversion_efficiency"]),
         vial_efficiency=eval(node["data"]["vial_efficiency"]),
-        replacement_times=eval(node["data"]["replacement_time"])
-        if node["data"].get("replacement_time") != ""
+        replacement_times=eval(node["data"]["replacement_times"])
+        if node["data"].get("replacement_times") != ""
         else None,
     )
 

src/templates/block_macros.py

@@ -14,22 +14,34 @@
 {{ create_block(node) }}
 
 {%- if node["data"].get("reset_times") %}
-def reset_itg(_):
+def reset_{{ node["var_name"] }}(_):
     {{ node["var_name"] }}.reset()
 
 for t in {{ node["data"].get("reset_times", "[]") }}:
     events.append(
         pathsim.events.Schedule(
             t_start=t,
             t_end=t,
-            func_act=reset_itg,
+            func_act=reset_{{ node["var_name"] }},
         )
     )
 {%- endif %}
 
 {%- endmacro -%}
 
 
+{% macro create_bubbler_block(node) -%}
+{{ create_block(node) }}
+
+{%- if node["data"].get("replacement_times") %}
+events_{{ node["var_name"] }} = {{ node["var_name"] }}.create_reset_events()
+events += events_{{ node["var_name"] }}
+{%- endif %}
+
+{%- endmacro -%}
+
+
+
 {% macro create_function_block(node) -%}
 
 def func(x):

src/templates/template_with_macros.py

@@ -4,7 +4,7 @@
 import matplotlib.pyplot as plt
 import src
 {# Import macros #}
-{% from 'block_macros.py' import create_block, create_source_block, create_integrator_block, create_function_block, create_scope_block, create_stepsource, create_connections -%}
+{% from 'block_macros.py' import create_block, create_source_block, create_integrator_block, create_function_block, create_scope_block, create_stepsource, create_bubbler_block, create_connections -%}
 
 # Create global variables
 {% for var in globalVariables -%}
@@ -22,6 +22,9 @@
 {{ create_function_block(node) }}
 {%- elif node["type"] == "scope" -%}
 {{ create_scope_block(node) }}
+{%- elif node["type"] == "bubbler" -%}
+{{ create_bubbler_block(node) }}
+{%- elif node["type"] == "source" -%}
 {%- else -%}
 {{ create_block(node) }}
 {%- endif %}

test/test_convert_python.py

@@ -127,5 +127,39 @@ def test_stepsource_delay_converted_to_tau():
     assert "tau=3.0" in code
 
 
+def test_bubbler_has_reset_times():
+    """Test that the bubbler node has reset times in the generated code."""
+    sample_data = {
+        "nodes": [
+            {
+                "id": "1",
+                "type": "bubbler",
+                "data": {
+                    "label": "bubbler_1",
+                    "replacement_times": "[10, 20]",
+                    "conversion_efficiency": "1",
+                    "vial_efficiency": "0.8",
+                },
+            },
+        ],
+        "edges": [],
+        "solverParams": {
+            "Solver": "SSPRK22",
+            "dt": "0.01",
+            "dt_max": "1.0",
+            "dt_min": "1e-6",
+            "extra_params": "{}",
+            "iterations_max": "100",
+            "log": "true",
+            "simulation_duration": "duration",
+            "tolerance_fpi": "1e-6",
+        },
+        "globalVariables": [],
+    }
+    code = convert_graph_to_python(sample_data)
+    print(code)
+    assert "bubbler_1.create_reset_events()" in code
+
+
 if __name__ == "__main__":
     test_nested_templates()