more model stuff

Author: CamDavidsonPilon

core/pioreactor/automations/temperature/thermostat.py

@@ -5,10 +5,10 @@
 from pioreactor.background_jobs.temperature_automation import classproperty
 from pioreactor.background_jobs.temperature_automation import TemperatureAutomationJob
 from pioreactor.config import config
-from pioreactor.models import get_current_model
 from pioreactor.utils import clamp
 from pioreactor.utils import is_pio_job_running
 from pioreactor.utils.streaming_calculations import PID
+from pioreactor.whoami import get_pioreactor_model
 
 
 class Thermostat(TemperatureAutomationJob):
@@ -92,4 +92,4 @@ def set_target_temperature(self, target_temperature: float | str) -> None:
 
     @classproperty
     def MAX_TARGET_TEMP(cls) -> float:
-        return get_current_model().max_temp_to_reduce_heating
+        return get_pioreactor_model().max_temp_to_reduce_heating

core/pioreactor/background_jobs/monitor.py

@@ -25,7 +25,6 @@
 from pioreactor.hardware import PCB_BUTTON_PIN as BUTTON_PIN
 from pioreactor.hardware import PCB_LED_PIN as LED_PIN
 from pioreactor.hardware import TEMP
-from pioreactor.models import get_current_model
 from pioreactor.mureq import HTTPException
 from pioreactor.pubsub import get_from
 from pioreactor.pubsub import QOS
@@ -37,6 +36,7 @@
 from pioreactor.utils.timing import current_utc_timestamp
 from pioreactor.utils.timing import RepeatedTimer
 from pioreactor.utils.timing import to_datetime
+from pioreactor.whoami import get_pioreactor_model
 
 if whoami.is_testing_env():
     from pioreactor.utils.mock import MockCallback
@@ -84,7 +84,7 @@ def off(): # functions don't take any arguments, nothing is passed in
 
     @classproperty
     def MAX_TEMP_TO_SHUTDOWN(cls) -> float:
-        return get_current_model().max_temp_to_shutdown
+        return get_pioreactor_model().max_temp_to_shutdown
 
     @classproperty
     def MAX_TEMP_TO_SHUTDOWN_IF_NO_TEMP_AUTOMATION(cls) -> float:

core/pioreactor/background_jobs/temperature_automation.py

@@ -16,7 +16,6 @@
 from pioreactor.automations.base import AutomationJob
 from pioreactor.config import config
 from pioreactor.logging import create_logger
-from pioreactor.models import get_current_model
 from pioreactor.structs import Temperature
 from pioreactor.utils import clamp
 from pioreactor.utils import local_intermittent_storage
@@ -27,6 +26,7 @@
 from pioreactor.utils.timing import RepeatedTimer
 from pioreactor.utils.timing import to_datetime
 from pioreactor.version import rpi_version_info
+from pioreactor.whoami import get_pioreactor_model
 
 
 class classproperty(property):
@@ -35,7 +35,10 @@ def __get__(self, obj, objtype=None):
 
 
 def is_20ml_v1() -> bool:
-    return whoami.get_pioreactor_model() == "pioreactor_20ml" and whoami.get_pioreactor_version() == (1, 0)
+    return (
+        get_pioreactor_model().model_name == "pioreactor_20ml"
+        and get_pioreactor_model().model_version == (1, 0)
+    )
 
 
 class TemperatureAutomationJob(AutomationJob):
@@ -56,15 +59,15 @@ def INFERENCE_SAMPLES_EVERY_T_SECONDS(cls) -> float:
 
     @classproperty
     def MAX_TEMP_TO_REDUCE_HEATING(cls) -> float:
-        return get_current_model().max_temp_to_reduce_heating
+        return get_pioreactor_model().max_temp_to_reduce_heating
 
     @classproperty
     def MAX_TEMP_TO_DISABLE_HEATING(cls) -> float:
-        return get_current_model().max_temp_to_disable_heating
+        return get_pioreactor_model().max_temp_to_disable_heating
 
     @classproperty
     def MAX_TEMP_TO_SHUTDOWN(cls) -> float:
