AutoPumping 0.1.0__tar.gz → 0.1.2__tar.gz

{autopumping-0.1.0 → autopumping-0.1.2}/AutoPumping.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoPumping
-Version: 0.1.0
+Version: 0.1.2
 Summary: A tool to automate pumping of vacuum systems
 Author-email: Cameron Devine <cameron.devine@alleninstitute.org>
 License-Expression: BSD-3-Clause
@@ -18,6 +18,7 @@ Requires-Dist: nicegui
 Requires-Dist: pyvis
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: bump-my-version; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: jsonschema2md; extra == "docs"

{autopumping-0.1.0 → autopumping-0.1.2}/AutoPumping.egg-info/SOURCES.txt

@@ -17,4 +17,5 @@ auto_pumping/ui.py
 test/test_config.py
 test/test_executor.py
 test/test_graph.py
+test/test_safety.py
 test/test_ui.py

{autopumping-0.1.0 → autopumping-0.1.2}/AutoPumping.egg-info/requires.txt

@@ -6,6 +6,7 @@ pyvis
 
 [dev]
 pytest
+pytest-mock
 bump-my-version
 
 [docs]

{autopumping-0.1.0 → autopumping-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoPumping
-Version: 0.1.0
+Version: 0.1.2
 Summary: A tool to automate pumping of vacuum systems
 Author-email: Cameron Devine <cameron.devine@alleninstitute.org>
 License-Expression: BSD-3-Clause
@@ -18,6 +18,7 @@ Requires-Dist: nicegui
 Requires-Dist: pyvis
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: bump-my-version; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: jsonschema2md; extra == "docs"

{autopumping-0.1.0 → autopumping-0.1.2}/auto_pumping/executor.py

@@ -137,7 +137,7 @@ class PlanExecutor:
         )
 
     def _plan_executor(self):
-        while self._plan is not None and len(self._plan) > 0:
+        while self._current_step is not None or (self._plan is not None and len(self._plan) > 0):
             if self._current_step is None:
                 self._current_step = self._plan.pop(0)
             step = self._current_step

{autopumping-0.1.0 → autopumping-0.1.2}/auto_pumping/graph.py

@@ -1,5 +1,3 @@
-import re
-
 from networkx import DiGraph, dijkstra_path, dijkstra_path_length, relabel_nodes
 from yaml import Node
 from .config import ValveState, PumpState, Inequality, StrictModel
@@ -264,12 +262,7 @@ class PumpingGraph:
                 return PlanStep(pump=pump, state=state)
         raise ValueError("No difference between states")
 
