add new corning costar plates (12, 24 and 48 well) (#311)

Author: rickwierenga

CHANGELOG.md

@@ -51,6 +51,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 - `create_carrier_sites`->`create_resources` (`site_size_{x,y}`->`resource_size_{x,y}`) (https://github.com/PyLabRobot/pylabrobot/pull/280)
 - `MFXCarrier` takes modules as direct children, instead of having `CarrierSite`s as intermediaries (https://github.com/PyLabRobot/pylabrobot/pull/280)
 - `Config.log_dir` is now optional and defaults to None (https://github.com/PyLabRobot/pylabrobot/pull/302)
+- Definition of `Cor_6_wellplate_16800ul_Fb` to match the manufacturer spec (https://github.com/PyLabRobot/pylabrobot/pull/311)
 
 ### Added
 
@@ -100,6 +101,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 - `STAR.request_pip_channel_version`
 - `STAR.ztouch_probe_z_height_using_channel` for getting z-height by probing without cLLD (https://github.com/PyLabRobot/pylabrobot/pull/260)
 - `nest_8_troughplate_22000uL_Vb` and `nest_12_troughplate_15000uL_Vb` (https://github.com/PyLabRobot/pylabrobot/pull/312)
+- `Cor_12_wellplate_6900ul_Fb`, `Cor_24_wellplate_3470ul_Fb` and `Cor_48_wellplate_1620ul_Fb` (https://github.com/PyLabRobot/pylabrobot/pull/311)
 
 ### Deprecated
 
@@ -110,6 +112,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 - `Azenta4titudeFrameStar_96_wellplate_skirted` in favor of `Azenta4titudeFrameStar_96_wellplate_200ul_Vb` (https://github.com/PyLabRobot/pylabrobot/pull/205/)
 - `Cos_96_DWP_2mL_Vb` in favor of `Cos_96_wellplate_2mL_Vb (https://github.com/PyLabRobot/pylabrobot/pull/205/)`
 - Resource definitions with `_L` and `_P`, it is easy enough to use the stem and `.rotated(z=90)` for `_P` (https://github.com/PyLabRobot/pylabrobot/pull/288)
+- `Cor_6_wellplate_Fl` (https://github.com/PyLabRobot/pylabrobot/pull/311)
 
 ### Fixed
 

docs/resources/library/corning_costar.md

@@ -10,7 +10,8 @@ As of 2014, Corning had five major business sectors: display technologies, envir
 
 | Description               | Image              | PLR definition |
 |--------------------|--------------------|--------------------|
-| 'Cos_6_wellplate_16800ul_Fb'<br>Part no.: 3516<br>[manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar%C2%AE-Multiple-Well-Cell-Culture-Plates/p/3516) <br><br>- Material: ? <br>- Cleanliness: 3516: sterilized by gamma irradiation <br>- Nonreversible lids with condensation rings to reduce contamination <br>- Treated for optimal cell attachment <br>- Cell growth area: 9.5 cm² (approx.) <br>- Total volume: 16.8 mL| ![](img/corning_costar/Cos_6_wellplate_16800ul_Fb.jpg) | `Cos_6_wellplate_16800ul_Fb` |
+| 'Cos_6_wellplate_16800ul_Fb'<br>Part no.s: <br><ul> <li>[3335 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar%C2%AE-Multiple-Well-Cell-Culture-Plates/p/3335)</li> <li>[3506 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar%C2%AE-Multiple-Well-Cell-Culture-Plates/p/3506)</li> <li>[3516 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar%C2%AE-Multiple-Well-Cell-Culture-Plates/p/3516)</li> <li>[3471 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar%C2%AE-Multiple-Well-Cell-Culture-Plates/p/3471)</li> </ul> <br>- Material: ? <br>- Cleanliness: 3516: sterilized by gamma irradiation <br>- Nonreversible lids with condensation rings to reduce contamination <br>- Treated for optimal cell attachment <br>- Cell growth area: 9.5 cm² (approx.) <br>- Total volume: 16.8 mL | ![](img/corning_costar/Cos_6_wellplate_16800ul_Fb.jpg) | `Cos_6_wellplate_16800ul_Fb` |
+| 'Cor_12_wellplate_6900ul_Fb' <br>Part no.s: <br><ul> <li>[3336 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3336)</li> <li>[3512 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3512)</li> <li>[3513 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3513)</li> </ul> <br>- Total volume: 6.9 mL | ![](img/corning_costar/Cor_12_wellplate_6900ul_Fb.jpg) | `Cor_12_wellplate_6900ul_Fb` | | 'Cor_24_wellplate_3470ul_Fb' <br>Part no.s: <br><ul> <li>[3337 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3337)</li> <li>[3524 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3524)</li> <li>[3526 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3526)</li> <li>[3527 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3527)</li> <li>[3473 manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3473)</li> </ul> <br>- Total volume: 3.47 mL | ![](img/corning_costar/Cor_24_wellplate_3470ul_Fb.jpg) | `Cor_24_wellplate_3470ul_Fb` |
+| 'Cor_48_wellplate_1620ul_Fb' <br>Part no.: 3548<br>[manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon%C2%AE-96-well-Polystyrene-Microplates/p/3548) <br><br>- Material: TC-treated polystyrene <br>- Cleanliness: sterile <br>- Total volume: 1.62 mL | ![](img/corning_costar/Cor_48_wellplate_1620ul_Fb.jpg) | `Cor_48_wellplate_1620ul_Fb` |
 | 'Cos_96_wellplate_2mL_Vb'<br>Part no.: 3516<br>[manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/UK/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar%C2%AE-Multiple-Well-Cell-Culture-Plates/p/3516) <br><br>- Material: Polypropylene <br>- Resistant to many common organic solvents (e.g., DMSO, ethanol, methanol) <br>- 3960: Sterile and DNase- and RNase-free <br>- Total volume: 2 mL <br>- Features uniform skirt heights for greater robotic gripping surface| ![](img/corning_costar/Cos_96_wellplate_2mL_Vb.jpg) | `Cos_96_wellplate_2mL_Vb` |
 'Cor_96_wellplate_360ul_Fb' <br>Part no.: 353376<br>[manufacturer website](https://ecatalog.corning.com/life-sciences/b2b/NL/en/Microplates/Assay-Microplates/96-Well-Microplates/Falcon®-96-well-Polystyrene-Microplates/p/353376) <br><br>- Material: TC-treated polystyrene <br> - Cleanliness: sterile <br>- Total volume:  392 uL <br>- Working volume: 25-340 uL | ![](img/corning_costar/Cor_96_wellplate_360ul_Fb.jpg) | `Cor_96_wellplate_360ul_Fb` |
-'Cor_6_wellplate_Fl' <br>Part no.: 3471<br>[manufacturer website](https://ecatalog.corning.com/life-sciences/b2c/US/en/Microplates/Assay-Microplates/96-Well-Microplates/Costar®-Multiple-Well-Cell-Culture-Plates/p/3471) | ![](img/corning_costar/Cor_6_wellplate_Fl.jpg) | `Cor_6_wellplate_Fl` |

docs/resources/library/img/corning_costar/Cor_12_wellplate_6900ul_Fb.jpg

@@ -50,39 +50,45 @@ def _compute_height_from_volume_Cos_6_wellplate_16800ul_Fb(
   )
 
 
-def Cos_6_wellplate_16800ul_Fb(name: str, with_lid: bool = True) -> Plate:
-  """Corning-Costar 6-well multi-well plate (MWP); product no.: 3516.
-  - Material: ?
-  - Cleanliness: 3516: sterilized by gamma irradiation
-  - Nonreversible lids with condensation rings to reduce contamination
-  - Treated for optimal cell attachment
-  - Cell growth area: 9.5 cm² (approx.)
-  - Total volume: 16.8 mL
+def Cor_6_wellplate_16800ul_Fb(name: str, lid: Optional[Lid] = None) -> Plate:
   """
+  Corning cat. no.s: 3335, 3506, 3516, 3471
+  """
+  BOTTOM_INNER_WELL_RADIUS = 35.43 / 2  # from Corning Product Description
+  TOP_INNER_WELL_RADIUS = 34.80 / 2  # from Corning Product Description
+
+  well_kwargs = {
+    "size_x": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_y": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_z": 17.4,  # from Corning Product Description
+    "bottom_type": WellBottomType.FLAT,
+    "max_volume": 16800,  # from Corning Product Description
+    "compute_volume_from_height": lambda liquid_height: compute_volume_from_height_conical_frustum(
+      liquid_height, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+    "compute_height_from_volume": lambda liquid_volume: compute_height_from_volume_conical_frustum(
+      liquid_volume, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+  }
+
   return Plate(
     name=name,
-    size_x=127.0,
-    size_y=86.0,
-    size_z=20.0,
-    lid=Cos_6_wellplate_16800ul_Fb_Lid(name=name + "_lid") if with_lid else None,
-    model="Cos_6_wellplate_16800ul_Fb",
+    size_x=127.76,
+    size_y=85.47,
+    size_z=20.27,
+    lid=lid,
+    model=Cor_6_wellplate_16800ul_Fb.__name__,
     ordered_items=create_ordered_items_2d(
       Well,
       num_items_x=3,
       num_items_y=2,
-      dx=7.0,
-      dy=5.45,
-      dz=1.35,
-      item_dx=38.45,
-      item_dy=38.45,
-      size_x=35.0,
-      size_y=35.0,
-      size_z=17.5,
-      bottom_type=WellBottomType.FLAT,
-      material_z_thickness=1.4,
-      cross_section_type=CrossSectionType.CIRCLE,
-      compute_volume_from_height=_compute_volume_from_height_Cos_6_wellplate_16800ul_Fb,
-      compute_height_from_volume=_compute_height_from_volume_Cos_6_wellplate_16800ul_Fb,
+      dx=24.76 - BOTTOM_INNER_WELL_RADIUS,  # from Corning Product Description
+      dy=23.16 - BOTTOM_INNER_WELL_RADIUS,  # from Corning Product Description
+      dz=2.54,  # from Corning Product Description
+      item_dx=39.12,  # from Corning Product Description
+      item_dy=39.12,  # from Corning Product Description
+      material_z_thickness=1.27,  # from Corning Product Description
+      **well_kwargs,
     ),
   )
 
@@ -102,6 +108,149 @@ def Cos_6_wellplate_16800ul_Fb_P(name: str, with_lid: bool = True) -> Plate:
   )
 
 
+# # # # # # # # # # Cor_12_wellplate_6900ul_Fb # # # # # # # # # #
+
+
+def Cor_12_wellplate_6900ul_Fb(name: str, lid: Optional[Lid] = None) -> Plate:
+  """
+  Corning cat. no.s: 3336, 3512, 3513
+
+  not validated
+  """
+  BOTTOM_INNER_WELL_RADIUS = 22.73 / 2  # from Corning Product Description
+  TOP_INNER_WELL_RADIUS = 22.11 / 2  # from Corning Product Description
+
+  well_kwargs = {
+    "size_x": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_y": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_z": 17.5,  # from Corning Product Description
+    "bottom_type": WellBottomType.FLAT,
+    "max_volume": 6900,  # from Corning Product Description
+    "compute_volume_from_height": lambda liquid_height: compute_volume_from_height_conical_frustum(
+      liquid_height, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+    "compute_height_from_volume": lambda liquid_volume: compute_height_from_volume_conical_frustum(
+      liquid_volume, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+  }
+
+  return Plate(
+    name=name,
+    size_x=127.76,  # from Corning Product Description
+    size_y=85.6,  # from Corning Product Description
+    size_z=20.02,  # from Corning Product Description
+    lid=lid,
+    model=Cor_12_wellplate_6900ul_Fb.__name__,
+    ordered_items=create_ordered_items_2d(
+      Well,
+      num_items_x=4,
+      num_items_y=3,
+      dx=24.94 - TOP_INNER_WELL_RADIUS,  # from Corning Product Description
+      dy=16.79 - TOP_INNER_WELL_RADIUS,  # from Corning Product Description
+      dz=2.16,  # from Corning Product Description
+      item_dx=26.01,  # from Corning Product Description
+      item_dy=26.01,  # from Corning Product Description
+      material_z_thickness=1.27,  # from Corning Product Description
+      **well_kwargs,
+    ),
+  )
+
+
+# # # # # # # # # # Cor_24_wellplate_3470ul_Fb # # # # # # # # # #
+
+
+def Cor_24_wellplate_3470ul_Fb(name: str, lid: Optional[Lid] = None) -> Plate:
+  """
+  Corning cat. no.s: 3337, 3524, 3526, 3527, 3473
+  https://www.corning.com/catalog/cls/documents/drawings/MD_Microplate_Dimension_Sheets_Multiple_Well.pdf
+  """
+  BOTTOM_INNER_WELL_RADIUS = 16.26 / 2  # from Corning Product Description
+  TOP_INNER_WELL_RADIUS = 15.62 / 2  # from Corning Product Description
+
+  well_kwargs = {
+    "size_x": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_y": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_z": 17.4,  # from Corning Product Description
+    "bottom_type": WellBottomType.FLAT,
+    "max_volume": 3400,  # website
+    "compute_volume_from_height": lambda liquid_height: compute_volume_from_height_conical_frustum(
+      liquid_height, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+    "compute_height_from_volume": lambda liquid_volume: compute_height_from_volume_conical_frustum(
+      liquid_volume, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+  }
+
+  return Plate(
+    name=name,
+    size_x=127.76,  # from Corning Product Description
+    size_y=85.47,  # from Corning Product Description
+    size_z=20.27,  # from Corning Product Description
+    lid=lid,
+    model=Cor_24_wellplate_3470ul_Fb.__name__,
+    ordered_items=create_ordered_items_2d(
+      Well,
+      num_items_x=6,
+      num_items_y=4,
+      dx=17.46 - TOP_INNER_WELL_RADIUS,  # from Corning Product Description
+      dy=13.78 - TOP_INNER_WELL_RADIUS,  # from Corning Product Description
+      dz=2.54,  # from Corning Product Description
+      item_dx=19.3,  # from Corning Product Description
+      item_dy=19.3,  # from Corning Product Description
+      material_z_thickness=1.27,  # from Corning Product Description
+      **well_kwargs,
+    ),
+  )
+
+
+# # # # # # # # # # Cor_48_wellplate_1620ul_Fb # # # # # # # # # #
+
+
+def Cor_48_wellplate_1620ul_Fb(name: str, lid: Optional[Lid] = None) -> Plate:
+  """
+  Corning cat. no.s: 3548
+
+  not validated
+  """
+  BOTTOM_INNER_WELL_RADIUS = 11.56 / 2  # from Corning Product Description
+  TOP_INNER_WELL_RADIUS = 11.05 / 2  # from Corning Product Description
+
+  well_kwargs = {
+    "size_x": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_y": BOTTOM_INNER_WELL_RADIUS * 2,
+    "size_z": 17.4,  # from Corning Product Description
+    "bottom_type": WellBottomType.FLAT,
+    "max_volume": 1620,  # from Corning Product Description
+    "compute_volume_from_height": lambda liquid_height: compute_volume_from_height_conical_frustum(
+      liquid_height, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+    "compute_height_from_volume": lambda liquid_volume: compute_height_from_volume_conical_frustum(
+      liquid_volume, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
+    ),
+  }
+
+  return Plate(
+    name=name,
+    size_x=127.76,  # from Corning Product Description
+    size_y=85.6,  # from Corning Product Description
+    size_z=20.02,  # from Corning Product Description
+    lid=lid,
+    model=Cor_48_wellplate_1620ul_Fb.__name__,
+    ordered_items=create_ordered_items_2d(
+      Well,
+      num_items_x=8,
+      num_items_y=6,
+      dx=18.16 - TOP_INNER_WELL_RADIUS,  # from Corning Product Description
+      dy=10.08 - TOP_INNER_WELL_RADIUS,  # from Corning Product Description
+      dz=2.87,  # from Corning Product Description
+      item_dx=13.08,  # from Corning Product Description
+      item_dy=13.08,  # from Corning Product Description
+      material_z_thickness=1.27,  # from Corning Product Description
+      **well_kwargs,
+    ),
+  )
+
+
 # # # # # # # # # # Cos_96_wellplate_2mL_Vb # # # # # # # # # #
 
 
@@ -281,48 +430,6 @@ def Cor_96_wellplate_360ul_Fb(name: str, with_lid: bool = False) -> Plate:
   )
 
 
-# # # # # # # # # # Cor_6_wellplate_Fl # # # # # # # # # #
-
-
 def Cor_6_wellplate_Fl(name: str, lid: Optional[Lid] = None) -> Plate:
-  """
-  Corning cat. no.: 3471
-  - Material: Polystyrene
-  - Tissue culture treated: No
-  """
-  BOTTOM_INNER_WELL_RADIUS = 34.798 / 2  # from Corning Product Description
-  TOP_INNER_WELL_RADIUS = 35.433 / 2  # from Corning Product Description
-
-  well_kwargs = {
-    "size_x": BOTTOM_INNER_WELL_RADIUS * 2,
-    "size_y": BOTTOM_INNER_WELL_RADIUS * 2,
-    "size_z": 17.399,  # from Corning Product Description
-    "bottom_type": WellBottomType.FLAT,
-    "max_volume": 16.850,  # calculated
-    "compute_volume_from_height": lambda liquid_height: compute_volume_from_height_conical_frustum(
-      liquid_height, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
-    ),
-    "compute_height_from_volume": lambda liquid_volume: compute_height_from_volume_conical_frustum(
-      liquid_volume, BOTTOM_INNER_WELL_RADIUS, TOP_INNER_WELL_RADIUS
-    ),
-  }
-
-  return Plate(
-    name=name,
-    size_x=127.762,  # from Corning Product Description
-    size_y=85.471,  # from Corning Product Description
-    size_z=22.6314,  # from Corning Product Description
-    lid=lid,
-    model=Cor_6_wellplate_Fl.__name__,
-    ordered_items=create_ordered_items_2d(
-      Well,
-      num_items_x=3,
-      num_items_y=2,
-      dx=7.5,  # measured
-      dy=6.3,  # measured
-      dz=1.8,  # calibrated manually by z-stepping down using a pipette.
-      item_dx=39,  # measured
-      item_dy=39,  # measured
-      **well_kwargs,
-    ),
-  )
+  # https://github.com/PyLabRobot/pylabrobot/issues/313
+  raise NotImplementedError("deprecated. use Cor_6_wellplate_16800ul_Fb instead")