Labware¶
While Labware is an entity, just like tools, robots, etc., it is broken out here due to it’s internal complexity.
Related T-code Commands:
- CREATE_LABWARE
- ADD_LABWARE
- PICK_UP_LABWARE
- PUT_DOWN_LABWARE
TCode entity and labware description/descriptor schemas.
- pydantic model tcode_api.schemas.descriptions.AxisAlignedRectangleDescription
Description of an axis-aligned rectangle.
Show JSON schema
{ "title": "AxisAlignedRectangleDescription", "description": "Description of an axis-aligned rectangle.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "x_length", "y_length" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['AxisAlignedRectangle'])x_length (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units.")])y_length (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units.")])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['AxisAlignedRectangle'] = 'AxisAlignedRectangle'
-
field x_length:
Annotated[ValueWithUnits] [Required] The length of the rectangle along the X-axis of the parent object’s coordinate system. expects length units.
-
field y_length:
Annotated[ValueWithUnits] [Required] The length of the rectangle along the Y-axis of the parent object’s coordinate system. expects length units.
- pydantic model tcode_api.schemas.descriptions.AxisAlignedRectangleDescriptor
:class:
AxisAlignedRectangleDescriptionwith optional parameters.Show JSON schema
{ "title": "AxisAlignedRectangleDescriptor", "description": ":class:``AxisAlignedRectangleDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['AxisAlignedRectangle'])x_length (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units.")] | None)y_length (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units.")] | None)
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['AxisAlignedRectangle'] = 'AxisAlignedRectangle'
-
field x_length:
Optional[Annotated[ValueWithUnits]] = None
-
field y_length:
Optional[Annotated[ValueWithUnits]] = None
- pydantic model tcode_api.schemas.descriptions.CircleDescription
Description of a circle.
Show JSON schema
{ "title": "CircleDescription", "description": "Description of a circle.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "diameter" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
diameter (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='Maximum distance across the circle. expects length units')])schema_version (Literal[1])type (Literal['Circle'])
-
field diameter:
Annotated[ValueWithUnits] [Required] Maximum distance across the circle. expects length units
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Circle'] = 'Circle'
- pydantic model tcode_api.schemas.descriptions.CircleDescriptor
CircleDescription with optional parameters.
Show JSON schema
{ "title": "CircleDescriptor", "description": "CircleDescription with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" }, { "type": "null" } ], "default": null } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
diameter (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='Maximum distance across the circle. expects length units')] | None)schema_version (Literal[1])type (Literal['Circle'])
-
field diameter:
Optional[Annotated[ValueWithUnits]] = None
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Circle'] = 'Circle'
- pydantic model tcode_api.schemas.descriptions.ConicalBottomDescription
Description of a conical bottom well.
- Note:
It is assumed that the conical portion of the well comes to a point at the bottom of the well
Show JSON schema
{ "title": "ConicalBottomDescription", "description": "Description of a conical bottom well.\n\n:note: It is assumed that the conical portion of the well comes to a point at the bottom of the well", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "offset" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance from the base to tip of the conical portion of the well. expects length units')])schema_version (Literal[1])type (Literal['Conical'])
-
field offset:
Annotated[ValueWithUnits] [Required] The distance from the base to tip of the conical portion of the well. expects length units
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Conical'] = 'Conical'
- pydantic model tcode_api.schemas.descriptions.ConicalBottomDescriptor
:class:
ConicalBottomDescriptionwith optional parameters.Show JSON schema
{ "title": "ConicalBottomDescriptor", "description": ":class:``ConicalBottomDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" }, { "type": "null" } ], "default": null } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance from the base to tip of the conical portion of the well. expects length units')] | None)schema_version (Literal[1])type (Literal['Conical'])
-
field offset:
Optional[Annotated[ValueWithUnits]] = None
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Conical'] = 'Conical'
- pydantic model tcode_api.schemas.descriptions.EightChannelPipetteDescriptor
Show JSON schema
{ "title": "EightChannelPipetteDescriptor", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Minimum volume that the pipette can handle while maintianing promised tolerances. expects volume units (e.g. ul)." }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum volume that the pipette can hold (spec, not reality). expects volume units (e.g. ul)." }, "max_speed": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum speed that the pipette can move fluid; expects volume per time units (e.g. ul/s)." }, "type": { "const": "EightChannelPipette", "default": "EightChannelPipette", "title": "Type", "type": "string" } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
max_speed (ValueWithUnits | None)max_volume (ValueWithUnits | None)min_volume (ValueWithUnits | None)schema_version (Literal[1])serial_number (str | None)type (Literal['EightChannelPipette'])
- field max_speed: ValueWithUnits | None = None
Maximum speed that the pipette can move fluid; expects volume per time units (e.g. ul/s).
- field max_volume: ValueWithUnits | None = None
Maximum volume that the pipette can hold (spec, not reality). expects volume units (e.g. ul).
- field min_volume: ValueWithUnits | None = None
Minimum volume that the pipette can handle while maintianing promised tolerances. expects volume units (e.g. ul).
-
field schema_version:
Literal[1] = 1
- field serial_number: str | None = None
Optional serial number - allows unique identification of a robot or tool.
-
field type:
Literal['EightChannelPipette'] = 'EightChannelPipette'
- pydantic model tcode_api.schemas.descriptions.FlatBottomDescription
:class:
FlatBottomDescriptionwith optional paramters.Show JSON schema
{ "title": "FlatBottomDescription", "description": ":class:``FlatBottomDescription`` with optional paramters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['Flat'])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Flat'] = 'Flat'
- pydantic model tcode_api.schemas.descriptions.FlatBottomDescriptor
Descriptor for a flat bottom well.
Show JSON schema
{ "title": "FlatBottomDescriptor", "description": "Descriptor for a flat bottom well.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['Flat'])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Flat'] = 'Flat'
- pydantic model tcode_api.schemas.descriptions.GridDescription
Description of a grid layout.
Show JSON schema
{ "title": "GridDescription", "description": "Description of a grid layout.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "title": "Row Count", "type": "integer" }, "column_count": { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "title": "Column Count", "type": "integer" }, "row_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, "column_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, "row_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, "column_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "row_count", "column_count", "row_pitch", "column_pitch", "row_offset", "column_offset" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
column_count (Annotated[int, annotated_types.Gt(gt=0), FieldInfo(annotation=NoneType, required=True, description='The number of columns in the grid.')])column_offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units.")])column_pitch (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance between the centers of adjacent columns in the grid. Expects length units.')])row_count (Annotated[int, annotated_types.Gt(gt=0), FieldInfo(annotation=NoneType, required=True, description='The number of rows in the grid.')])row_offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units.")])row_pitch (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance between the centers of adjacent rows in the grid. Expects length units.')])schema_version (Literal[1])type (Literal['Grid'])
-
field column_count:
Annotated[int] [Required] The number of columns in the grid.
- Constraints:
gt = 0
-
field column_offset:
Annotated[ValueWithUnits] [Required] The offset distance from the grid’s origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren’t symmetric.Expects length units.
-
field column_pitch:
Annotated[ValueWithUnits] [Required] The distance between the centers of adjacent columns in the grid. Expects length units.
-
field row_count:
Annotated[int] [Required] The number of rows in the grid.
- Constraints:
gt = 0
-
field row_offset:
Annotated[ValueWithUnits] [Required] The offset distance from the grid’s origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren’t symmetric.Expects length units.
-
field row_pitch:
Annotated[ValueWithUnits] [Required] The distance between the centers of adjacent rows in the grid. Expects length units.
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Grid'] = 'Grid'
- pydantic model tcode_api.schemas.descriptions.GridDescriptor
:class:
GridDescriptionwith optional parameters.Show JSON schema
{ "title": "GridDescriptor", "description": ":class:``GridDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "anyOf": [ { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Row Count" }, "column_count": { "anyOf": [ { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Column Count" }, "row_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "column_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "row_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null }, "column_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
column_count (Annotated[int, annotated_types.Gt(gt=0), FieldInfo(annotation=NoneType, required=True, description='The number of columns in the grid.')] | None)column_offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units.")] | None)column_pitch (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance between the centers of adjacent columns in the grid. Expects length units.')] | None)row_count (Annotated[int, annotated_types.Gt(gt=0), FieldInfo(annotation=NoneType, required=True, description='The number of rows in the grid.')] | None)row_offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description="The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units.")] | None)row_pitch (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance between the centers of adjacent rows in the grid. Expects length units.')] | None)schema_version (Literal[1])type (Literal['Grid'])
-
field column_count:
Optional[Annotated[int]] = None
-
field column_offset:
Optional[Annotated[ValueWithUnits]] = None
-
field column_pitch:
Optional[Annotated[ValueWithUnits]] = None
-
field row_count:
Optional[Annotated[int]] = None
-
field row_offset:
Optional[Annotated[ValueWithUnits]] = None
-
field row_pitch:
Optional[Annotated[ValueWithUnits]] = None
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Grid'] = 'Grid'
- pydantic model tcode_api.schemas.descriptions.GripperDescriptor
Show JSON schema
{ "title": "GripperDescriptor", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "type": { "const": "Gripper", "default": "Gripper", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])serial_number (str | None)type (Literal['Gripper'])
-
field schema_version:
Literal[1] = 1
- field serial_number: str | None = None
Optional serial number - allows unique identification of a robot or tool.
-
field type:
Literal['Gripper'] = 'Gripper'
- pydantic model tcode_api.schemas.descriptions.LabwareHolderDescriptor
Descriptor for an entity that can hold labware.
Show JSON schema
{ "title": "LabwareHolderDescriptor", "description": "Descriptor for an entity that can hold labware.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "LabwareHolder", "default": "LabwareHolder", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['LabwareHolder'])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['LabwareHolder'] = 'LabwareHolder'
- pydantic model tcode_api.schemas.descriptions.LidDescription
Description of a plate lid.
Show JSON schema
{ "title": "LidDescription", "description": "Description of a plate lid.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, "z_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, "type": { "const": "Lid", "default": "Lid", "title": "Type", "type": "string" }, "stackable": { "description": "Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.", "title": "Stackable", "type": "boolean" } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "x_length", "y_length", "z_length", "stackable" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
named_tags (NamedTags)schema_version (Literal[3])stackable (Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.')])tags (Tags)type (Literal['Lid'])x_length (XLengthField)y_length (YLengthField)z_length (ZLengthField)
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
-
field stackable:
Annotated[bool] [Required] Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['Lid'] = 'Lid'
- field x_length: XLengthField [Required]
The labware’s extent along the x-axis of it’s coordinate system. Expects length units.
- field y_length: YLengthField [Required]
The labware’s extent along the y-axis of it’s coordinate system. Expects length units.
- field z_length: ZLengthField [Required]
The labware’s extent along the z-axis of it’s coordinate system. Expects length units.
- pydantic model tcode_api.schemas.descriptions.LidDescriptor
LidDescription with optional parameters.
Show JSON schema
{ "title": "LidDescriptor", "description": "LidDescription with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "z_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "type": { "const": "Lid", "default": "Lid", "title": "Type", "type": "string" }, "stackable": { "anyOf": [ { "description": "Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.", "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Stackable" } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
named_tags (NamedTags)schema_version (Literal[3])stackable (Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.')] | None)tags (Tags)type (Literal['Lid'])x_length (XLengthField | None)y_length (YLengthField | None)z_length (ZLengthField | None)
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
-
field stackable:
Optional[Annotated[bool]] = None
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['Lid'] = 'Lid'
- field x_length: XLengthField | None = None
- field y_length: YLengthField | None = None
- field z_length: ZLengthField | None = None
- pydantic model tcode_api.schemas.descriptions.PipetteTipBoxDescription
Description of a pipette tip box.
Show JSON schema
{ "title": "PipetteTipBoxDescription", "description": "Description of a pipette tip box.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, "z_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, "type": { "const": "PipetteTipBox", "default": "PipetteTipBox", "title": "Type", "type": "string" }, "grid": { "$ref": "#/$defs/GridDescription", "description": "Layout of the pipette tip box slots. typically an 8*12 grid for a 96 tip box." }, "pipette_tip": { "$ref": "#/$defs/PipetteTipDescription", "description": "Description of the pipette tips used in the box. All pipette tips are assumed to be identical." }, "pipette_tip_layout": { "$ref": "#/$defs/PipetteTipLayout", "description": "Specifies which slots contain pipette tips.If not provided, it is assumed that all slots in the grid are filled with pipette tips." } }, "$defs": { "GridDescription": { "description": "Description of a grid layout.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "title": "Row Count", "type": "integer" }, "column_count": { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "title": "Column Count", "type": "integer" }, "row_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, "column_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, "row_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, "column_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." } }, "required": [ "row_count", "column_count", "row_pitch", "column_pitch", "row_offset", "column_offset" ], "title": "GridDescription", "type": "object" }, "PipetteTipDescription": { "description": "Description of a pipette tip.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "PipetteTip", "default": "PipetteTip", "title": "Type", "type": "string" }, "has_filter": { "description": "Whether the pipette tip has an internal filter.", "title": "Has Filter", "type": "boolean" }, "height": { "$ref": "#/$defs/ValueWithUnits", "description": "total length of the pipette tip; expects length units" }, "flange_height": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." } }, "required": [ "has_filter", "height", "flange_height", "max_volume", "min_volume" ], "title": "PipetteTipDescription", "type": "object" }, "PipetteTipLayout": { "description": "Data structure representing the layout of pipette tips in a box.\n\n:note: This class is designed to allow non-standard use cases, like adding partially filled\n pipette tip boxes to the deck with the :class:``ADD_LABWARE`` command.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "PipetteTipLayout", "default": "PipetteTipLayout", "title": "Type", "type": "string" }, "layout": { "description": "A 2D list representing the layout of pipette tips in the box. The list contains either 0 or 1, where 1 represents a slot holding a pipette tip and 0 represents an empty slot.", "items": { "items": { "type": "integer" }, "type": "array" }, "title": "Layout", "type": "array" } }, "required": [ "layout" ], "title": "PipetteTipLayout", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "x_length", "y_length", "z_length", "grid", "pipette_tip" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
grid (tcode_api.schemas.descriptions.grid.v1.GridDescription)named_tags (NamedTags)pipette_tip (tcode_api.schemas.descriptions.pipette_tip.v1.PipetteTipDescription)pipette_tip_layout (tcode_api.schemas.pipette_tip_layout.v1.PipetteTipLayout)schema_version (Literal[3])tags (Tags)type (Literal['PipetteTipBox'])x_length (XLengthField)y_length (YLengthField)z_length (ZLengthField)
-
field grid:
GridDescription[Required] Layout of the pipette tip box slots. typically an 8*12 grid for a 96 tip box.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field pipette_tip:
PipetteTipDescription[Required] Description of the pipette tips used in the box. All pipette tips are assumed to be identical.
-
field pipette_tip_layout:
PipetteTipLayout[Optional] Specifies which slots contain pipette tips.If not provided, it is assumed that all slots in the grid are filled with pipette tips.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['PipetteTipBox'] = 'PipetteTipBox'
- field x_length: XLengthField [Required]
The labware’s extent along the x-axis of it’s coordinate system. Expects length units.
- field y_length: YLengthField [Required]
The labware’s extent along the y-axis of it’s coordinate system. Expects length units.
- field z_length: ZLengthField [Required]
The labware’s extent along the z-axis of it’s coordinate system. Expects length units.
- pydantic model tcode_api.schemas.descriptions.PipetteTipBoxDescriptor
PipetteTipBoxDescription with optional parameters.
Show JSON schema
{ "title": "PipetteTipBoxDescriptor", "description": "PipetteTipBoxDescription with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "z_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "type": { "const": "PipetteTipBox", "default": "PipetteTipBox", "title": "Type", "type": "string" }, "grid": { "anyOf": [ { "$ref": "#/$defs/GridDescriptor" }, { "type": "null" } ], "default": null, "description": "Layout of the pipette tip box slots. typically an 8*12 grid for a 96 tip box." }, "pipette_tip": { "anyOf": [ { "$ref": "#/$defs/PipetteTipDescriptor" }, { "type": "null" } ], "default": null, "description": "Description of the pipette tips used in the box. All pipette tips are assumed to be identical." }, "pipette_tip_layout": { "anyOf": [ { "$ref": "#/$defs/PipetteTipLayout" }, { "type": "null" } ], "default": null, "description": "Specifies which slots contain pipette tips.If not provided, it is assumed that all slots in the grid are filled with pipette tips." } }, "$defs": { "GridDescriptor": { "description": ":class:``GridDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "anyOf": [ { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Row Count" }, "column_count": { "anyOf": [ { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Column Count" }, "row_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "column_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "row_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null }, "column_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null } }, "title": "GridDescriptor", "type": "object" }, "PipetteTipDescriptor": { "description": ":class:``PipetteTipDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "PipetteTip", "default": "PipetteTip", "title": "Type", "type": "string" }, "has_filter": { "anyOf": [ { "description": "Whether the pipette tip has an internal filter.", "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Has Filter" }, "height": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "total length of the pipette tip; expects length units" }, { "type": "null" } ], "default": null }, "flange_height": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null } }, "title": "PipetteTipDescriptor", "type": "object" }, "PipetteTipLayout": { "description": "Data structure representing the layout of pipette tips in a box.\n\n:note: This class is designed to allow non-standard use cases, like adding partially filled\n pipette tip boxes to the deck with the :class:``ADD_LABWARE`` command.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "PipetteTipLayout", "default": "PipetteTipLayout", "title": "Type", "type": "string" }, "layout": { "description": "A 2D list representing the layout of pipette tips in the box. The list contains either 0 or 1, where 1 represents a slot holding a pipette tip and 0 represents an empty slot.", "items": { "items": { "type": "integer" }, "type": "array" }, "title": "Layout", "type": "array" } }, "required": [ "layout" ], "title": "PipetteTipLayout", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
grid (tcode_api.schemas.descriptions.grid.v1.GridDescriptor | None)named_tags (NamedTags)pipette_tip (tcode_api.schemas.descriptions.pipette_tip.v1.PipetteTipDescriptor | None)pipette_tip_layout (tcode_api.schemas.pipette_tip_layout.v1.PipetteTipLayout | None)schema_version (Literal[3])tags (Tags)type (Literal['PipetteTipBox'])x_length (XLengthField | None)y_length (YLengthField | None)z_length (ZLengthField | None)
-
field grid:
GridDescriptor|None= None Layout of the pipette tip box slots. typically an 8*12 grid for a 96 tip box.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field pipette_tip:
PipetteTipDescriptor|None= None Description of the pipette tips used in the box. All pipette tips are assumed to be identical.
-
field pipette_tip_layout:
PipetteTipLayout|None= None Specifies which slots contain pipette tips.If not provided, it is assumed that all slots in the grid are filled with pipette tips.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['PipetteTipBox'] = 'PipetteTipBox'
- field x_length: XLengthField | None = None
- field y_length: YLengthField | None = None
- field z_length: ZLengthField | None = None
- pydantic model tcode_api.schemas.descriptions.PipetteTipDescription
Description of a pipette tip.
Show JSON schema
{ "title": "PipetteTipDescription", "description": "Description of a pipette tip.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "PipetteTip", "default": "PipetteTip", "title": "Type", "type": "string" }, "has_filter": { "description": "Whether the pipette tip has an internal filter.", "title": "Has Filter", "type": "boolean" }, "height": { "$ref": "#/$defs/ValueWithUnits", "description": "total length of the pipette tip; expects length units" }, "flange_height": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "has_filter", "height", "flange_height", "max_volume", "min_volume" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
flange_height (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units.')])has_filter (Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Whether the pipette tip has an internal filter.')])height (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='total length of the pipette tip; expects length units')])max_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.')])min_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.')])named_tags (NamedTags)schema_version (Literal[1])tags (Tags)type (Literal['PipetteTip'])
-
field flange_height:
Annotated[ValueWithUnits] [Required] The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units.
-
field has_filter:
Annotated[bool] [Required] Whether the pipette tip has an internal filter.
-
field height:
Annotated[ValueWithUnits] [Required] total length of the pipette tip; expects length units
-
field max_volume:
Annotated[ValueWithUnits] [Required] The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.
-
field min_volume:
Annotated[ValueWithUnits] [Required] The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[1] = 1
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['PipetteTip'] = 'PipetteTip'
- pydantic model tcode_api.schemas.descriptions.PipetteTipDescriptor
:class:
PipetteTipDescriptionwith optional parameters.Show JSON schema
{ "title": "PipetteTipDescriptor", "description": ":class:``PipetteTipDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "PipetteTip", "default": "PipetteTip", "title": "Type", "type": "string" }, "has_filter": { "anyOf": [ { "description": "Whether the pipette tip has an internal filter.", "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Has Filter" }, "height": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "total length of the pipette tip; expects length units" }, { "type": "null" } ], "default": null }, "flange_height": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
flange_height (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The distance from the top of the pipette tip to the flange which rests against the tip rack when the tip is racked. Expects length units.')] | None)has_filter (Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Whether the pipette tip has an internal filter.')] | None)height (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='total length of the pipette tip; expects length units')] | None)max_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.')] | None)min_volume (tcode_api.schemas.common.value_with_units.ValueWithUnits | None)named_tags (NamedTags)schema_version (Literal[1])tags (Tags)type (Literal['PipetteTip'])
-
field flange_height:
Optional[Annotated[ValueWithUnits]] = None
-
field has_filter:
Optional[Annotated[bool]] = None
-
field height:
Optional[Annotated[ValueWithUnits]] = None
-
field max_volume:
Optional[Annotated[ValueWithUnits]] = None
-
field min_volume:
ValueWithUnits|None= None
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[1] = 1
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['PipetteTip'] = 'PipetteTip'
- pydantic model tcode_api.schemas.descriptions.PipetteTipGroupDescriptor
Grid layout of pipette tips.
Show JSON schema
{ "title": "PipetteTipGroupDescriptor", "description": "Grid layout of pipette tips.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "PipetteTipGroup", "default": "PipetteTipGroup", "title": "Type", "type": "string" }, "row_count": { "description": "Number of rows of pipette tips in this group. Rows are referenced relative to the tip group's coordinate system, NOT the labware's coordinate system. e.g. a 1*8 pipette tip group can lie along the column or row of a 96 tip rack.", "exclusiveMinimum": 0, "title": "Row Count", "type": "integer" }, "column_count": { "description": "Number of columns of pipette tips in this group. Columns are referenced relative to the tip group's coordinate system, NOT the labware's coordinate system. e.g. a 1*8 pipette tip group can lie along the column or row of a 96 tip rack.", "exclusiveMinimum": 0, "title": "Column Count", "type": "integer" }, "pipette_tip_tags": { "description": "Tags to apply to all pipette tips in this group. For a pipette tip group to match this descriptor, all pipette tips in the group must have all of these tags, but may have additional tags as well.", "items": { "type": "string" }, "title": "Pipette Tip Tags", "type": "array" }, "pipette_tip_named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Named tags to apply to all pipette tips in this group. For a pipette tip group to match this descriptor, all pipette tips in the group must have all of these named tags with matching values, but may have additional named tags as well.", "title": "Pipette Tip Named Tags", "type": "object" } }, "required": [ "row_count", "column_count" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
column_count (Annotated[int, annotated_types.Gt(gt=0)])pipette_tip_named_tags (Annotated[dict[str, str | int | float | bool], FieldInfo(annotation=NoneType, required=False, default_factory=dict, description='Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.')])pipette_tip_tags (Annotated[list[str], FieldInfo(annotation=NoneType, required=False, default_factory=list, description='List of additional string tags attached to the entity.')])row_count (Annotated[int, annotated_types.Gt(gt=0)])schema_version (Literal[1])type (Literal['PipetteTipGroup'])
-
field column_count:
Annotated[int] [Required] Number of columns of pipette tips in this group. Columns are referenced relative to the tip group’s coordinate system, NOT the labware’s coordinate system. e.g. a 1*8 pipette tip group can lie along the column or row of a 96 tip rack.
- Constraints:
gt = 0
-
field pipette_tip_named_tags:
Annotated[dict[str,str|int|float|bool]] [Optional] Named tags to apply to all pipette tips in this group. For a pipette tip group to match this descriptor, all pipette tips in the group must have all of these named tags with matching values, but may have additional named tags as well.
-
field pipette_tip_tags:
Annotated[list[str]] [Optional] Tags to apply to all pipette tips in this group. For a pipette tip group to match this descriptor, all pipette tips in the group must have all of these tags, but may have additional tags as well.
-
field row_count:
Annotated[int] [Required] Number of rows of pipette tips in this group. Rows are referenced relative to the tip group’s coordinate system, NOT the labware’s coordinate system. e.g. a 1*8 pipette tip group can lie along the column or row of a 96 tip rack.
- Constraints:
gt = 0
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['PipetteTipGroup'] = 'PipetteTipGroup'
- pydantic model tcode_api.schemas.descriptions.ProbeDescriptor
Show JSON schema
{ "title": "ProbeDescriptor", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "type": { "const": "Probe", "default": "Probe", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])serial_number (str | None)type (Literal['Probe'])
-
field schema_version:
Literal[1] = 1
- field serial_number: str | None = None
Optional serial number - allows unique identification of a robot or tool.
-
field type:
Literal['Probe'] = 'Probe'
- pydantic model tcode_api.schemas.descriptions.RobotDescriptor
Descriptor for a robot in the fleet.
Show JSON schema
{ "title": "RobotDescriptor", "description": "Descriptor for a robot in the fleet.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "type": { "const": "Robot", "default": "Robot", "title": "Type", "type": "string" }, "tools": { "additionalProperties": { "description": "Union type of all valid tool descriptors.", "discriminator": { "mapping": { "EightChannelPipette": "#/$defs/EightChannelPipetteDescriptor", "Gripper": "#/$defs/GripperDescriptor", "Probe": "#/$defs/ProbeDescriptor", "SingleChannelPipette": "#/$defs/SingleChannelPipetteDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/SingleChannelPipetteDescriptor" }, { "$ref": "#/$defs/EightChannelPipetteDescriptor" }, { "$ref": "#/$defs/ProbeDescriptor" }, { "$ref": "#/$defs/GripperDescriptor" } ] }, "description": "list of tools currently attached to the robot, with their respective serial numbers (if any) as keys. Not currently used by the system, and will likely change before implementation. ", "title": "Tools", "type": "object" }, "tool_holders": { "additionalProperties": { "$ref": "#/$defs/ToolHolderDescriptor" }, "description": "list of tool holders currently attached to the robot, with their respective serial numbers (if any) as keys. Not currently used by the system, and will likely change before implementation. ", "title": "Tool Holders", "type": "object" }, "labware_holders": { "additionalProperties": { "$ref": "#/$defs/LabwareHolderDescriptor" }, "description": "list of labware holders currently attached to the robot, with their respective serial numbers (if any) as keys. Not currently used by the system, and will likely change before implementation. ", "title": "Labware Holders", "type": "object" } }, "$defs": { "EightChannelPipetteDescriptor": { "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Minimum volume that the pipette can handle while maintianing promised tolerances. expects volume units (e.g. ul)." }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum volume that the pipette can hold (spec, not reality). expects volume units (e.g. ul)." }, "max_speed": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum speed that the pipette can move fluid; expects volume per time units (e.g. ul/s)." }, "type": { "const": "EightChannelPipette", "default": "EightChannelPipette", "title": "Type", "type": "string" } }, "title": "EightChannelPipetteDescriptor", "type": "object" }, "GripperDescriptor": { "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "type": { "const": "Gripper", "default": "Gripper", "title": "Type", "type": "string" } }, "title": "GripperDescriptor", "type": "object" }, "LabwareHolderDescriptor": { "description": "Descriptor for an entity that can hold labware.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "LabwareHolder", "default": "LabwareHolder", "title": "Type", "type": "string" } }, "title": "LabwareHolderDescriptor", "type": "object" }, "ProbeDescriptor": { "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "type": { "const": "Probe", "default": "Probe", "title": "Type", "type": "string" } }, "title": "ProbeDescriptor", "type": "object" }, "SingleChannelPipetteDescriptor": { "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Minimum volume that the pipette can handle while maintianing promised tolerances. expects volume units (e.g. ul)." }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum volume that the pipette can hold (spec, not reality). expects volume units (e.g. ul)." }, "max_speed": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum speed that the pipette can move fluid; expects volume per time units (e.g. ul/s)." }, "type": { "const": "SingleChannelPipette", "default": "SingleChannelPipette", "title": "Type", "type": "string" } }, "title": "SingleChannelPipetteDescriptor", "type": "object" }, "ToolHolderDescriptor": { "description": "Descriptor for an entity that can hold tools.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "ToolHolder", "default": "ToolHolder", "title": "Type", "type": "string" } }, "title": "ToolHolderDescriptor", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
labware_holders (dict[str, tcode_api.schemas.descriptions.labware_holder.v1.LabwareHolderDescriptor])schema_version (Literal[1])serial_number (str | None)tool_holders (dict[str, tcode_api.schemas.descriptions.tool_holder.v1.ToolHolderDescriptor])tools (dict[str, Annotated[tcode_api.schemas.descriptions.tool.pipette.single_channel_pipette.v1.SingleChannelPipetteDescriptor | tcode_api.schemas.descriptions.tool.pipette.eight_channel_pipette.v1.EightChannelPipetteDescriptor | tcode_api.schemas.descriptions.tool.probe.v1.ProbeDescriptor | tcode_api.schemas.descriptions.tool.gripper.v1.GripperDescriptor, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid tool descriptors.', discriminator='type')]])type (Literal['Robot'])
-
field labware_holders:
dict[str,LabwareHolderDescriptor] [Optional] list of labware holders currently attached to the robot, with their respective serial numbers (if any) as keys. Not currently used by the system, and will likely change before implementation.
-
field schema_version:
Literal[1] = 1
- field serial_number: str | None = None
Optional serial number - allows unique identification of a robot or tool.
-
field tool_holders:
dict[str,ToolHolderDescriptor] [Optional] list of tool holders currently attached to the robot, with their respective serial numbers (if any) as keys. Not currently used by the system, and will likely change before implementation.
-
field tools:
dict[str,Annotated[SingleChannelPipetteDescriptor|EightChannelPipetteDescriptor|ProbeDescriptor|GripperDescriptor]] [Optional] list of tools currently attached to the robot, with their respective serial numbers (if any) as keys. Not currently used by the system, and will likely change before implementation.
-
field type:
Literal['Robot'] = 'Robot'
- pydantic model tcode_api.schemas.descriptions.RoundBottomDescription
Descriptor for a well with a spherical bottom.
- Note:
The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well’s diameter.
Show JSON schema
{ "title": "RoundBottomDescription", "description": "Descriptor for a well with a spherical bottom.\n\n:note: The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well's diameter.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['Round'])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Round'] = 'Round'
- pydantic model tcode_api.schemas.descriptions.RoundBottomDescriptor
:class:
RoundBottomDescriptionwith optional parameters.Show JSON schema
{ "title": "RoundBottomDescriptor", "description": ":class:``RoundBottomDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['Round'])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['Round'] = 'Round'
- pydantic model tcode_api.schemas.descriptions.SingleChannelPipetteDescriptor
Show JSON schema
{ "title": "SingleChannelPipetteDescriptor", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "serial_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Optional serial number - allows unique identification of a robot or tool.", "title": "Serial Number" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Minimum volume that the pipette can handle while maintianing promised tolerances. expects volume units (e.g. ul)." }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum volume that the pipette can hold (spec, not reality). expects volume units (e.g. ul)." }, "max_speed": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits" }, { "type": "null" } ], "default": null, "description": "Maximum speed that the pipette can move fluid; expects volume per time units (e.g. ul/s)." }, "type": { "const": "SingleChannelPipette", "default": "SingleChannelPipette", "title": "Type", "type": "string" } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
max_speed (ValueWithUnits | None)max_volume (ValueWithUnits | None)min_volume (ValueWithUnits | None)schema_version (Literal[1])serial_number (str | None)type (Literal['SingleChannelPipette'])
- field max_speed: ValueWithUnits | None = None
Maximum speed that the pipette can move fluid; expects volume per time units (e.g. ul/s).
- field max_volume: ValueWithUnits | None = None
Maximum volume that the pipette can hold (spec, not reality). expects volume units (e.g. ul).
- field min_volume: ValueWithUnits | None = None
Minimum volume that the pipette can handle while maintianing promised tolerances. expects volume units (e.g. ul).
-
field schema_version:
Literal[1] = 1
- field serial_number: str | None = None
Optional serial number - allows unique identification of a robot or tool.
-
field type:
Literal['SingleChannelPipette'] = 'SingleChannelPipette'
- pydantic model tcode_api.schemas.descriptions.ToolHolderDescriptor
Descriptor for an entity that can hold tools.
Show JSON schema
{ "title": "ToolHolderDescriptor", "description": "Descriptor for an entity that can hold tools.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "ToolHolder", "default": "ToolHolder", "title": "Type", "type": "string" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
schema_version (Literal[1])type (Literal['ToolHolder'])
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['ToolHolder'] = 'ToolHolder'
- pydantic model tcode_api.schemas.descriptions.TrashDescription
Description of a waste disposal container.
Show JSON schema
{ "title": "TrashDescription", "description": "Description of a waste disposal container.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, "z_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, "type": { "const": "Trash", "default": "Trash", "title": "Type", "type": "string" }, "well": { "$ref": "#/$defs/WellDescription", "description": "Description of the waste volume as a well." } }, "$defs": { "AxisAlignedRectangleDescription": { "description": "Description of an axis-aligned rectangle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." } }, "required": [ "x_length", "y_length" ], "title": "AxisAlignedRectangleDescription", "type": "object" }, "CircleDescription": { "description": "Description of a circle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" } }, "required": [ "diameter" ], "title": "CircleDescription", "type": "object" }, "ConicalBottomDescription": { "description": "Description of a conical bottom well.\n\n:note: It is assumed that the conical portion of the well comes to a point at the bottom of the well", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" } }, "required": [ "offset" ], "title": "ConicalBottomDescription", "type": "object" }, "FlatBottomDescription": { "description": ":class:``FlatBottomDescription`` with optional paramters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescription", "type": "object" }, "RoundBottomDescription": { "description": "Descriptor for a well with a spherical bottom.\n\n:note: The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well's diameter.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescription", "type": "object" }, "VBottomDescription": { "description": "Description of a V-bottom well (e.g. trough).", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "title": "Direction", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." } }, "required": [ "direction", "offset" ], "title": "VBottomDescription", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" }, "WellDescription": { "description": "Description of a well in a labware.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Well", "default": "Well", "title": "Type", "type": "string" }, "depth": { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the well to the bottom of the inside of the well. expects length units" }, "shape": { "description": "The primary cross-sectional shape of the well, typically the shape of the opening.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescription", "Circle": "#/$defs/CircleDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescription" }, { "$ref": "#/$defs/AxisAlignedRectangleDescription" } ], "title": "Shape" }, "bottom_shape": { "description": "The geometry of the bottom of the well. ", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescription", "Flat": "#/$defs/FlatBottomDescription", "Round": "#/$defs/RoundBottomDescription", "V-Shape": "#/$defs/VBottomDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescription" }, { "$ref": "#/$defs/FlatBottomDescription" }, { "$ref": "#/$defs/RoundBottomDescription" }, { "$ref": "#/$defs/VBottomDescription" } ], "title": "Bottom Shape" }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." } }, "required": [ "depth", "shape", "bottom_shape", "min_volume", "max_volume" ], "title": "WellDescription", "type": "object" } }, "required": [ "x_length", "y_length", "z_length", "well" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
named_tags (NamedTags)schema_version (Literal[3])tags (Tags)type (Literal['Trash'])well (tcode_api.schemas.descriptions.well.v1.WellDescription)x_length (XLengthField)y_length (YLengthField)z_length (ZLengthField)
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['Trash'] = 'Trash'
-
field well:
WellDescription[Required] Description of the waste volume as a well.
- field x_length: XLengthField [Required]
The labware’s extent along the x-axis of it’s coordinate system. Expects length units.
- field y_length: YLengthField [Required]
The labware’s extent along the y-axis of it’s coordinate system. Expects length units.
- field z_length: ZLengthField [Required]
The labware’s extent along the z-axis of it’s coordinate system. Expects length units.
- pydantic model tcode_api.schemas.descriptions.TrashDescriptor
:class:
TrashDescriptionwith optional parameters.Show JSON schema
{ "title": "TrashDescriptor", "description": ":class:``TrashDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "z_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "type": { "const": "Trash", "default": "Trash", "title": "Type", "type": "string" }, "well": { "anyOf": [ { "$ref": "#/$defs/WellDescriptor" }, { "type": "null" } ], "default": null, "description": "Description of the waste volume as a well." } }, "$defs": { "AxisAlignedRectangleDescriptor": { "description": ":class:``AxisAlignedRectangleDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null } }, "title": "AxisAlignedRectangleDescriptor", "type": "object" }, "CircleDescriptor": { "description": "CircleDescription with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" }, { "type": "null" } ], "default": null } }, "title": "CircleDescriptor", "type": "object" }, "ConicalBottomDescriptor": { "description": ":class:``ConicalBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" }, { "type": "null" } ], "default": null } }, "title": "ConicalBottomDescriptor", "type": "object" }, "FlatBottomDescriptor": { "description": "Descriptor for a flat bottom well.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescriptor", "type": "object" }, "RoundBottomDescriptor": { "description": ":class:``RoundBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescriptor", "type": "object" }, "VBottomDescriptor": { "description": ":class:``VBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "anyOf": [ { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Direction" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." }, { "type": "null" } ], "default": null } }, "title": "VBottomDescriptor", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" }, "WellDescriptor": { "description": ":class:``WellDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Well", "default": "Well", "title": "Type", "type": "string" }, "depth": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the well to the bottom of the inside of the well. expects length units" }, { "type": "null" } ], "default": null }, "shape": { "anyOf": [ { "description": "Union type of all valid well shape descriptors.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescriptor", "Circle": "#/$defs/CircleDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescriptor" }, { "$ref": "#/$defs/AxisAlignedRectangleDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The primary cross-sectional shape of the well, typically the shape of the opening.", "title": "Shape" }, "bottom_shape": { "anyOf": [ { "description": "Union type of all valid well bottom shape descriptors.", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescriptor", "Flat": "#/$defs/FlatBottomDescriptor", "Round": "#/$defs/RoundBottomDescriptor", "V-Shape": "#/$defs/VBottomDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescriptor" }, { "$ref": "#/$defs/FlatBottomDescriptor" }, { "$ref": "#/$defs/RoundBottomDescriptor" }, { "$ref": "#/$defs/VBottomDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The geometry of the bottom of the well. ", "title": "Bottom Shape" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null } }, "title": "WellDescriptor", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
named_tags (NamedTags)schema_version (Literal[3])tags (Tags)type (Literal['Trash'])well (tcode_api.schemas.descriptions.well.v1.WellDescriptor | None)x_length (XLengthField | None)y_length (YLengthField | None)z_length (ZLengthField | None)
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['Trash'] = 'Trash'
-
field well:
WellDescriptor|None= None Description of the waste volume as a well.
- field x_length: XLengthField | None = None
- field y_length: YLengthField | None = None
- field z_length: ZLengthField | None = None
- pydantic model tcode_api.schemas.descriptions.TubeDescription
Description of a tube.
Show JSON schema
{ "title": "TubeDescription", "description": "Description of a tube.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Tube", "default": "Tube", "title": "Type", "type": "string" }, "depth": { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the tube to the centered bottom of the tube. Expects length units." }, "shape": { "description": "The primary cross-sectional shape of the tube; typically the shape of the opening", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescription", "Circle": "#/$defs/CircleDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescription" }, { "$ref": "#/$defs/AxisAlignedRectangleDescription" } ], "title": "Shape" }, "bottom_shape": { "description": "The geometry of the bottom of the tube. ", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescription", "Flat": "#/$defs/FlatBottomDescription", "Round": "#/$defs/RoundBottomDescription", "V-Shape": "#/$defs/VBottomDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescription" }, { "$ref": "#/$defs/FlatBottomDescription" }, { "$ref": "#/$defs/RoundBottomDescription" }, { "$ref": "#/$defs/VBottomDescription" } ], "title": "Bottom Shape" }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "top_height": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the tube cap above the top of the tube. Expects length units." } }, "$defs": { "AxisAlignedRectangleDescription": { "description": "Description of an axis-aligned rectangle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." } }, "required": [ "x_length", "y_length" ], "title": "AxisAlignedRectangleDescription", "type": "object" }, "CircleDescription": { "description": "Description of a circle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" } }, "required": [ "diameter" ], "title": "CircleDescription", "type": "object" }, "ConicalBottomDescription": { "description": "Description of a conical bottom well.\n\n:note: It is assumed that the conical portion of the well comes to a point at the bottom of the well", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" } }, "required": [ "offset" ], "title": "ConicalBottomDescription", "type": "object" }, "FlatBottomDescription": { "description": ":class:``FlatBottomDescription`` with optional paramters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescription", "type": "object" }, "RoundBottomDescription": { "description": "Descriptor for a well with a spherical bottom.\n\n:note: The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well's diameter.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescription", "type": "object" }, "VBottomDescription": { "description": "Description of a V-bottom well (e.g. trough).", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "title": "Direction", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." } }, "required": [ "direction", "offset" ], "title": "VBottomDescription", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "depth", "shape", "bottom_shape", "min_volume", "max_volume", "top_height" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
bottom_shape (Annotated[tcode_api.schemas.descriptions.well_bottom.conical_bottom.v1.ConicalBottomDescription | tcode_api.schemas.descriptions.well_bottom.flat_bottom.v1.FlatBottomDescription | tcode_api.schemas.descriptions.well_bottom.round_bottom.v1.RoundBottomDescription | tcode_api.schemas.descriptions.well_bottom.v_bottom.v1.VBottomDescription, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well bottom shape descriptions.', discriminator='type')])depth (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='Distance from the top of the tube to the centered bottom of the tube. Expects length units.')])max_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.')])min_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.')])named_tags (NamedTags)schema_version (Literal[1])shape (Annotated[tcode_api.schemas.descriptions.circle.v1.CircleDescription | tcode_api.schemas.descriptions.axis_aligned_rectangle.v1.AxisAlignedRectangleDescription, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well shape descriptions.', discriminator='type')])tags (Tags)top_height (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The height of the tube cap above the top of the tube. Expects length units.')])type (Literal['Tube'])
-
field bottom_shape:
Annotated[ConicalBottomDescription|FlatBottomDescription|RoundBottomDescription|VBottomDescription] [Required] The geometry of the bottom of the tube.
-
field depth:
Annotated[ValueWithUnits] [Required] Distance from the top of the tube to the centered bottom of the tube. Expects length units.
-
field max_volume:
Annotated[ValueWithUnits] [Required] The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.
-
field min_volume:
Annotated[ValueWithUnits] [Required] The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[1] = 1
-
field shape:
Annotated[CircleDescription|AxisAlignedRectangleDescription] [Required] The primary cross-sectional shape of the tube; typically the shape of the opening
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field top_height:
Annotated[ValueWithUnits] [Required] The height of the tube cap above the top of the tube. Expects length units.
-
field type:
Literal['Tube'] = 'Tube'
- pydantic model tcode_api.schemas.descriptions.TubeDescriptor
:class:
TubeDescriptionwith optional parameters.Show JSON schema
{ "title": "TubeDescriptor", "description": ":class:``TubeDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Tube", "default": "Tube", "title": "Type", "type": "string" }, "depth": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the tube to the centered bottom of the tube. Expects length units." }, { "type": "null" } ], "default": null }, "shape": { "anyOf": [ { "description": "Union type of all valid well shape descriptors.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescriptor", "Circle": "#/$defs/CircleDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescriptor" }, { "$ref": "#/$defs/AxisAlignedRectangleDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The primary cross-sectional shape of the tube; typically the shape of the opening", "title": "Shape" }, "bottom_shape": { "anyOf": [ { "description": "Union type of all valid well bottom shape descriptors.", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescriptor", "Flat": "#/$defs/FlatBottomDescriptor", "Round": "#/$defs/RoundBottomDescriptor", "V-Shape": "#/$defs/VBottomDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescriptor" }, { "$ref": "#/$defs/FlatBottomDescriptor" }, { "$ref": "#/$defs/RoundBottomDescriptor" }, { "$ref": "#/$defs/VBottomDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The geometry of the bottom of the tube. ", "title": "Bottom Shape" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "top_height": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the tube cap above the top of the tube. Expects length units." }, { "type": "null" } ], "default": null } }, "$defs": { "AxisAlignedRectangleDescriptor": { "description": ":class:``AxisAlignedRectangleDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null } }, "title": "AxisAlignedRectangleDescriptor", "type": "object" }, "CircleDescriptor": { "description": "CircleDescription with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" }, { "type": "null" } ], "default": null } }, "title": "CircleDescriptor", "type": "object" }, "ConicalBottomDescriptor": { "description": ":class:``ConicalBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" }, { "type": "null" } ], "default": null } }, "title": "ConicalBottomDescriptor", "type": "object" }, "FlatBottomDescriptor": { "description": "Descriptor for a flat bottom well.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescriptor", "type": "object" }, "RoundBottomDescriptor": { "description": ":class:``RoundBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescriptor", "type": "object" }, "VBottomDescriptor": { "description": ":class:``VBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "anyOf": [ { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Direction" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." }, { "type": "null" } ], "default": null } }, "title": "VBottomDescriptor", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
bottom_shape (Annotated[tcode_api.schemas.descriptions.well_bottom.conical_bottom.v1.ConicalBottomDescriptor | tcode_api.schemas.descriptions.well_bottom.flat_bottom.v1.FlatBottomDescriptor | tcode_api.schemas.descriptions.well_bottom.round_bottom.v1.RoundBottomDescriptor | tcode_api.schemas.descriptions.well_bottom.v_bottom.v1.VBottomDescriptor, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well bottom shape descriptors.', discriminator='type')] | None)depth (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='Distance from the top of the tube to the centered bottom of the tube. Expects length units.')] | None)max_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.')] | None)min_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.')] | None)named_tags (NamedTags)schema_version (Literal[1])shape (Annotated[tcode_api.schemas.descriptions.circle.v1.CircleDescriptor | tcode_api.schemas.descriptions.axis_aligned_rectangle.v1.AxisAlignedRectangleDescriptor, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well shape descriptors.', discriminator='type')] | None)tags (Tags)top_height (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The height of the tube cap above the top of the tube. Expects length units.')] | None)type (Literal['Tube'])
-
field bottom_shape:
Optional[Annotated[ConicalBottomDescriptor|FlatBottomDescriptor|RoundBottomDescriptor|VBottomDescriptor]] = None The geometry of the bottom of the tube.
-
field depth:
Optional[Annotated[ValueWithUnits]] = None
-
field max_volume:
Optional[Annotated[ValueWithUnits]] = None
-
field min_volume:
Optional[Annotated[ValueWithUnits]] = None
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[1] = 1
-
field shape:
Optional[Annotated[CircleDescriptor|AxisAlignedRectangleDescriptor]] = None The primary cross-sectional shape of the tube; typically the shape of the opening
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field top_height:
Optional[Annotated[ValueWithUnits]] = None
-
field type:
Literal['Tube'] = 'Tube'
- pydantic model tcode_api.schemas.descriptions.TubeHolderDescription
Description of a tube holder.
Show JSON schema
{ "title": "TubeHolderDescription", "description": "Description of a tube holder.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, "z_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, "type": { "const": "TubeHolder", "default": "TubeHolder", "title": "Type", "type": "string" }, "grid": { "$ref": "#/$defs/GridDescription", "description": "Grid defining the layout of tube slots in the tube holder." }, "tube": { "$ref": "#/$defs/TubeDescription", "description": "Description of a tube held by the tube holder. All tubes are assumed identical." } }, "$defs": { "AxisAlignedRectangleDescription": { "description": "Description of an axis-aligned rectangle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." } }, "required": [ "x_length", "y_length" ], "title": "AxisAlignedRectangleDescription", "type": "object" }, "CircleDescription": { "description": "Description of a circle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" } }, "required": [ "diameter" ], "title": "CircleDescription", "type": "object" }, "ConicalBottomDescription": { "description": "Description of a conical bottom well.\n\n:note: It is assumed that the conical portion of the well comes to a point at the bottom of the well", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" } }, "required": [ "offset" ], "title": "ConicalBottomDescription", "type": "object" }, "FlatBottomDescription": { "description": ":class:``FlatBottomDescription`` with optional paramters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescription", "type": "object" }, "GridDescription": { "description": "Description of a grid layout.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "title": "Row Count", "type": "integer" }, "column_count": { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "title": "Column Count", "type": "integer" }, "row_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, "column_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, "row_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, "column_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." } }, "required": [ "row_count", "column_count", "row_pitch", "column_pitch", "row_offset", "column_offset" ], "title": "GridDescription", "type": "object" }, "RoundBottomDescription": { "description": "Descriptor for a well with a spherical bottom.\n\n:note: The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well's diameter.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescription", "type": "object" }, "TubeDescription": { "description": "Description of a tube.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Tube", "default": "Tube", "title": "Type", "type": "string" }, "depth": { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the tube to the centered bottom of the tube. Expects length units." }, "shape": { "description": "The primary cross-sectional shape of the tube; typically the shape of the opening", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescription", "Circle": "#/$defs/CircleDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescription" }, { "$ref": "#/$defs/AxisAlignedRectangleDescription" } ], "title": "Shape" }, "bottom_shape": { "description": "The geometry of the bottom of the tube. ", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescription", "Flat": "#/$defs/FlatBottomDescription", "Round": "#/$defs/RoundBottomDescription", "V-Shape": "#/$defs/VBottomDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescription" }, { "$ref": "#/$defs/FlatBottomDescription" }, { "$ref": "#/$defs/RoundBottomDescription" }, { "$ref": "#/$defs/VBottomDescription" } ], "title": "Bottom Shape" }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "top_height": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the tube cap above the top of the tube. Expects length units." } }, "required": [ "depth", "shape", "bottom_shape", "min_volume", "max_volume", "top_height" ], "title": "TubeDescription", "type": "object" }, "VBottomDescription": { "description": "Description of a V-bottom well (e.g. trough).", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "title": "Direction", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." } }, "required": [ "direction", "offset" ], "title": "VBottomDescription", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "x_length", "y_length", "z_length", "grid", "tube" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
grid (tcode_api.schemas.descriptions.grid.v1.GridDescription)named_tags (NamedTags)schema_version (Literal[3])tags (Tags)tube (tcode_api.schemas.descriptions.tube.v1.TubeDescription)type (Literal['TubeHolder'])x_length (XLengthField)y_length (YLengthField)z_length (ZLengthField)
-
field grid:
GridDescription[Required] Grid defining the layout of tube slots in the tube holder.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field tube:
TubeDescription[Required] Description of a tube held by the tube holder. All tubes are assumed identical.
-
field type:
Literal['TubeHolder'] = 'TubeHolder'
- field x_length: XLengthField [Required]
The labware’s extent along the x-axis of it’s coordinate system. Expects length units.
- field y_length: YLengthField [Required]
The labware’s extent along the y-axis of it’s coordinate system. Expects length units.
- field z_length: ZLengthField [Required]
The labware’s extent along the z-axis of it’s coordinate system. Expects length units.
- pydantic model tcode_api.schemas.descriptions.TubeHolderDescriptor
:class:
TubeHolderDescriptionwith optional parameters.Show JSON schema
{ "title": "TubeHolderDescriptor", "description": ":class:``TubeHolderDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "z_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "type": { "const": "TubeHolder", "default": "TubeHolder", "title": "Type", "type": "string" }, "grid": { "anyOf": [ { "$ref": "#/$defs/GridDescriptor" }, { "type": "null" } ], "default": null, "description": "Grid defining the layout of tube slots in the tube holder." }, "tube": { "anyOf": [ { "$ref": "#/$defs/TubeDescriptor" }, { "type": "null" } ], "default": null, "description": "Description of a tube held by the tube holder. All tubes are assumed identical." } }, "$defs": { "AxisAlignedRectangleDescriptor": { "description": ":class:``AxisAlignedRectangleDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null } }, "title": "AxisAlignedRectangleDescriptor", "type": "object" }, "CircleDescriptor": { "description": "CircleDescription with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" }, { "type": "null" } ], "default": null } }, "title": "CircleDescriptor", "type": "object" }, "ConicalBottomDescriptor": { "description": ":class:``ConicalBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" }, { "type": "null" } ], "default": null } }, "title": "ConicalBottomDescriptor", "type": "object" }, "FlatBottomDescriptor": { "description": "Descriptor for a flat bottom well.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescriptor", "type": "object" }, "GridDescriptor": { "description": ":class:``GridDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "anyOf": [ { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Row Count" }, "column_count": { "anyOf": [ { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Column Count" }, "row_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "column_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "row_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null }, "column_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null } }, "title": "GridDescriptor", "type": "object" }, "RoundBottomDescriptor": { "description": ":class:``RoundBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescriptor", "type": "object" }, "TubeDescriptor": { "description": ":class:``TubeDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Tube", "default": "Tube", "title": "Type", "type": "string" }, "depth": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the tube to the centered bottom of the tube. Expects length units." }, { "type": "null" } ], "default": null }, "shape": { "anyOf": [ { "description": "Union type of all valid well shape descriptors.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescriptor", "Circle": "#/$defs/CircleDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescriptor" }, { "$ref": "#/$defs/AxisAlignedRectangleDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The primary cross-sectional shape of the tube; typically the shape of the opening", "title": "Shape" }, "bottom_shape": { "anyOf": [ { "description": "Union type of all valid well bottom shape descriptors.", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescriptor", "Flat": "#/$defs/FlatBottomDescriptor", "Round": "#/$defs/RoundBottomDescriptor", "V-Shape": "#/$defs/VBottomDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescriptor" }, { "$ref": "#/$defs/FlatBottomDescriptor" }, { "$ref": "#/$defs/RoundBottomDescriptor" }, { "$ref": "#/$defs/VBottomDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The geometry of the bottom of the tube. ", "title": "Bottom Shape" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "top_height": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the tube cap above the top of the tube. Expects length units." }, { "type": "null" } ], "default": null } }, "title": "TubeDescriptor", "type": "object" }, "VBottomDescriptor": { "description": ":class:``VBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "anyOf": [ { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Direction" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." }, { "type": "null" } ], "default": null } }, "title": "VBottomDescriptor", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
grid (tcode_api.schemas.descriptions.grid.v1.GridDescriptor | None)named_tags (NamedTags)schema_version (Literal[3])tags (Tags)tube (tcode_api.schemas.descriptions.tube.v1.TubeDescriptor | None)type (Literal['TubeHolder'])x_length (XLengthField | None)y_length (YLengthField | None)z_length (ZLengthField | None)
-
field grid:
GridDescriptor|None= None Grid defining the layout of tube slots in the tube holder.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field tube:
TubeDescriptor|None= None Description of a tube held by the tube holder. All tubes are assumed identical.
-
field type:
Literal['TubeHolder'] = 'TubeHolder'
- field x_length: XLengthField | None = None
- field y_length: YLengthField | None = None
- field z_length: ZLengthField | None = None
- pydantic model tcode_api.schemas.descriptions.VBottomDescription
Description of a V-bottom well (e.g. trough).
Show JSON schema
{ "title": "VBottomDescription", "description": "Description of a V-bottom well (e.g. trough).", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "title": "Direction", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "direction", "offset" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
direction (Annotated[Literal['x-axis', 'y-axis'], FieldInfo(annotation=NoneType, required=True, description="The axis of the well's coordinate system along which the spine of the V runs.")])offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The height of the triangular portion of the well. Expects length units.')])schema_version (Literal[1])type (Literal['V-Shape'])
-
field direction:
Annotated[Literal['x-axis','y-axis']] [Required] The axis of the well’s coordinate system along which the spine of the V runs.
-
field offset:
Annotated[ValueWithUnits] [Required] The height of the triangular portion of the well. Expects length units.
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['V-Shape'] = 'V-Shape'
- pydantic model tcode_api.schemas.descriptions.VBottomDescriptor
:class:
VBottomDescriptionwith optional parameters.Show JSON schema
{ "title": "VBottomDescriptor", "description": ":class:``VBottomDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "anyOf": [ { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Direction" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." }, { "type": "null" } ], "default": null } }, "$defs": { "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
direction (Annotated[Literal['x-axis', 'y-axis'], FieldInfo(annotation=NoneType, required=True, description="The axis of the well's coordinate system along which the spine of the V runs.")] | None)offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The height of the triangular portion of the well. Expects length units.')] | None)schema_version (Literal[1])type (Literal['V-Shape'])
-
field direction:
Optional[Annotated[Literal['x-axis','y-axis']]] = None
-
field offset:
Optional[Annotated[ValueWithUnits]] = None
-
field schema_version:
Literal[1] = 1
-
field type:
Literal['V-Shape'] = 'V-Shape'
- pydantic model tcode_api.schemas.descriptions.WellDescription
Description of a well in a labware.
Show JSON schema
{ "title": "WellDescription", "description": "Description of a well in a labware.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Well", "default": "Well", "title": "Type", "type": "string" }, "depth": { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the well to the bottom of the inside of the well. expects length units" }, "shape": { "description": "The primary cross-sectional shape of the well, typically the shape of the opening.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescription", "Circle": "#/$defs/CircleDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescription" }, { "$ref": "#/$defs/AxisAlignedRectangleDescription" } ], "title": "Shape" }, "bottom_shape": { "description": "The geometry of the bottom of the well. ", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescription", "Flat": "#/$defs/FlatBottomDescription", "Round": "#/$defs/RoundBottomDescription", "V-Shape": "#/$defs/VBottomDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescription" }, { "$ref": "#/$defs/FlatBottomDescription" }, { "$ref": "#/$defs/RoundBottomDescription" }, { "$ref": "#/$defs/VBottomDescription" } ], "title": "Bottom Shape" }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." } }, "$defs": { "AxisAlignedRectangleDescription": { "description": "Description of an axis-aligned rectangle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." } }, "required": [ "x_length", "y_length" ], "title": "AxisAlignedRectangleDescription", "type": "object" }, "CircleDescription": { "description": "Description of a circle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" } }, "required": [ "diameter" ], "title": "CircleDescription", "type": "object" }, "ConicalBottomDescription": { "description": "Description of a conical bottom well.\n\n:note: It is assumed that the conical portion of the well comes to a point at the bottom of the well", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" } }, "required": [ "offset" ], "title": "ConicalBottomDescription", "type": "object" }, "FlatBottomDescription": { "description": ":class:``FlatBottomDescription`` with optional paramters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescription", "type": "object" }, "RoundBottomDescription": { "description": "Descriptor for a well with a spherical bottom.\n\n:note: The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well's diameter.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescription", "type": "object" }, "VBottomDescription": { "description": "Description of a V-bottom well (e.g. trough).", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "title": "Direction", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." } }, "required": [ "direction", "offset" ], "title": "VBottomDescription", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } }, "required": [ "depth", "shape", "bottom_shape", "min_volume", "max_volume" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
bottom_shape (Annotated[tcode_api.schemas.descriptions.well_bottom.conical_bottom.v1.ConicalBottomDescription | tcode_api.schemas.descriptions.well_bottom.flat_bottom.v1.FlatBottomDescription | tcode_api.schemas.descriptions.well_bottom.round_bottom.v1.RoundBottomDescription | tcode_api.schemas.descriptions.well_bottom.v_bottom.v1.VBottomDescription, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well bottom shape descriptions.', discriminator='type')])depth (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='Distance from the top of the well to the bottom of the inside of the well. expects length units')])max_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.')])min_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.')])named_tags (NamedTags)schema_version (Literal[1])shape (Annotated[tcode_api.schemas.descriptions.circle.v1.CircleDescription | tcode_api.schemas.descriptions.axis_aligned_rectangle.v1.AxisAlignedRectangleDescription, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well shape descriptions.', discriminator='type')])tags (Tags)type (Literal['Well'])
-
field bottom_shape:
Annotated[ConicalBottomDescription|FlatBottomDescription|RoundBottomDescription|VBottomDescription] [Required] The geometry of the bottom of the well.
-
field depth:
Annotated[ValueWithUnits] [Required] Distance from the top of the well to the bottom of the inside of the well. expects length units
-
field max_volume:
Annotated[ValueWithUnits] [Required] The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.
-
field min_volume:
Annotated[ValueWithUnits] [Required] The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[1] = 1
-
field shape:
Annotated[CircleDescription|AxisAlignedRectangleDescription] [Required] The primary cross-sectional shape of the well, typically the shape of the opening.
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['Well'] = 'Well'
- pydantic model tcode_api.schemas.descriptions.WellDescriptor
:class:
WellDescriptionwith optional parameters.Show JSON schema
{ "title": "WellDescriptor", "description": ":class:``WellDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Well", "default": "Well", "title": "Type", "type": "string" }, "depth": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the well to the bottom of the inside of the well. expects length units" }, { "type": "null" } ], "default": null }, "shape": { "anyOf": [ { "description": "Union type of all valid well shape descriptors.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescriptor", "Circle": "#/$defs/CircleDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescriptor" }, { "$ref": "#/$defs/AxisAlignedRectangleDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The primary cross-sectional shape of the well, typically the shape of the opening.", "title": "Shape" }, "bottom_shape": { "anyOf": [ { "description": "Union type of all valid well bottom shape descriptors.", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescriptor", "Flat": "#/$defs/FlatBottomDescriptor", "Round": "#/$defs/RoundBottomDescriptor", "V-Shape": "#/$defs/VBottomDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescriptor" }, { "$ref": "#/$defs/FlatBottomDescriptor" }, { "$ref": "#/$defs/RoundBottomDescriptor" }, { "$ref": "#/$defs/VBottomDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The geometry of the bottom of the well. ", "title": "Bottom Shape" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null } }, "$defs": { "AxisAlignedRectangleDescriptor": { "description": ":class:``AxisAlignedRectangleDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null } }, "title": "AxisAlignedRectangleDescriptor", "type": "object" }, "CircleDescriptor": { "description": "CircleDescription with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" }, { "type": "null" } ], "default": null } }, "title": "CircleDescriptor", "type": "object" }, "ConicalBottomDescriptor": { "description": ":class:``ConicalBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" }, { "type": "null" } ], "default": null } }, "title": "ConicalBottomDescriptor", "type": "object" }, "FlatBottomDescriptor": { "description": "Descriptor for a flat bottom well.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescriptor", "type": "object" }, "RoundBottomDescriptor": { "description": ":class:``RoundBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescriptor", "type": "object" }, "VBottomDescriptor": { "description": ":class:``VBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "anyOf": [ { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Direction" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." }, { "type": "null" } ], "default": null } }, "title": "VBottomDescriptor", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
bottom_shape (Annotated[tcode_api.schemas.descriptions.well_bottom.conical_bottom.v1.ConicalBottomDescriptor | tcode_api.schemas.descriptions.well_bottom.flat_bottom.v1.FlatBottomDescriptor | tcode_api.schemas.descriptions.well_bottom.round_bottom.v1.RoundBottomDescriptor | tcode_api.schemas.descriptions.well_bottom.v_bottom.v1.VBottomDescriptor, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well bottom shape descriptors.', discriminator='type')] | None)depth (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='Distance from the top of the well to the bottom of the inside of the well. expects length units')] | None)max_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The maximum working fluid volume, as recommended by the manufacturer. Expects volume units.')] | None)min_volume (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The minimum working fluid volume, as recommended by the manufacturer. Expects volume units.')] | None)named_tags (NamedTags)schema_version (Literal[1])shape (Annotated[tcode_api.schemas.descriptions.circle.v1.CircleDescriptor | tcode_api.schemas.descriptions.axis_aligned_rectangle.v1.AxisAlignedRectangleDescriptor, FieldInfo(annotation=NoneType, required=True, description='Union type of all valid well shape descriptors.', discriminator='type')] | None)tags (Tags)type (Literal['Well'])
-
field bottom_shape:
Optional[Annotated[ConicalBottomDescriptor|FlatBottomDescriptor|RoundBottomDescriptor|VBottomDescriptor]] = None The geometry of the bottom of the well.
-
field depth:
Optional[Annotated[ValueWithUnits]] = None
-
field max_volume:
Optional[Annotated[ValueWithUnits]] = None
-
field min_volume:
Optional[Annotated[ValueWithUnits]] = None
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[1] = 1
-
field shape:
Optional[Annotated[CircleDescriptor|AxisAlignedRectangleDescriptor]] = None The primary cross-sectional shape of the well, typically the shape of the opening.
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['Well'] = 'Well'
- pydantic model tcode_api.schemas.descriptions.WellPlateDescription
Description of a well plate.
- Note:
The exception to the ‘no optional attributes’ rule for
***Descriptionclasses
is lid_offset and lid. These attributes default to None, assuming that a described labware has no lid.
Show JSON schema
{ "title": "WellPlateDescription", "description": "Description of a well plate.\n\n:note: The exception to the 'no optional attributes' rule for ``***Description`` classes\nis `lid_offset` and `lid`. These attributes default to None, assuming that a described\nlabware has no lid.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, "z_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, "type": { "const": "WellPlate", "default": "WellPlate", "title": "Type", "type": "string" }, "grid": { "$ref": "#/$defs/GridDescription", "description": "Grid defining the well layout on the plate." }, "well": { "$ref": "#/$defs/WellDescription", "description": "Description of a single well on the plate, which is assumed to be shared by all wells." }, "lid_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset from the top of the labware to the bottom of the lid. Expects length units. Only applicable if the labware has a lid." }, { "type": "null" } ], "default": null }, "lid": { "anyOf": [ { "$ref": "#/$defs/LidDescription" }, { "type": "null" } ], "default": null, "description": "Description of the lid, or None if the plate is un-liddable." } }, "$defs": { "AxisAlignedRectangleDescription": { "description": "Description of an axis-aligned rectangle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." } }, "required": [ "x_length", "y_length" ], "title": "AxisAlignedRectangleDescription", "type": "object" }, "CircleDescription": { "description": "Description of a circle.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" } }, "required": [ "diameter" ], "title": "CircleDescription", "type": "object" }, "ConicalBottomDescription": { "description": "Description of a conical bottom well.\n\n:note: It is assumed that the conical portion of the well comes to a point at the bottom of the well", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" } }, "required": [ "offset" ], "title": "ConicalBottomDescription", "type": "object" }, "FlatBottomDescription": { "description": ":class:``FlatBottomDescription`` with optional paramters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescription", "type": "object" }, "GridDescription": { "description": "Description of a grid layout.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "title": "Row Count", "type": "integer" }, "column_count": { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "title": "Column Count", "type": "integer" }, "row_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, "column_pitch": { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, "row_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, "column_offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." } }, "required": [ "row_count", "column_count", "row_pitch", "column_pitch", "row_offset", "column_offset" ], "title": "GridDescription", "type": "object" }, "LidDescription": { "description": "Description of a plate lid.", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, "y_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, "z_length": { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, "type": { "const": "Lid", "default": "Lid", "title": "Type", "type": "string" }, "stackable": { "description": "Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.", "title": "Stackable", "type": "boolean" } }, "required": [ "x_length", "y_length", "z_length", "stackable" ], "title": "LidDescription", "type": "object" }, "RoundBottomDescription": { "description": "Descriptor for a well with a spherical bottom.\n\n:note: The bottom of the well is assumed to be a hemisphere whose radius is inferred from the well's diameter.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescription", "type": "object" }, "VBottomDescription": { "description": "Description of a V-bottom well (e.g. trough).", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "title": "Direction", "type": "string" }, "offset": { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." } }, "required": [ "direction", "offset" ], "title": "VBottomDescription", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" }, "WellDescription": { "description": "Description of a well in a labware.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Well", "default": "Well", "title": "Type", "type": "string" }, "depth": { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the well to the bottom of the inside of the well. expects length units" }, "shape": { "description": "The primary cross-sectional shape of the well, typically the shape of the opening.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescription", "Circle": "#/$defs/CircleDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescription" }, { "$ref": "#/$defs/AxisAlignedRectangleDescription" } ], "title": "Shape" }, "bottom_shape": { "description": "The geometry of the bottom of the well. ", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescription", "Flat": "#/$defs/FlatBottomDescription", "Round": "#/$defs/RoundBottomDescription", "V-Shape": "#/$defs/VBottomDescription" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescription" }, { "$ref": "#/$defs/FlatBottomDescription" }, { "$ref": "#/$defs/RoundBottomDescription" }, { "$ref": "#/$defs/VBottomDescription" } ], "title": "Bottom Shape" }, "min_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, "max_volume": { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." } }, "required": [ "depth", "shape", "bottom_shape", "min_volume", "max_volume" ], "title": "WellDescription", "type": "object" } }, "required": [ "x_length", "y_length", "z_length", "grid", "well" ] }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
grid (tcode_api.schemas.descriptions.grid.v1.GridDescription)lid (tcode_api.schemas.descriptions.labware.lid.v3.LidDescription | None)lid_offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The offset from the top of the labware to the bottom of the lid. Expects length units. Only applicable if the labware has a lid.')] | None)named_tags (NamedTags)schema_version (Literal[3])tags (Tags)type (Literal['WellPlate'])well (tcode_api.schemas.descriptions.well.v1.WellDescription)x_length (XLengthField)y_length (YLengthField)z_length (ZLengthField)
-
field grid:
GridDescription[Required] Grid defining the well layout on the plate.
-
field lid:
LidDescription|None= None Description of the lid, or None if the plate is un-liddable.
-
field lid_offset:
Optional[Annotated[ValueWithUnits]] = None
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['WellPlate'] = 'WellPlate'
-
field well:
WellDescription[Required] Description of a single well on the plate, which is assumed to be shared by all wells.
- field x_length: XLengthField [Required]
The labware’s extent along the x-axis of it’s coordinate system. Expects length units.
- field y_length: YLengthField [Required]
The labware’s extent along the y-axis of it’s coordinate system. Expects length units.
- field z_length: ZLengthField [Required]
The labware’s extent along the z-axis of it’s coordinate system. Expects length units.
- pydantic model tcode_api.schemas.descriptions.WellPlateDescriptor
:class:
WellPlateDescriptionwith optional parameters.Show JSON schema
{ "title": "WellPlateDescriptor", "description": ":class:``WellPlateDescription`` with optional parameters.", "type": "object", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "z_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "type": { "const": "WellPlate", "default": "WellPlate", "title": "Type", "type": "string" }, "grid": { "anyOf": [ { "$ref": "#/$defs/GridDescriptor" }, { "type": "null" } ], "default": null, "description": "Grid defining the well layout on the plate." }, "well": { "anyOf": [ { "$ref": "#/$defs/WellDescriptor" }, { "type": "null" } ], "default": null, "description": "Description of a single well on the plate, which is assumed to be shared by all wells." }, "lid_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset from the top of the labware to the bottom of the lid. Expects length units. Only applicable if the labware has a lid." }, { "type": "null" } ], "default": null }, "lid": { "anyOf": [ { "$ref": "#/$defs/LidDescriptor" }, { "type": "null" } ], "default": null, "description": "Description of the lid, or None if the plate is un-liddable." } }, "$defs": { "AxisAlignedRectangleDescriptor": { "description": ":class:``AxisAlignedRectangleDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "AxisAlignedRectangle", "default": "AxisAlignedRectangle", "title": "Type", "type": "string" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the X-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The length of the rectangle along the Y-axis of the parent object's coordinate system. expects length units." }, { "type": "null" } ], "default": null } }, "title": "AxisAlignedRectangleDescriptor", "type": "object" }, "CircleDescriptor": { "description": "CircleDescription with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Circle", "default": "Circle", "title": "Type", "type": "string" }, "diameter": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Maximum distance across the circle. expects length units" }, { "type": "null" } ], "default": null } }, "title": "CircleDescriptor", "type": "object" }, "ConicalBottomDescriptor": { "description": ":class:``ConicalBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Conical", "default": "Conical", "title": "Type", "type": "string" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance from the base to tip of the conical portion of the well. expects length units" }, { "type": "null" } ], "default": null } }, "title": "ConicalBottomDescriptor", "type": "object" }, "FlatBottomDescriptor": { "description": "Descriptor for a flat bottom well.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Flat", "default": "Flat", "title": "Type", "type": "string" } }, "title": "FlatBottomDescriptor", "type": "object" }, "GridDescriptor": { "description": ":class:``GridDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Grid", "default": "Grid", "title": "Type", "type": "string" }, "row_count": { "anyOf": [ { "description": "The number of rows in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Row Count" }, "column_count": { "anyOf": [ { "description": "The number of columns in the grid.", "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Column Count" }, "row_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent rows in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "column_pitch": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The distance between the centers of adjacent columns in the grid. Expects length units." }, { "type": "null" } ], "default": null }, "row_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the row axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null }, "column_offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The offset distance from the grid's origin to the center of its parent, measured along the column axis. Modify this value when creating labware whose well grids aren't symmetric.Expects length units." }, { "type": "null" } ], "default": null } }, "title": "GridDescriptor", "type": "object" }, "LidDescriptor": { "description": "LidDescription with optional parameters.", "properties": { "schema_version": { "const": 3, "default": 3, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "x_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the x-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "y_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the y-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "z_length": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The labware's extent along the z-axis of it's coordinate system. Expects length units." }, { "type": "null" } ], "default": null }, "type": { "const": "Lid", "default": "Lid", "title": "Type", "type": "string" }, "stackable": { "anyOf": [ { "description": "Whether the lid supports stacking an ANSI-SLAS-compliant labware on top of it.", "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Stackable" } }, "title": "LidDescriptor", "type": "object" }, "RoundBottomDescriptor": { "description": ":class:``RoundBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "Round", "default": "Round", "title": "Type", "type": "string" } }, "title": "RoundBottomDescriptor", "type": "object" }, "VBottomDescriptor": { "description": ":class:``VBottomDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "type": { "const": "V-Shape", "default": "V-Shape", "title": "Type", "type": "string" }, "direction": { "anyOf": [ { "description": "The axis of the well's coordinate system along which the spine of the V runs.", "enum": [ "x-axis", "y-axis" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Direction" }, "offset": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The height of the triangular portion of the well. Expects length units." }, { "type": "null" } ], "default": null } }, "title": "VBottomDescriptor", "type": "object" }, "ValueWithUnits": { "description": "A numeric value with associated units.\n\n:note: The following values are all equivalent:\n\n ``ValueWithUnits(magnitude=0.005, units=\"L\")``\n\n ``ValueWithUnits(magnitude=5, units=\"mL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"uL\")``\n\n ``ValueWithUnits(magnitude=5000, units=\"mm\u00b3\")``\n\n:note: In the python implementation, ``pint`` is used to resolve units. see `tcode_api.units`.", "properties": { "type": { "const": "ValueWithUnits", "default": "ValueWithUnits", "title": "Type", "type": "string" }, "magnitude": { "title": "Magnitude", "type": "number" }, "units": { "title": "Units", "type": "string" } }, "required": [ "magnitude", "units" ], "title": "ValueWithUnits", "type": "object" }, "WellDescriptor": { "description": ":class:``WellDescription`` with optional parameters.", "properties": { "schema_version": { "const": 1, "default": 1, "title": "Schema Version", "type": "integer" }, "tags": { "description": "List of additional string tags attached to the entity.", "items": { "type": "string" }, "title": "Tags", "type": "array" }, "named_tags": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.", "title": "Named Tags", "type": "object" }, "type": { "const": "Well", "default": "Well", "title": "Type", "type": "string" }, "depth": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "Distance from the top of the well to the bottom of the inside of the well. expects length units" }, { "type": "null" } ], "default": null }, "shape": { "anyOf": [ { "description": "Union type of all valid well shape descriptors.", "discriminator": { "mapping": { "AxisAlignedRectangle": "#/$defs/AxisAlignedRectangleDescriptor", "Circle": "#/$defs/CircleDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/CircleDescriptor" }, { "$ref": "#/$defs/AxisAlignedRectangleDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The primary cross-sectional shape of the well, typically the shape of the opening.", "title": "Shape" }, "bottom_shape": { "anyOf": [ { "description": "Union type of all valid well bottom shape descriptors.", "discriminator": { "mapping": { "Conical": "#/$defs/ConicalBottomDescriptor", "Flat": "#/$defs/FlatBottomDescriptor", "Round": "#/$defs/RoundBottomDescriptor", "V-Shape": "#/$defs/VBottomDescriptor" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/ConicalBottomDescriptor" }, { "$ref": "#/$defs/FlatBottomDescriptor" }, { "$ref": "#/$defs/RoundBottomDescriptor" }, { "$ref": "#/$defs/VBottomDescriptor" } ] }, { "type": "null" } ], "default": null, "description": "The geometry of the bottom of the well. ", "title": "Bottom Shape" }, "min_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The minimum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null }, "max_volume": { "anyOf": [ { "$ref": "#/$defs/ValueWithUnits", "description": "The maximum working fluid volume, as recommended by the manufacturer. Expects volume units." }, { "type": "null" } ], "default": null } }, "title": "WellDescriptor", "type": "object" } } }
- Config:
strict: bool = True
extra: str = ignore
- Fields:
grid (tcode_api.schemas.descriptions.grid.v1.GridDescriptor | None)lid (tcode_api.schemas.descriptions.labware.lid.v3.LidDescriptor | None)lid_offset (Annotated[tcode_api.schemas.common.value_with_units.ValueWithUnits, FieldInfo(annotation=NoneType, required=True, description='The offset from the top of the labware to the bottom of the lid. Expects length units. Only applicable if the labware has a lid.')] | None)named_tags (NamedTags)schema_version (Literal[3])tags (Tags)type (Literal['WellPlate'])well (tcode_api.schemas.descriptions.well.v1.WellDescriptor | None)x_length (XLengthField | None)y_length (YLengthField | None)z_length (ZLengthField | None)
-
field grid:
GridDescriptor|None= None Grid defining the well layout on the plate.
-
field lid:
LidDescriptor|None= None Description of the lid, or None if the plate is un-liddable.
-
field lid_offset:
Optional[Annotated[ValueWithUnits]] = None
- field named_tags: NamedTags [Optional]
Map of names and values of named tags attached to the entity. Values can be strings, numbers, or booleans.
-
field schema_version:
Literal[3] = 3
- field tags: Tags [Optional]
List of additional string tags attached to the entity.
-
field type:
Literal['WellPlate'] = 'WellPlate'
-
field well:
WellDescriptor|None= None Description of a single well on the plate, which is assumed to be shared by all wells.
- field x_length: XLengthField | None = None
- field y_length: YLengthField | None = None
- field z_length: ZLengthField | None = None