-    def make_plan(self, start_state, **goal_state_data):
-        if not isinstance(start_state, NodeModel):
-            start_state = NodeModel(**start_state)
-        if not isinstance(start_state, UUID):
-            start_state = self._find_state(start_state)
-        assert start_state is not None, f"Cannot find state {start_state}"
+    def _make_plan(self, start_state, **goal_state_data):
         goal_lengths = sorted(
             [
                 (
@@ -290,6 +283,20 @@ class PumpingGraph:
                 yield PlanStep(wait=edge_data["wait"])
             yield self._state_diff(start_node_data, end_node_data)
 
+    def make_plan(self, start_state, **goal_state_data):
+        if not isinstance(start_state, NodeModel):
+            start_state = NodeModel(**start_state)
+        start_state_id = self._find_state(start_state)
+        assert start_state_id is not None, f"Cannot find state {start_state}"
+        plan = list(self._make_plan(start_state_id, **goal_state_data))
+        if plan[0].valve is not None and plan[0].valve == plan[1].valve:
+            plan = plan[2:]
+        elif plan[0].pump is not None and plan[0].pump == plan[1].pump:
+            plan = plan[2:]
+        elif plan[0].stage is not None and plan[1].stage == start_state.stage:
+            plan = plan[2:]
+        return plan
+
     def draw(self, output_file=None, port=8000):
         net = Network(height="100vh", width="100%", directed=True)
         graph = relabel_nodes(self._graph, str, copy=True)

{autopumping-0.1.0 → autopumping-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "AutoPumping"
-version = "0.1.0"
+version = "0.1.2"
 description = "A tool to automate pumping of vacuum systems"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -30,6 +30,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
   "pytest",
+  "pytest-mock",
   "bump-my-version",
 ]
 docs = [
@@ -40,7 +41,7 @@ docs = [
 packages = ["auto_pumping"]
 
 [tool.bumpversion]
-current_version = "0.1.0"
+current_version = "0.1.2"
 commit = true
 # The CI publish job only runs for tags of the form `v<version>`.
 tag = true

{autopumping-0.1.0 → autopumping-0.1.2}/test/test_graph.py

@@ -268,3 +268,117 @@ def test_make_plan(graph):
         PlanStep(valve="VA", state="open"),
         PlanStep(stage="microscope"),
     ]
+
+
+@mark.parametrize(
+    "state",
+    [
+        {
+            "valves": {
+                "VA": "closed",
+                "VB": "closed",
+                "VE": "closed",
+                "VT": "open",
+                "VF": "open",
+                "VR": "closed",
+                "VV1": "closed",
+            },
+            "pumps": {
+                "roughing": "on",
+                "turbo": "on",
+            },
+            "gauges": {
+                "PLL": (4.5e-5, 0.1),
+            },
+            "stage": "loadlock",
+        },
+        {
+            "valves": {
+                "VA": "closed",
+                "VB": "closed",
+                "VE": "open",
+                "VT": "open",
+                "VF": "open",
+                "VR": "closed",
+                "VV1": "closed",
+            },
+            "pumps": {
+                "roughing": "on",
+                "turbo": "on",
+            },
+            "gauges": {
+                "PLL": (9e-6, 4.5e-5),
+            },
+            "stage": "loadlock",
+        },
+    ],
+)
+def test_make_plan_no_loops(graph, state):
+    plan = list(graph.make_plan(state, name="imaging"))
+    assert plan is not None
+    for i in range(len(plan) - 1):
+        step1 = plan[i]
+        step2 = plan[i + 1]
+        assert step1.valve is None or step1.valve != step2.valve
+        assert step1.pump is None or step1.pump != step2.pump
+
+
+@mark.parametrize(
+    "plan, steps_removed",
+    [
+        (
+            [
+                PlanStep(valve="VF", state="closed"),
+                PlanStep(valve="VF", state="open"),
+                PlanStep(wait={"PLL": Inequality(LE=0.1)}),
+                PlanStep(pump="roughing", state="off"),
+            ],
+            2,
+        ),
+        (
+            [
+                PlanStep(valve="VR", state="closed"),
+                PlanStep(valve="VF", state="open"),
+                PlanStep(valve="VR", state="open"),
+            ],
+            0,
+        ),
+        (
+            [
+                PlanStep(pump="roughing", state="off"),
+                PlanStep(pump="roughing", state="on"),
+                PlanStep(valve="VR", state="closed"),
+            ],
+            2,
+        ),
+        (
+            [
+                PlanStep(pump="turbo", state="off"),
+                PlanStep(pump="roughing", state="off"),
+                PlanStep(valve="VV1", state="open"),
+            ],
+            0,
+        ),
+        (
+            [
+                PlanStep(stage="loadlock"),
+                PlanStep(stage="microscope"),
+                PlanStep(valve="VR", state="closed"),
+            ],
+            2,
+        ),
+        (
+            [
+                PlanStep(stage="loadlock"),
+                PlanStep(stage="exchange"),
+                PlanStep(valve="VA", state="closed"),
+            ],
+            0,
+        ),
+    ],
+)
+def test_remove_redundant_steps(graph, plan, steps_removed):
+    graph._make_plan = lambda *args, **kwargs: plan
+    graph._find_state = lambda *args, **kwargs: True
+    assert graph.make_plan({"stage": "microscope"}) == plan[steps_removed:]
+

autopumping-0.1.2/test/test_safety.py

@@ -0,0 +1,103 @@
+from auto_pumping.safety import SafetyMachine
+from auto_pumping.config import PumpState, ValveState
+from pytest import mark
+
+
+@mark.parametrize(
+    "valve_states, turbo_current, gauge_pressure, VF_open_time, can_open_VT",
+    [
+        (
+            {
+                "VT": ValveState.CLOSED,
+                "VA": ValveState.CLOSED,
+                "VB": ValveState.CLOSED,
+                "VF": ValveState.OPEN,
+                "VR": ValveState.CLOSED,
+                "VE": ValveState.CLOSED,
+                "VV1": ValveState.CLOSED,
+            },
+            0.55,
+            0.09,
+            11,
+            True,
+        ),
+        (
+            {
+                "VT": ValveState.CLOSED,
+                "VA": ValveState.CLOSED,
+                "VB": ValveState.CLOSED,
+                "VF": ValveState.OPEN,
+                "VR": ValveState.CLOSED,
+                "VE": ValveState.CLOSED,
+                "VV1": ValveState.CLOSED,
+            },
+            0.55,
+            0.09,
+            9,
+            False,
+        ),
+        (
+            {
+                "VT": ValveState.CLOSED,
+                "VA": ValveState.CLOSED,
+                "VB": ValveState.CLOSED,
+                "VF": ValveState.OPEN,
+                "VR": ValveState.CLOSED,
+                "VE": ValveState.CLOSED,
+                "VV1": ValveState.CLOSED,
+            },
+            0.65,
+            0.09,
+            11,
+            False,
+        ),
+        (
+            {
+                "VT": ValveState.CLOSED,
+                "VA": ValveState.CLOSED,
+                "VB": ValveState.CLOSED,
+                "VF": ValveState.OPEN,
+                "VR": ValveState.CLOSED,
+                "VE": ValveState.CLOSED,
+                "VV1": ValveState.CLOSED,
+            },
+            0.55,
+            1.1,
+            11,
+            False,
+        ),
+        (
+            {
+                "VT": ValveState.CLOSED,
+                "VA": ValveState.CLOSED,
+                "VB": ValveState.CLOSED,
+                "VF": ValveState.CLOSED,
+                "VR": ValveState.CLOSED,
+                "VE": ValveState.CLOSED,
+                "VV1": ValveState.CLOSED,
+            },
+            0.55,
+            0.09,
+            11,
+            False,
+        ),
+    ],
+)
+def test_crossover_VT_open(config, mocker, valve_states, turbo_current, gauge_pressure, VF_open_time, can_open_VT):
+    time = mocker.patch("auto_pumping.safety.time", return_value=100)
+
+    mock_pumping_system = mocker.Mock()
+    mock_pumping_system.get_valve_state.side_effect = valve_states.get
+    mock_pumping_system.get_pump_state.return_value = PumpState.ON
+    mock_pumping_system.get_pump_current.side_effect = lambda pump: turbo_current if pump == "turbo" else None
+    mock_pumping_system.get_pump_voltage.side_effect = lambda pump: 24 if pump == "turbo" else None
+    mock_pumping_system.get_pump_flow.return_value = None
+    mock_pumping_system.get_pump_speed.side_effect = lambda pump: 1000 if pump == "turbo" else None
+    mock_pumping_system.get_gauge_pressure.return_value = gauge_pressure
+    mock_pumping_system.get_stage_position.return_value = "loadlock"
+
+    safety_machine = SafetyMachine(config, mock_pumping_system)
+
+    time.return_value += VF_open_time
+
+    assert safety_machine.can_actuate_valve("VT", "open") == can_open_VT