opentrons 8.7.0a9__py3-none-any.whl → 8.8.0a7__py3-none-any.whl

opentrons/protocol_engine/types/__init__.py

@@ -25,6 +25,10 @@ from .command_annotations import (
     CustomCommandAnnotation,
     CommandAnnotation,
 )
+from .command_preconditions import (
+    CommandPreconditions,
+    PreconditionTypes,
+)
 from .partial_tip_configuration import (
     AllNozzleLayoutConfiguration,
     SingleNozzleLayoutConfiguration,
@@ -83,6 +87,8 @@ from .location import (
     NonStackedLocation,
     DeckPoint,
     InStackerHopperLocation,
+    WASTE_CHUTE_LOCATION,
+    AccessibleByGripperLocation,
     OnLabwareLocationSequenceComponent,
     OnModuleLocationSequenceComponent,
     OnAddressableAreaLocationSequenceComponent,
@@ -92,6 +98,7 @@ from .location import (
     LoadableLabwareLocation,
     labware_location_is_system,
     labware_location_is_off_deck,
+    labware_location_is_in_waste_chute,
 )
 from .labware import (
     OverlapOffset,
@@ -100,7 +107,6 @@ from .labware import (
     LegacyLabwareOffsetCreate,
     LabwareOffsetCreateInternal,
     LoadedLabware,
-    LabwareParentDefinition,
     LabwareWellId,
     GripSpecs,
 )
@@ -132,6 +138,7 @@ from .instrument import (
     CurrentWell,
     CurrentPipetteLocation,
     InstrumentOffsetVector,
+    GripperMoveType,
 )
 from .execution import EngineStatus, PostRunHardwareState
 from .liquid_level_detection import (
@@ -145,9 +152,10 @@ from .liquid_level_detection import (
 )
 from .liquid_handling import FlowRates
 from .labware_movement import LabwareMovementStrategy, LabwareMovementOffsetData
-from .tip import TipGeometry
+from .tip import TipGeometry, TipRackWellState
 from .hardware_passthrough import MovementAxis, MotorAxis
 from .util import Vec3f, Dimensions
+from .tasks import Task, TaskSummary, FinishedTask
 
 __all__ = [
     # Runtime parameters
@@ -165,6 +173,9 @@ __all__ = [
     "SecondOrderCommandAnnotation",
     "CustomCommandAnnotation",
     "CommandAnnotation",
+    # Command preconditions
+    "PreconditionTypes",
+    "CommandPreconditions",
     # Partial tip handling
     "AllNozzleLayoutConfiguration",
     "SingleNozzleLayoutConfiguration",
@@ -228,8 +239,10 @@ __all__ = [
     "NonStackedLocation",
     "DeckPoint",
     "OffDeckLocationType",
-    "SystemLocationType",
+    "WasteChuteLocationType" "SystemLocationType",
     "InStackerHopperLocation",
+    "WASTE_CHUTE_LOCATION",
+    "AccessibleByGripperLocation",
     "OnLabwareLocationSequenceComponent",
     "OnModuleLocationSequenceComponent",
     "OnAddressableAreaLocationSequenceComponent",
@@ -239,6 +252,7 @@ __all__ = [
     "LoadableLabwareLocation",
     "labware_location_is_off_deck",
     "labware_location_is_system",
+    "labware_location_is_in_waste_chute",
     # Labware offset location
     "LegacyLabwareOffsetLocation",
     "LabwareOffsetLocationSequence",
@@ -256,7 +270,6 @@ __all__ = [
     "LabwareOffsetCreateInternal",
     "LoadedLabware",
     "LabwareOffsetVector",
-    "LabwareParentDefinition",
     "LabwareWellId",
     "GripSpecs",
     # Liquids
@@ -286,6 +299,7 @@ __all__ = [
     "CurrentWell",
     "CurrentPipetteLocation",
     "InstrumentOffsetVector",
+    "GripperMoveType",
     # Liquid level detection types
     "LoadedVolumeInfo",
     "ProbedHeightInfo",
@@ -301,6 +315,7 @@ __all__ = [
     "LabwareMovementOffsetData",
     # Tips
     "TipGeometry",
+    "TipRackWellState",
     # Hardware passthrough
     "MovementAxis",
     "MotorAxis",
@@ -309,4 +324,8 @@ __all__ = [
     "Dimensions",
     # Convenience re-export
     "LabwareUri",
+    # Tasks
+    "Task",
+    "TaskSummary",
+    "FinishedTask",
 ]

opentrons/protocol_engine/types/command_preconditions.py

@@ -0,0 +1,18 @@
+"""Protocol Engine types dealing with command preconditions."""
+from enum import Enum
+from pydantic import Field, BaseModel
+
+
+class PreconditionTypes(str, Enum):
+    """Precondition types used for identification during state update."""
+
+    IS_CAMERA_USED = "isCameraUsed"
+
+
+class CommandPreconditions(BaseModel):
+    """Preconditions of commands as described in protocol analysis."""
+
+    isCameraUsed: bool = Field(
+        default=False,
+        description="Parameter to determine if a Camera is used in a protocol.",
+    )

opentrons/protocol_engine/types/deck_configuration.py

@@ -6,7 +6,10 @@ from enum import Enum
 
 from opentrons.types import DeckSlotName
 
-from opentrons_shared_data.module.types import ModuleType as SharedDataModuleType
+from opentrons_shared_data.module.types import (
+    ModuleType as SharedDataModuleType,
+    ModuleOrientation,
+)
 from opentrons_shared_data.deck.types import SlotDefV3
 from opentrons_shared_data.labware.types import LocatingFeatures
 
@@ -57,6 +60,7 @@ class AddressableArea:
     position: AddressableOffsetVector
     compatible_module_types: List[SharedDataModuleType]
     features: LocatingFeatures
+    orientation: ModuleOrientation
 
 
 # TODO make the below some sort of better type

opentrons/protocol_engine/types/instrument.py

@@ -1,5 +1,5 @@
 """Protocol Engine types to do with instruments."""
-
+import enum
 from typing import Union
 
 from dataclasses import dataclass
@@ -45,3 +45,10 @@ class InstrumentOffsetVector(BaseModel):
     x: float
     y: float
     z: float
+
+
+class GripperMoveType(enum.Enum):
+    """Types of gripper movement."""
+
+    PICK_UP_LABWARE = enum.auto()
+    DROP_LABWARE = enum.auto()

opentrons/protocol_engine/types/labware.py

@@ -2,16 +2,12 @@
 
 from __future__ import annotations
 
-from typing import Optional, Union
+from typing import Optional
 from dataclasses import dataclass
 from datetime import datetime
 
 from pydantic import BaseModel, Field
 
-from opentrons_shared_data.labware.labware_definition import (
-    LabwareDefinition,
-)
-
 from .location import LabwareLocation
 from .labware_offset_location import (
     LegacyLabwareOffsetLocation,
@@ -19,8 +15,6 @@ from .labware_offset_location import (
 )
 from .labware_offset_vector import LabwareOffsetVector
 from .util import Vec3f
-from .module import ModuleDefinition
-from .deck_configuration import DeckLocationDefinition
 
 
 @dataclass(frozen=True)
@@ -126,12 +120,6 @@ class LoadedLabware(BaseModel):
     )
 
 
-LabwareParentDefinition = Union[
-    DeckLocationDefinition, ModuleDefinition, LabwareDefinition
-]
-"""Information pertaining to a labware's parent (deck slot, module, or another labware) location."""
-
-
 @dataclass(frozen=True)
 class LabwareWellId:
     """Designates a well in a labware."""

opentrons/protocol_engine/types/location.py

@@ -85,8 +85,10 @@ class InStackerHopperLocation(BaseModel):
 
 _OffDeckLocationType = Literal["offDeck"]
 _SystemLocationType = Literal["systemLocation"]
+_WasteChuteLocationType = Literal["wasteChuteLocation"]
 OFF_DECK_LOCATION: _OffDeckLocationType = "offDeck"
 SYSTEM_LOCATION: _SystemLocationType = "systemLocation"
+WASTE_CHUTE_LOCATION: _WasteChuteLocationType = "wasteChuteLocation"
 
 
 def labware_location_is_off_deck(
@@ -103,6 +105,13 @@ def labware_location_is_system(
     return isinstance(location, str) and location == SYSTEM_LOCATION
 
 
+def labware_location_is_in_waste_chute(
+    location: LabwareLocation,
+) -> TypeGuard[_WasteChuteLocationType]:
+    """Check if a location is the waste chute."""
+    return isinstance(location, str) and location == WASTE_CHUTE_LOCATION
+
+
 class OnLabwareLocationSequenceComponent(BaseModel):
     """Labware on another labware."""
 
@@ -137,7 +146,7 @@ class NotOnDeckLocationSequenceComponent(BaseModel):
     """Labware on a system location."""
 
     kind: Literal["notOnDeck"] = "notOnDeck"
-    logicalLocationName: _OffDeckLocationType | _SystemLocationType
+    logicalLocationName: _OffDeckLocationType | _SystemLocationType | _WasteChuteLocationType
 
 
 LabwareLocationSequence = list[
@@ -158,6 +167,7 @@ LabwareLocation = Union[
     _SystemLocationType,
     AddressableAreaLocation,
     InStackerHopperLocation,
+    _WasteChuteLocationType,
 ]
 """Union of all locations where it's legal to keep a labware."""
 
@@ -168,11 +178,15 @@ LoadableLabwareLocation = Union[
     _OffDeckLocationType,
     _SystemLocationType,
     AddressableAreaLocation,
+    _WasteChuteLocationType,
 ]
 """Union of all locations where it's legal to load a labware."""
 
 OnDeckLabwareLocation = Union[
-    DeckSlotLocation, ModuleLocation, OnLabwareLocation, AddressableAreaLocation
+    DeckSlotLocation,
+    ModuleLocation,
+    OnLabwareLocation,
+    AddressableAreaLocation,
 ]
 
 NonStackedLocation = Union[
@@ -181,9 +195,19 @@ NonStackedLocation = Union[
     ModuleLocation,
     _OffDeckLocationType,
     _SystemLocationType,
+    _WasteChuteLocationType,
 ]
 """Union of all locations where it's legal to keep a labware that can't be stacked on another labware"""
 
+AccessibleByGripperLocation = Union[
+    DeckSlotLocation,
+    ModuleLocation,
+    OnLabwareLocation,
+    AddressableAreaLocation,
+    _WasteChuteLocationType,
+]
+"""Union of all locations that a gripper can move things to."""
+
 
 # TODO(mm, 2022-11-07): Deduplicate with Vec3f.
 class DeckPoint(BaseModel):

opentrons/protocol_engine/types/module.py

@@ -21,6 +21,7 @@ from opentrons_shared_data.labware.types import LocatingFeatures
 
 from opentrons.hardware_control.modules import (
     ModuleType as ModuleType,
+    ModuleModel as HardwareModuleModel,
 )
 
 from .location import DeckSlotLocation
@@ -43,6 +44,11 @@ class ModuleModel(str, Enum):
     ABSORBANCE_READER_V1 = "absorbanceReaderV1"
     FLEX_STACKER_MODULE_V1 = "flexStackerModuleV1"
 
+    @classmethod
+    def from_hardware(cls, hardware_model: HardwareModuleModel) -> "ModuleModel":
+        """Convert from the hardware model representation."""
+        return cls(hardware_model.value)
+
     def as_type(self) -> ModuleType:
         """Get the ModuleType of this model."""
         if ModuleModel.is_temperature_module_model(self):
@@ -193,6 +199,10 @@ class ModuleDefinition(BaseModel):
         ...,
     )
 
+    orientation: Dict[str, str] = Field(
+        ...,
+    )
+
     compatibleWith: List[ModuleModel] = Field(
         ...,
     )
@@ -293,7 +303,7 @@ class StackerStoredLabwareGroup(BaseModel):
 
 @dataclass
 class StackerPoolDefinition:
-    """Represents an internal configuraiton of stored labware."""
+    """Represents an internal configuration of stored labware."""
 
     primaryLabwareDefinition: LabwareDefinition
     adapterLabwareDefinition: LabwareDefinition | SkipJsonSchema[None] = None

opentrons/protocol_engine/types/tasks.py

@@ -0,0 +1,38 @@
+"""Types for Tasks."""
+from datetime import datetime
+from opentrons.protocol_engine.errors import ErrorOccurrence
+from dataclasses import dataclass
+import asyncio
+
+
+@dataclass
+class _BaseTask:
+    """A base task representation."""
+
+    id: str
+    createdAt: datetime
+
+
+@dataclass
+class Task(_BaseTask):
+    """A task representation."""
+
+    asyncioTask: asyncio.Task[None]
+
+
+@dataclass
+class FinishedTask(_BaseTask):
+    """A finished task representation."""
+
+    finishedAt: datetime
+    error: ErrorOccurrence | None
+
+
+@dataclass
+class TaskSummary:
+    """Task info for use in summary lists."""
+
+    id: str
+    createdAt: datetime
+    finishedAt: datetime | None = None
+    error: ErrorOccurrence | None = None

opentrons/protocol_engine/types/tip.py

@@ -1,6 +1,7 @@
 """Protocol Engine types to deal with tips."""
 
 from dataclasses import dataclass
+from enum import Enum
 
 
 @dataclass(frozen=True)
@@ -16,3 +17,11 @@ class TipGeometry:
     length: float
     diameter: float
     volume: float
+
+
+class TipRackWellState(Enum):
+    """The state of a single tip in a tip rack's well."""
+
+    CLEAN = "clean"
+    USED = "used"
+    EMPTY = "empty"

opentrons/protocol_runner/create_simulating_orchestrator.py

@@ -16,11 +16,38 @@ from opentrons_shared_data.robot.types import RobotType
 from .python_protocol_wrappers import SimulatingContextCreator
 from .run_orchestrator import RunOrchestrator
 from .protocol_runner import create_protocol_runner, LiveRunner
+from ..protocol_engine.types import (
+    PostRunHardwareState,
+)
+
+
+class SimulatingRunOrchestrator(RunOrchestrator):
+    """A RunOrchestrator that cleans up its simulating hardware controller.
+
+    This should only be created and returned by create_simulating_orchestrator, unless
+    you are sure it's appropriate to clean up the hardware controller.
+    """
+
+    async def finish(
+        self,
+        error: Exception | None = None,
+        drop_tips_after_run: bool = True,
+        set_run_status: bool = True,
+        post_run_hardware_state: PostRunHardwareState = PostRunHardwareState.HOME_AND_STAY_ENGAGED,
+    ) -> None:
+        """Finish the run and clean up the simulating hardware controller."""
+        await super().finish(
+            error=error,
+            drop_tips_after_run=drop_tips_after_run,
+            set_run_status=set_run_status,
+            post_run_hardware_state=post_run_hardware_state,
+        )
+        await self._hardware_api.clean_up()
 
 
 async def create_simulating_orchestrator(
     robot_type: RobotType, protocol_config: ProtocolConfig
-) -> RunOrchestrator:
+) -> SimulatingRunOrchestrator:
     """Create a RunOrchestrator wired to a simulating HardwareControlAPI.
 
     Example:
@@ -96,7 +123,7 @@ async def create_simulating_orchestrator(
         hardware_api=simulating_hardware_api,
     )
 
-    return RunOrchestrator(
+    return SimulatingRunOrchestrator(
         hardware_api=simulating_hardware_api,
         json_or_python_protocol_runner=runner,
         protocol_engine=protocol_engine,

opentrons/protocol_runner/protocol_runner.py

@@ -24,7 +24,7 @@ from opentrons.protocol_engine import (
     Command,
     commands as pe_commands,
 )
-from opentrons.protocol_engine.types import CommandAnnotation
+from opentrons.protocol_engine.types import CommandAnnotation, CommandPreconditions
 from opentrons.protocols.parse import PythonParseMode
 from opentrons.util.async_helpers import asyncio_yield
 from opentrons.util.broker import Broker
@@ -58,6 +58,7 @@ class RunResult(NamedTuple):
     state_summary: StateSummary
     parameters: List[RunTimeParameter]
     command_annotations: List[CommandAnnotation]
+    command_preconditions: Optional[CommandPreconditions]
 
 
 class AbstractRunner(ABC):
@@ -284,11 +285,15 @@ class PythonAndLegacyRunner(AbstractRunner):
         run_data = self._protocol_engine.state_view.get_summary()
         commands = self._protocol_engine.state_view.commands.get_all()
         parameters = self.run_time_parameters
+        preconditions = (
+            self._protocol_engine.state_view.preconditions.get_precondition()
+        )
         return RunResult(
             commands=commands,
             state_summary=run_data,
             parameters=parameters,
             command_annotations=[],
+            command_preconditions=preconditions,
         )
 
 
@@ -403,11 +408,15 @@ class JsonRunner(AbstractRunner):
 
         run_data = self._protocol_engine.state_view.get_summary()
         commands = self._protocol_engine.state_view.commands.get_all()
+        preconditions = (
+            self._protocol_engine.state_view.preconditions.get_precondition()
+        )
         return RunResult(
             commands=commands,
             state_summary=run_data,
             parameters=[],
             command_annotations=self._command_annotations,
+            command_preconditions=preconditions,
         )
 
     async def _add_and_execute_commands(self) -> None:
@@ -479,11 +488,15 @@ class LiveRunner(AbstractRunner):
 
         run_data = self._protocol_engine.state_view.get_summary()
         commands = self._protocol_engine.state_view.commands.get_all()
+        preconditions = (
+            self._protocol_engine.state_view.preconditions.get_precondition()
+        )
         return RunResult(
             commands=commands,
             state_summary=run_data,
             parameters=[],
             command_annotations=[],
+            command_preconditions=preconditions,
         )
 
 

opentrons/protocol_runner/run_orchestrator.py

@@ -15,7 +15,10 @@ from opentrons_shared_data.robot.types import RobotType
 
 from . import protocol_runner, RunResult, JsonRunner, PythonAndLegacyRunner
 from ..hardware_control import HardwareControlAPI
-from ..hardware_control.modules import AbstractModule as HardwareModuleAPI
+from ..hardware_control.modules import (
+    AbstractModule as HardwareModuleAPI,
+    ModuleModel as HardwareModuleModel,
+)
 from ..protocol_engine import (
     ProtocolEngine,
     CommandCreate,
@@ -40,7 +43,9 @@ from ..protocol_engine.types import (
     CSVRuntimeParamPaths,
     CommandAnnotation,
     ModuleModel,
+    CommandPreconditions,
 )
+from ..protocol_engine.resources.camera_provider import CameraProvider, CameraSettings
 from ..protocol_engine.error_recovery_policy import ErrorRecoveryPolicy
 
 from ..protocol_reader import JsonProtocolConfig, PythonProtocolConfig, ProtocolSource
@@ -81,15 +86,16 @@ class RunOrchestrator:
     _protocol_live_runner: protocol_runner.LiveRunner
     _hardware_api: HardwareControlAPI
     _protocol_engine: ProtocolEngine
+    _camera_provider: Optional[CameraProvider] = None
 
     def __init__(
         self,
         protocol_engine: ProtocolEngine,
-        # todo(mm, 2024-07-05): This hardware_api param looks unused?
         hardware_api: HardwareControlAPI,
         fixit_runner: protocol_runner.LiveRunner,
         setup_runner: protocol_runner.LiveRunner,
         protocol_live_runner: protocol_runner.LiveRunner,
+        camera_provider: Optional[CameraProvider] = None,
         json_or_python_protocol_runner: Optional[
             Union[protocol_runner.PythonAndLegacyRunner, protocol_runner.JsonRunner]
         ] = None,
@@ -104,6 +110,7 @@ class RunOrchestrator:
             setup_runner: LiveRunner for setup commands.
             protocol_live_runner: LiveRunner for protocol commands.
             json_or_python_protocol_runner: JsonRunner/PythonAndLegacyRunner for protocol commands.
+            camera_provider: Provides callbacks to Camera interface.
             run_id: run id if any, associated to the runner/engine.
         """
         self._run_id = run_id
@@ -112,9 +119,12 @@ class RunOrchestrator:
         self._setup_runner = setup_runner
         self._fixit_runner = fixit_runner
         self._protocol_live_runner = protocol_live_runner
+        self._camera_provider = camera_provider
         self._fixit_runner.prepare()
         self._setup_runner.prepare()
         self._protocol_engine.set_and_start_queue_worker(self.command_generator)
+        # used by SimulatingRunOrchestrator to clean up the simulating hardware controller
+        self._hardware_api = hardware_api
 
     @property
     def run_id(self) -> str:
@@ -128,6 +138,7 @@ class RunOrchestrator:
         cls,
         hardware_api: HardwareControlAPI,
         protocol_engine: ProtocolEngine,
+        camera_provider: Optional[CameraProvider] = None,
         protocol_config: Optional[
             Union[JsonProtocolConfig, PythonProtocolConfig]
         ] = None,
@@ -165,6 +176,7 @@ class RunOrchestrator:
             hardware_api=hardware_api,
             protocol_engine=protocol_engine,
             protocol_live_runner=protocol_live_runner,
+            camera_provider=camera_provider,
         )
 
     def play(self, deck_configuration: Optional[DeckConfigurationType] = None) -> None:
@@ -233,6 +245,10 @@ class RunOrchestrator:
         """Get protocol run data."""
         return self._protocol_engine.state_view.get_summary()
 
+    def get_preconditions(self) -> CommandPreconditions:
+        """Get the preconditions of a protocol run."""
+        return self._protocol_engine.state_view.preconditions.get_precondition()
+
     def get_loaded_labware_definitions(self) -> List[LabwareDefinition]:
         """Get loaded labware definitions."""
         return self._protocol_engine.state_view.labware.get_loaded_labware_definitions()
@@ -359,6 +375,13 @@ class RunOrchestrator:
         """Add a new labware definition to state."""
         return self._protocol_engine.add_labware_definition(definition)
 
+    def add_camera_enablement_settings(
+        self,
+        enablement_settings: CameraSettings,
+    ) -> CameraSettings:
+        """Add new camera enablement settings."""
+        return self._protocol_engine.add_camera_enablement_settings(enablement_settings)
+
     async def add_command_and_wait_for_interval(
         self,
         command: CommandCreate,
@@ -380,6 +403,30 @@ class RunOrchestrator:
         """Handle an E-stop event from the hardware API."""
         return self._protocol_engine.estop()
 
+    async def asynchronous_module_error(
+        self, module_model: HardwareModuleModel, module_serial: str | None
+    ) -> bool:
+        """Handle an asynchronous module error reported by hardware.
+
+        If this function returns true, the caller should call finish() immediately; if it returns
+        False, the caller should not call finish() until it otherwise would.
+        """
+        return await self._protocol_engine.async_module_error(
+            module_model=ModuleModel.from_hardware(module_model), serial=module_serial
+        )
+
+    async def module_disconnected(
+        self, module_model: HardwareModuleModel, module_serial: str | None
+    ) -> bool:
+        """Handle an unexpected module disconnection.
+
+        If this function returns true, the caller should call finish() immediately; if it returns
+        False, the caller should not call finish() until it otherwise would.
+        """
+        return await self._protocol_engine.module_disconnected(
+            module_model=ModuleModel.from_hardware(module_model), serial=module_serial
+        )
+
     async def use_attached_modules(
         self, modules_by_id: Dict[str, HardwareModuleAPI]
     ) -> None:

opentrons/protocols/advanced_control/transfers/transfer_liquid_utils.py

@@ -72,7 +72,7 @@ def raise_if_location_inside_liquid(
 def group_wells_for_multi_channel_transfer(
     targets: Sequence[Well],
     nozzle_map: NozzleMapInterface,
-    target_name: Literal["source", "destination"],
+    target_name: Literal["source", "destination", "tip"],
 ) -> List[Well]:
     """Takes a list of wells and a nozzle map and returns a list of target wells to address every well given
 
@@ -108,7 +108,7 @@ def group_wells_for_multi_channel_transfer(
 def _group_wells_for_nozzle_configuration(  # noqa: C901
     targets: List[Well],
     nozzle_map: NozzleMapInterface,
-    target_name: Literal["source", "destination"],
+    target_name: Literal["source", "destination", "tip"],
 ) -> List[Well]:
     """Groups wells together for a column, row, or full 96 configuration and returns a reduced list of target wells."""
     grouped_wells = []

opentrons/protocols/api_support/definitions.py

@@ -1,6 +1,6 @@
 from .types import APIVersion
 
-MAX_SUPPORTED_VERSION = APIVersion(2, 26)
+MAX_SUPPORTED_VERSION = APIVersion(2, 27)
 """The maximum supported protocol API version in this release."""
 
 MIN_SUPPORTED_VERSION = APIVersion(2, 0)

opentrons/protocols/api_support/types.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import NamedTuple, TypedDict
+from typing import NamedTuple, TypedDict, Optional
 
 
 class APIVersion(NamedTuple):
@@ -30,3 +30,4 @@ class ThermocyclerStep(ThermocyclerStepBase, total=False):
 
     hold_time_seconds: float
     hold_time_minutes: float
+    ramp_rate: Optional[float]