-        return get_current_model().max_temp_to_shutdown
+        return get_pioreactor_model().max_temp_to_shutdown
 
     @classproperty
     def INFERENCE_N_SAMPLES(cls) -> int:
@@ -378,13 +381,14 @@ def infer_temperature(self) -> None:
         features["time_series_of_temp"] = time_series_of_temp
         self.logger.debug(f"{features=}")
 
+        hardware_model = get_pioreactor_model()
         try:
-            if whoami.get_pioreactor_model() == "pioreactor_20ml":
-                if whoami.get_pioreactor_version() == (1, 0):
+            if hardware_model.model_name == "pioreactor_20ml":
+                if hardware_model.model_version == "1.0":
                     inferred_temperature = self.approximate_temperature_20_1_0(features)
-                elif whoami.get_pioreactor_version() >= (1, 1):
+                elif hardware_model.model_version >= "1.1":
                     inferred_temperature = self.approximate_temperature_20_2_0(features)
-            elif whoami.get_pioreactor_model() == "pioreactor_40ml":
+            elif hardware_model.model_name == "pioreactor_40ml":
                 inferred_temperature = self.approximate_temperature_20_2_0(features)  # TODO: change me back
             else:
                 raise ValueError("Unknown Pioreactor model.")

core/pioreactor/cli/pio.py

@@ -325,12 +325,12 @@ def version(verbose: bool) -> None:
         from pioreactor.version import serial_number
         from pioreactor.version import get_firmware_version
         from pioreactor.version import rpi_version_info
-        from pioreactor.whoami import get_pioreactor_model_and_version
+        from pioreactor.whoami import get_pioreactor_model
 
         click.echo(f"Pioreactor app:         {tuple_to_text(software_version_info)}")
         click.echo(f"Pioreactor HAT:         {tuple_to_text(hardware_version_info)}")
         click.echo(f"Pioreactor firmware:    {tuple_to_text(get_firmware_version())}")
-        click.echo(f"Model name:             {get_pioreactor_model_and_version()}")
+        click.echo(f"Model name:             {get_pioreactor_model().display_name}")
         click.echo(f"HAT serial number:      {serial_number}")
         click.echo(f"Operating system:       {platform.platform()}")
         click.echo(f"Raspberry Pi:           {rpi_version_info}")

core/pioreactor/models.py

