Ctrl+K

pylabrobot.resources.Well.__init__

Contents

pylabrobot.resources.Well.__init__#

Well.__init__(name: str, size_x: float, size_y: float, size_z: float, bottom_type: WellBottomType | str = WellBottomType.UNKNOWN, category: str = 'well', max_volume: float | None = None, model: str | None = None, compute_volume_from_height: Callable[[float], float] | None = None, cross_section_type: CrossSectionType | str = CrossSectionType.CIRCLE)#

Create a new well.

Parameters:

  • name (str) – Name of the well.

  • size_x (float) – Size of the well in the x direction.

  • size_y (float) – Size of the well in the y direction.

  • size_z (float) – Size of the well in the z direction.

  • bottom_type (WellBottomType | str) – Type of the bottom of the well. If a string, must be the raw value of the WellBottomType enum. This is used to deserialize and may be removed in the future.

  • category (str) – Category of the well.

  • max_volume (float | None) – Maximum volume of the well. If not specified, the well will be seen as a cylinder and the max volume will be computed based on size_x, size_y, and size_z.

  • compute_volume_from_height (Callable[[float], float] | None) – function to compute the volume from the height relative to the bottom

  • cross_section_type (CrossSectionType | str) – Type of the cross section of the well. If not specified, the well will be seen as a cylinder.

  • model (str | None)

Contents