dyanmically fetch available calibrations from the worker. Some js utilties for tasks

Author: CamDavidsonPilon

core/pioreactor/calibrations/protocols/od_reference_standard.py

@@ -261,7 +261,13 @@ def get_reference_standard_step(
 class ODReferenceStandardProtocol(CalibrationProtocol[pt.ODCalibrationDevices]):
     target_device = pt.OD_DEVICES
     protocol_name = "od_reference_standard"
+    title = "Optics Calibration Jig"
     description = "Calibrate OD using the Pioreactor Optical Reference Standard."
+    requirements = (
+        "OD reading must be off before starting.",
+        "Insert the Optics Calibration Jig.",
+        "Set ir_led_intensity in [od_reading.config] to a numeric value.",
+    )
     step_registry: ClassVar[StepRegistry] = _REFERENCE_STANDARD_STEPS
 
     @classmethod

core/pioreactor/calibrations/protocols/od_standards.py

@@ -581,7 +581,13 @@ def get_standards_step(
 class StandardsODProtocol(CalibrationProtocol[pt.ODCalibrationDevices]):
     target_device = pt.OD_DEVICES
     protocol_name = "standards"
-    description = "Calibrate OD using standards. Requires multiple vials"
+    title = "OD standards calibration"
+    description = "Calibrate OD channels using a series of OD600 standards and a blank."
+    requirements = (
+        "OD reading and stirring must be off before starting.",
+        "Have OD600 standards ready (including a blank).",
+        "Each vial should include a stir bar.",
+    )
     step_registry: ClassVar[StepRegistry] = _OD_STANDARDS_STEPS
 
     @classmethod

core/pioreactor/calibrations/protocols/pump_duration_based.py

@@ -514,6 +514,12 @@ def run_pump_calibration(
 class DurationBasedPumpProtocol(CalibrationProtocol[pt.PumpCalibrationDevices]):
     target_device = pt.PUMP_DEVICES
     protocol_name = "duration_based"
+    title = "Duration-based pump calibration"
+    description = "Build a duration-to-volume curve for the {device} pump using a simple multi-step flow."
+    requirements = (
+        "Place the outflow tube into a measuring container or scale.",
+        "Have clean water available for priming and tests.",
+    )
     step_registry: ClassVar[StepRegistry] = _PUMP_DURATION_STEPS
 
     @classmethod

core/pioreactor/calibrations/protocols/stirring_dc_based.py

@@ -268,6 +268,12 @@ def get_dc_based_step(
 class DCBasedStirringProtocol(CalibrationProtocol[Literal["stirring"]]):
     target_device = "stirring"
     protocol_name = "dc_based"
+    title = "Stirring DC-based calibration"
+    description = "Maps duty cycle to RPM for the current stirrer configuration."
+    requirements = (
+        "Stirring must be off before starting.",
+        "Insert a vial with a stir bar and the liquid volume you plan to use (water is fine).",
+    )
     step_registry: ClassVar[StepRegistry] = _DC_BASED_STEPS
 
     @classmethod

core/pioreactor/calibrations/registry.py

@@ -19,7 +19,9 @@
 class CalibrationProtocol(Generic[Device]):
     protocol_name: ClassVar[ProtocolName]
     target_device: ClassVar[str | list[str]]
+    title: ClassVar[str] = ""
     description: ClassVar[str] = ""
+    requirements: ClassVar[tuple[str, ...]] = ()
 
     def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)

core/pioreactor/web/api.py

@@ -1303,6 +1303,15 @@ def get_media_rates(experiment: str) -> ResponseReturnValue:
 ## CALIBRATIONS
 
 
+@api_bp.route("/workers/<pioreactor_unit>/calibration_protocols", methods=["GET"])
+def get_calibration_protocols(pioreactor_unit: str) -> DelayedResponseReturnValue:
+    if pioreactor_unit == UNIVERSAL_IDENTIFIER:
+        task = broadcast_get_across_workers("/unit_api/calibration_protocols")
+    else:
+        task = tasks.multicast_get("/unit_api/calibration_protocols", [pioreactor_unit])
+    return create_task_response(task)
+
+
 @api_bp.route("/workers/<pioreactor_unit>/calibrations", methods=["GET"])
 def get_all_calibrations(pioreactor_unit: str) -> DelayedResponseReturnValue:
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:

core/pioreactor/web/static/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "/static/static/css/main.9c7a48b7.css",
-    "main.js": "/static/static/js/main.e942ad86.js",
+    "main.js": "/static/static/js/main.552b6610.js",
     "static/media/pioreactor_cloud.webp": "/static/static/media/pioreactor_cloud.b15b29e435797dc69d76.webp",
     "static/media/roboto-all-500-normal.woff": "/static/static/media/roboto-all-500-normal.0ab669b7a0d19b178f57.woff",
     "static/media/roboto-all-700-normal.woff": "/static/static/media/roboto-all-700-normal.a457fde362a540fcadff.woff",
@@ -30,10 +30,10 @@
     "static/media/roboto-greek-ext-700-normal.woff2": "/static/static/media/roboto-greek-ext-700-normal.bd9854c751441ccc1a70.woff2",
     "index.html": "/static/index.html",
     "main.9c7a48b7.css.map": "/static/static/css/main.9c7a48b7.css.map",
-    "main.e942ad86.js.map": "/static/static/js/main.e942ad86.js.map"
+    "main.552b6610.js.map": "/static/static/js/main.552b6610.js.map"
   },
   "entrypoints": [
     "static/css/main.9c7a48b7.css",
-    "static/js/main.e942ad86.js"
+    "static/js/main.552b6610.js"
   ]
 }

core/pioreactor/web/static/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/static/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Pioreactor"/><link rel="apple-touch-icon" href="/static/logo192.png"/><link rel="manifest" href="/static/manifest.json"/><script defer="defer" src="/static/static/js/main.e942ad86.js"></script><link href="/static/static/css/main.9c7a48b7.css" rel="stylesheet"></head><body><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/static/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Pioreactor"/><link rel="apple-touch-icon" href="/static/logo192.png"/><link rel="manifest" href="/static/manifest.json"/><script defer="defer" src="/static/static/js/main.552b6610.js"></script><link href="/static/static/css/main.9c7a48b7.css" rel="stylesheet"></head><body><div id="root"></div></body></html>