@@ -4,24 +4,15 @@
 """
 from __future__ import annotations
 
-import logging
+import os
 from pathlib import Path
 
 from msgspec import ValidationError
 from msgspec.yaml import decode as yaml_decode
-from pioreactor.logging import create_logger
 from pioreactor.structs import Model
-from pioreactor.whoami import get_pioreactor_model
-from pioreactor.whoami import get_pioreactor_version
 from pioreactor.whoami import is_testing_env
 
 
-if not is_testing_env():
-    MODEL_DEFINITIONS_PATH = Path("/home") / "pioreactor" / ".pioreactor" / "models"
-else:
-    MODEL_DEFINITIONS_PATH = Path(".pioreactor") / "models"
-
-
 ## Built-in Pioreactor models with hard-coded defaults
 CORE_MODELS = {
     ("pioreactor_20ml", "1.0"): Model(
@@ -30,7 +21,7 @@
         display_name="Pioreactor 20ml, v1.0",
         reactor_capacity_ml=20.0,
         reactor_max_fill_volume_ml=18.0,
-        reactor_diameter_mm=20.0,
+        reactor_diameter_mm=27.0,
         max_temp_to_reduce_heating=63.0,
         max_temp_to_disable_heating=65.0,
         max_temp_to_shutdown=66.0,
@@ -41,18 +32,18 @@
         display_name="Pioreactor 20ml, v1.1",
         reactor_capacity_ml=20.0,
         reactor_max_fill_volume_ml=18.0,
-        reactor_diameter_mm=20.0,
-        max_temp_to_reduce_heating=63.0,
-        max_temp_to_disable_heating=65.0,
-        max_temp_to_shutdown=66.0,
+        reactor_diameter_mm=27.0,
+        max_temp_to_reduce_heating=78.0,
+        max_temp_to_disable_heating=80.0,
+        max_temp_to_shutdown=85.0,
     ),
     ("pioreactor_40ml", "1.0"): Model(
         model_name="pioreactor_40ml",
         model_version="1.0",
         display_name="Pioreactor 40ml, v1.0",
         reactor_capacity_ml=40.0,
         reactor_max_fill_volume_ml=38.0,
-        reactor_diameter_mm=40.0,
+        reactor_diameter_mm=27.0,
         max_temp_to_reduce_heating=78.0,
         max_temp_to_disable_heating=80.0,
         max_temp_to_shutdown=85.0,
@@ -62,6 +53,12 @@
 
 def load_contrib_model_definitions() -> list[Model]:
     """Load all model definitions from YAML files under MODEL_DEFINITIONS_PATH."""
+
+    if not is_testing_env():
+        MODEL_DEFINITIONS_PATH = Path("/home") / "pioreactor" / ".pioreactor" / "models"
+    else:
+        MODEL_DEFINITIONS_PATH = Path(os.environ["DOT_PIOREACTOR"]) / "models"
+
     models: list[Model] = []
     if not MODEL_DEFINITIONS_PATH.exists():
         return models
@@ -70,6 +67,8 @@ def load_contrib_model_definitions() -> list[Model]:
             m = yaml_decode(file.read_bytes(), type=Model)
             models.append(m)
         except ValidationError as e:
+            from pioreactor.logging import create_logger
+
             create_logger("models", experiment="$experiment").error(
                 f"Error loading model definition {file}: {e}"
             )
@@ -81,16 +80,3 @@ def load_contrib_model_definitions() -> list[Model]:
     **CORE_MODELS,
     **{(m.model_name, m.model_version): m for m in load_contrib_model_definitions()},
 }
-
-
-def get_current_model() -> Model:
-    """Return the Model struct for this Pioreactor (by env/EERPOM/HARDWARE env).
-    Falls back to the 20ml v1.0 factory default if unrecognized.
-    """
-    name = get_pioreactor_model()
-    version = ".".join(map(str, get_pioreactor_version()))
-    try:
-        return registered_models[(name, version)]
-    except KeyError:
-        logging.getLogger("pioreactor.models").error(f"Unknown Pioreactor model {name} v{version}")
-        raise ValueError(f"Unknown Pioreactor model {name} v{version}.")

core/pioreactor/structs.py

@@ -381,10 +381,10 @@ class Dataset(JSONPrintedStruct):
 
 
 class Model(Struct):
-    """Defines a Pioreactor model with its physical and automation parameters."""
+    """Defines a Pioreactor hardware model with its physical and automation parameters."""
 
-    model_name: str
-    model_version: str
+    model_name: str  # this in combination with model_version should form a unique pair
+    model_version: str  # this in combination with model_name should form a unique pair
     display_name: str
     # reactor capacity (e.g. 20 or 40 mL)
     reactor_capacity_ml: float

core/pioreactor/whoami.py

@@ -6,12 +6,15 @@
 import time
 import warnings
 from functools import cache
+from typing import TYPE_CHECKING
 
 from pioreactor import mureq
-from pioreactor import types as pt
 from pioreactor.exc import NotAssignedAnExperimentError
 from pioreactor.exc import NoWorkerFoundError
-from pioreactor.version import version_text_to_tuple
+
+if TYPE_CHECKING:
+    from pioreactor import types as pt
+    from pioreactor.structs import Model
 
 
 UNIVERSAL_IDENTIFIER = "$broadcast"
@@ -154,18 +157,32 @@ def am_I_a_worker() -> bool:
 
 
 @cache
-def get_pioreactor_version() -> tuple[int, int]:
+def get_pioreactor_model() -> Model:
+    """Return the Model struct for this Pioreactor (by env/EERPOM/HARDWARE env).
+    Falls back to the 20ml v1.0 factory default if unrecognized.
+    """
+    from pioreactor.models import registered_models
+
+    name = _get_pioreactor_model_name()
+    version = _get_pioreactor_model_version()
+    try:
+        return registered_models[(name, version)]
+    except KeyError:
+        raise ValueError(f"Unknown Pioreactor model {name} v{version}.")
+
+
+def _get_pioreactor_model_version() -> str:
     # pioreactor model version
     if os.environ.get("MODEL_VERSION"):
-        return version_text_to_tuple(os.environ["MODEL_VERSION"])
+        return os.environ["MODEL_VERSION"]
 
     from pioreactor.pubsub import get_from_leader
 
     try:
         result = get_from_leader(f"/api/workers/{get_unit_name()}")
         result.raise_for_status()
         data = result.json()
-        return version_text_to_tuple(data["model_version"])
+        return data["model_version"]
     except mureq.HTTPErrorStatus as e:
         if e.status_code == 404:
             raise NoWorkerFoundError(f"Worker {get_unit_name()} is not present in leader's inventory")
@@ -175,8 +192,7 @@ def get_pioreactor_version() -> tuple[int, int]:
         raise e
 
 
-@cache
-def get_pioreactor_model() -> str:
+def _get_pioreactor_model_name() -> str:
     # pioreactor model name
     if os.environ.get("MODEL_NAME"):
         return os.environ["MODEL_NAME"]
@@ -199,20 +215,6 @@ def get_pioreactor_model() -> str:
         raise e
 
 
-@cache
-def get_pioreactor_model_and_version() -> str:
-    try:
-        maybe_model = get_pioreactor_model()
-    except NoWorkerFoundError:
-        # possibly it's the leader-only?
-        return ""
-
-    if maybe_model:
-        return f"{maybe_model} v{'.'.join(map(str, get_pioreactor_version()))}"
-    else:
-        return ""
-
-
 @cache
 def get_image_git_hash() -> str:
     try:

frontend/src/Inventory.jsx

@@ -204,12 +204,12 @@ function AddNewPioreactor({setWorkers}){
         <FormControl required sx={{mt: "15px", ml: "10px", minWidth: "195px"}} variant="outlined" size="small">
           <InputLabel>Pioreactor model</InputLabel>
           <Select
-            value={`${model[0]},${model[1]}`}
+            value={`${model[0]}-${model[1]}`}
             onChange={handleModelVersionChange}
             label="Pioreactor model"
           >
             {useAvailableModels().map(({ model_name, model_version, display_name }) => (
-              <MenuItem key={`${model_name}-${model_version}`} value={`${model_name},${model_version}`}>
+              <MenuItem key={`${model_name}-${model_version}`} value={`${model_name}-${model_version}`}>
                 {display_name}
               </MenuItem>
             ))}
@@ -247,15 +247,21 @@ function AddNewPioreactor({setWorkers}){
 
 
 function WorkerCard({worker, config, leaderVersion}) {
+
+  const availableModels = useAvailableModels();
   const unit = worker.pioreactor_unit
   const isLeader = (config['cluster.topology']?.leader_hostname === unit)
   const [activeStatus, setActiveStatus] = React.useState(worker.is_active ? "active" : "inactive")
   const [model, setModel] = React.useState([worker.model_name, worker.model_version])
-  const availableModels = useAvailableModels();
-  const currentModelDisplayName =
+
+  const currentModelDetails =
     availableModels.find(
       ({model_name, model_version}) => model_name === model[0] && model_version === model[1]
-    )?.display_name || '';
+    );
+  const currentModelDisplayName = currentModelDetails ? currentModelDetails.display_name : "Unknown Model";
+  const currentModelCapacity = currentModelDetails ? currentModelDetails.reactor_capacity_ml : "";
+
+
   const [experimentAssigned, setExperimentAssigned] = React.useState(null)
   const {client, subscribeToTopic} = useMQTT();
   const [state, setState] = React.useState(null)
@@ -424,7 +430,7 @@ function WorkerCard({worker, config, leaderVersion}) {
         <div style={{display: "flex", justifyContent: "space-between"}}>
 
           <div style={{display: "flex", justifyContent: "left"}}>
-            <PioreactorIconWithModel badgeContent={model[0] === "pioreactor_40ml" ? "40" : "20"} />
+            <PioreactorIconWithModel badgeContent={currentModelCapacity} />
             <Typography sx={{
                 fontSize: 20,
                 color: "rgba(0, 0, 0, 0.87)",