unitelabs.labware.liquids

Attributes

Name
__all__
Type
Value
= [ "Mixture", "Ingredient", "Liquid", "Sample", "LiquidOverflowError", "LiquidUnderflowError", "Container", "Fillable", "Hole", "LiquidClass" ]
Description

Classes

Container
Hold and manage liquids in a container.
MRO
Shape
⎿⎽Stack
⎿⎽⎽Container
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  height : Decimal,
  sections : list[Shape],
  max_volume : Decimal,
  liquids : list[tuple[Liquid, decimal.Decimal]]
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    height
    Type
    Decimal
    Default
    Description
  - Name
    sections
    Type
    list[Shape]
    Default
    Description
  - Name
    max_volume
    Type
    Decimal
    Default
    Description
    The maximum volume in µl that can safely be added to the container.
  - Name
    liquids
    Type
    list[tuple[Liquid, decimal.Decimal]]
    Default
    Description
- __post_init__(self) -> None
- @log()
  add_liquid(self, liquid : Liquid, volume : Number) -> None
  Add a certain volume of liquid into this container.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    liquid
    Type
    Liquid
    Default
    Description
    The type of liquid to add.
  - Name
    volume
    Type
    Number
    Default
    Description
    The volume of liquid in µl to add.
  Exceptions
  Type
  LiquidOverflowError
  Description
  If the volume does not fit into the container anymore.
- @log()
  add_liquids(self, liquids : list[tuple[Liquid, decimal.Decimal]]) -> None
  Add a mixture of liquids into this container.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    liquids
    Type
    list[tuple[Liquid, decimal.Decimal]]
    Default
    Description
- @log()
  remove_liquid(self, volume : Number) -> list[tuple[Liquid, decimal.Decimal]]
  Remove a certain volume from this container.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    volume
    Type
    Number
    Default
    Description
    The volume of liquid in µl to remove.
  Response
  Type
  list[tuple[Liquid, decimal.Decimal]]
  Description
  Exceptions
  Type
  LiquidUnderflowError
  Description
  If the container does not contain enough liquid to remove.
- volume_for_height(self, height) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    height
    Type
    Default
    Description
- height_for_volume(self, volume) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    volume
    Type
    Default
    Description
Attributes
- Name
  max_volume
  Type
  Decimal
  Value
  = Decimal()
  Description
- Name
  liquids
  Type
  list[tuple[Liquid, decimal.Decimal]]
  Value
  = dataclasses.field(default_factory=list)
  Description
- Name
  height
  Type
  Decimal
  Value
  = dataclasses.field(init=False)
  Description
- Name
  _volume
  Type
  Value
  = Decimal()
  Description
- Name
  _liquid_level
  Type
  Value
  = Decimal()
  Description
- Name
  logger
  Type
  logging.Logger
  Value
  = None
  Description
- Name
  volume
  Type
  decimal.Decimal
  Value
  = None
  Description
  The current volume in µl of liquid filling the container.
- Name
  free_volume
  Type
  decimal.Decimal
  Value
  = None
  Description
  The freely available volume in µl in the container.
- Name
  liquid_level
  Type
  decimal.Decimal
  Value
  = None
  Description
  The height of the liquid in the container, in mm.
- Name
  sections
  Type
  list[Shape]
  Value
  = dataclasses.field(default_factory=list)
  Description
- Name
  max_fitting_volume
  Type
  decimal.Decimal
  Value
  = None
  Description
  The maximum volume that fits into this shape.
Fillable
MRO
Resource
⎿⎽Group
⎿⎽⎽Fillable
Bases
Group[Hole]
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  children : collections.abc.Sequence[T],
  container : Container
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    children
    Type
    collections.abc.Sequence[T]
    Default
    Description
  - Name
    container
    Type
    Container
    Default
    Description
- get_holes_for_channels(self, channels : collections.abc.Sequence[int]) -> list[Hole]
  Get hole for channel.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    channels
    Type
    collections.abc.Sequence[int]
    Default
    Description
    The zero-based indices of the channels involved.
  Response
  Type
  list[Hole]
  Description
- __post_init__(self, *kwargs) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    *kwargs
    Type
    Default
    = ()
    Description
- __init_subclass__(cls) -> None
  Parameters
  - Name
    cls
    Type
    Default
    Description
- @typing_extensions.override
  rotate_by(self, angle : int) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    angle
    Type
    int
    Default
    Description
- find(self, identifier) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    identifier
    Type
    Default
    Description
- __contains__(self, item : typing.Any) -> bool
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    item
    Type
    typing.Any
    Default
    Description
  Response
  Type
  bool
  Description
- __getitem__(self, key : typing.Union[int, str, slice]) -> typing.Union[T, collections.abc.Sequence[T]]
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    key
    Type
    typing.Union[int, str, slice]
    Default
    Description
  Response
  Type
  typing.Union[T, collections.abc.Sequence[T]]
  Description
- __len__(self) -> int
  The number of children in this group.
  Response
  Type
  int
  Description
  The number of children in this group.
- __iter__(self) -> collections.abc.Iterator[T]
  Iterate over the children of this group.
  Response
  Type
  collections.abc.Iterator[T]
  Description
  An iterator to iterate over all children in this group.
- _index(self, key : typing.Union[int, str, slice]) -> typing.Union[int, slice]
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    key
    Type
    typing.Union[int, str, slice]
    Default
    Description
  Response
  Type
  typing.Union[int, slice]
  Description
- copy(self, **changes) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    **changes
    Type
    Default
    = {}
    Description
- serialize(self) -> JsonSchema
  Response
  Type
  JsonSchema
  Description
- assign_to(self, parent : Group) -> None
  Set the parent of this resource to the given group.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    parent
    Type
    Group
    Default
    Description
    The group to which this resource is assigned to.
- @deprecation.deprecated(deprecated_in='0.1.20', removed_in='0.2.0', current_version=__version__, details='Use `rotate_by` instead.')
  rotate(self, angle : int) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    angle
    Type
    int
    Default
    Description
- rotate_to(self, angle : int) -> None
  Rotate to the given absolute angle in degrees.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    angle
    Type
    int
    Default
    Description
    The angle in degrees to rotate the resource. Must be a multiple of 90°.
- @classmethod
  deserialize(cls, identifier : str, schema : JsonSchema) -> typing_extensions.Self
  Deserialize a JSON-like dictionary to a resource.
  Parameters
  - Name
    cls
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    Description
    The identifier of the resource to deserialize.
  - Name
    schema
    Type
    JsonSchema
    Default
    Description
    The JSON-like dictionary with the resource's data.
  Response
  Type
  typing_extensions.Self
  Description
  The newly created resource.
- @classmethod
  subclass_by_name(cls, name : str) -> typing.Optional[type[Resource]]
  Recursively find a resource subclass with the given name.
  Parameters
  - Name
    cls
    Type
    Default
    Description
  - Name
    name
    Type
    str
    Default
    Description
    The name of the class to find.
  Response
  Type
  typing.Optional[type[Resource]]
  Description
  The class with the given name, or `None` if no such class exists.
  Exceptions
  Type
  TypeError
  Description
  If the name is not a valid class name.
Attributes
- Name
  container
  Type
  Container
  Value
  = dataclasses.field(default_factory=Container)
  Description
- Name
  children
  Type
  collections.abc.Sequence[T]
  Value
  = dataclasses.field(metadata={'marshmallow_field': marshmallow.fields.List(ChildrenField(Resource.Schema(), 'identifier'))}, repr=False, default_factory=list)
  Description
- Name
  identifier
  Type
  str
  Value
  = dataclasses.field(default_factory=lambda: str(uuid.uuid4().hex[:8]))
  Description
- Name
  rotation
  Type
  int
  Value
  = 0
  Description
- Name
  dimensions
  Type
  Vector
  Value
  = dataclasses.field(default_factory=Vector)
  Description
- Name
  location
  Type
  typing.Optional[Vector]
  Value
  = None
  Description
- Name
  Schema
  Type
  type[marshmallow.Schema]
  Value
  = marshmallow.Schema
  Description
- Name
  name
  Type
  str
  Value
  = None
  Description
  A human readable name to identify resources.
- Name
  absolute_location
  Type
  Vector
  Value
  = None
  Description
  The absolute location of this resource.
- Name
  width
  Type
  decimal.Decimal
  Value
  = None
  Description
  The size of the resource along the x-axis.
- Name
  depth
  Type
  decimal.Decimal
  Value
  = None
  Description
  The size of the resource along the y-axis.
- Name
  height
  Type
  decimal.Decimal
  Value
  = None
  Description
  The size of the resource along the z-axis.
- Name
  center
  Type
  Vector
  Value
  = None
  Description
  The center base of this resource.
Hole
MRO
Resource
⎿⎽Hole
Decorators
dataclasses.dataclass
Methods
- __init__(self) -> None
- __post_init__(self, *_kwargs) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    *_kwargs
    Type
    Default
    = ()
    Description
- __init_subclass__(cls) -> None
  Parameters
  - Name
    cls
    Type
    Default
    Description
- assign_to(self, parent : Group) -> None
  Set the parent of this resource to the given group.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    parent
    Type
    Group
    Default
    Description
    The group to which this resource is assigned to.
- @deprecation.deprecated(deprecated_in='0.1.20', removed_in='0.2.0', current_version=__version__, details='Use `rotate_by` instead.')
  rotate(self, angle : int) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    angle
    Type
    int
    Default
    Description
- rotate_by(self, angle : int) -> None
  Rotate clockwise by the given angle in degrees. Use negative numbers for counter clockwise rotation.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    angle
    Type
    int
    Default
    Description
    The angle in degrees to rotate the resource. Must be a multiple of 90°.
- rotate_to(self, angle : int) -> None
  Rotate to the given absolute angle in degrees.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    angle
    Type
    int
    Default
    Description
    The angle in degrees to rotate the resource. Must be a multiple of 90°.
- find(self, identifier : str) -> Resource
  Find a resource by its identifier.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    Description
    The resource's identifier to search for.
  Response
  Type
  Resource
  Description
  The resource with the corresponding identifier.
  Exceptions
  Type
  TypeError
  Description
  If the identifier is a non string value.
  Type
  MissingResourceError
  Description
  If the resource could not be found.
- __contains__(self, item : typing.Any) -> bool
  Check whether a resource is assigned to this resource.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    item
    Type
    typing.Any
    Default
    Description
    The resource to search for.
  Response
  Type
  bool
  Description
  True if the resource could be found, False otherwise.
- copy(self, **changes) -> typing_extensions.Self
  Return a copy of this resource.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    **changes
    Type
    Default
    = {}
    Description
    Replace fields with values from `changes`.
  Response
  Type
  typing_extensions.Self
  Description
  A copy of this resource.
- serialize(self) -> JsonSchema
  Serialize this resource as a JSON-like dictionary.
  Response
  Type
  JsonSchema
  Description
  The JSON-like dictionary with the resource's data.
- @classmethod
  deserialize(cls, identifier : str, schema : JsonSchema) -> typing_extensions.Self
  Deserialize a JSON-like dictionary to a resource.
  Parameters
  - Name
    cls
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    Description
    The identifier of the resource to deserialize.
  - Name
    schema
    Type
    JsonSchema
    Default
    Description
    The JSON-like dictionary with the resource's data.
  Response
  Type
  typing_extensions.Self
  Description
  The newly created resource.
- @classmethod
  subclass_by_name(cls, name : str) -> typing.Optional[type[Resource]]
  Recursively find a resource subclass with the given name.
  Parameters
  - Name
    cls
    Type
    Default
    Description
  - Name
    name
    Type
    str
    Default
    Description
    The name of the class to find.
  Response
  Type
  typing.Optional[type[Resource]]
  Description
  The class with the given name, or `None` if no such class exists.
  Exceptions
  Type
  TypeError
  Description
  If the name is not a valid class name.
Attributes
- Name
  identifier
  Type
  str
  Value
  = dataclasses.field(default_factory=lambda: str(uuid.uuid4().hex[:8]))
  Description
- Name
  rotation
  Type
  int
  Value
  = 0
  Description
- Name
  dimensions
  Type
  Vector
  Value
  = dataclasses.field(default_factory=Vector)
  Description
- Name
  location
  Type
  typing.Optional[Vector]
  Value
  = None
  Description
- Name
  Schema
  Type
  type[marshmallow.Schema]
  Value
  = marshmallow.Schema
  Description
- Name
  name
  Type
  str
  Value
  = None
  Description
  A human readable name to identify resources.
- Name
  absolute_location
  Type
  Vector
  Value
  = None
  Description
  The absolute location of this resource.
- Name
  width
  Type
  decimal.Decimal
  Value
  = None
  Description
  The size of the resource along the x-axis.
- Name
  depth
  Type
  decimal.Decimal
  Value
  = None
  Description
  The size of the resource along the y-axis.
- Name
  height
  Type
  decimal.Decimal
  Value
  = None
  Description
  The size of the resource along the z-axis.
- Name
  center
  Type
  Vector
  Value
  = None
  Description
  The center base of this resource.
Liquid
Common types of substances used in liquid handling.
Bases
enum.Enum
Methods
- __str__(self) -> str
  Response
  Type
  str
  Description
Attributes
- Name
  ACETONITRILE
  Type
  Value
  = 'Acetonitrile'
  Description
- Name
  BLOOD
  Type
  Value
  = 'Blood'
  Description
- Name
  BRAIN_HOMOGENATE
  Type
  Value
  = 'Brain-Homogenate'
  Description
- Name
  CHLOROFORM
  Type
  Value
  = 'Chloroform'
  Description
- Name
  DIMETHYL_SULFOXIDE
  Type
  Value
  = 'Dimethyl sulfoxide'
  Description
- Name
  DMSO
  Type
  Value
  = 'Dimethyl sulfoxide'
  Description
- Name
  ETHANOL
  Type
  Value
  = 'Ethanol'
  Description
- Name
  EtOH
  Type
  Value
  = 'Ethanol'
  Description
- Name
  GLYCERIN
  Type
  Value
  = 'Glycerin'
  Description
- Name
  METHANOL
  Type
  Value
  = 'Methanol'
  Description
- Name
  MeOH
  Type
  Value
  = 'Methanol'
  Description
- Name
  OCTANOL
  Type
  Value
  = 'Octanol'
  Description
- Name
  PBS_BUFFER
  Type
  Value
  = 'PBS Buffer'
  Description
- Name
  PLASMA
  Type
  Value
  = 'Plasma'
  Description
- Name
  SERUM
  Type
  Value
  = 'Serum'
  Description
- Name
  TE_BUFFER
  Type
  Value
  = 'Tris-EDTA buffer'
  Description
- Name
  WATER
  Type
  Value
  = 'Water'
  Description
LiquidClass
Liquid classes are global definitions for a liquid that can be used in any method. The liquid class provides detailed instructions for how a channel's plunger should manipulate a liquid. A liquid class needs to be selected for each aspiration and dispense step in a method, and that liquid class needs to match the tip type and mode. This means that the liquid class needs to be defined in detail ahead of time before the method can be built.
Bases
typing.Generic[A_co, D_co]
Decorators
dataclasses.dataclass
Methods
- __init__(self, liquid : Mixture) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    liquid
    Type
    Mixture
    Default
    Description
- __str__(self) -> str
  Response
  Type
  str
  Description
Attributes
- Name
  liquid
  Type
  Mixture
  Value
  = None
  Description
- Name
  aspirate_parameters
  Type
  A_co
  Value
  = None
  Description
  Parameter set used for the aspirate method.
- Name
  dispense_parameters
  Type
  D_co
  Value
  = None
  Description
  Parameter set used for the dispense method.
LiquidOverflowError
Raised when a container is too full to add the specified volume of liquid.
Bases
Exception
LiquidUnderflowError
Raised when a container is too empty to remove the specified volume of liquid.
Bases
Exception
Ingredient
The liquid as part of a mixture with the given amount.
Decorators
dataclasses.dataclass
Methods
- __init__(self, liquid : typing.Union[Liquid, Sample], amount : Decimal) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    liquid
    Type
    typing.Union[Liquid, Sample]
    Default
    Description
  - Name
    amount
    Type
    Decimal
    Default
    Description
- __str__(self) -> str
  Response
  Type
  str
  Description
Attributes
- Name
  liquid
  Type
  typing.Union[Liquid, Sample]
  Value
  = None
  Description
- Name
  amount
  Type
  Decimal
  Value
  = Decimal(default=0)
  Description
Mixture
Combination of liquids mixed together.
Bases
collections.abc.MutableSequence[Ingredient]
Methods
- __init__(self, ingredients : typing.Optional[collections.abc.Iterable[Ingredient]]) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    ingredients
    Type
    typing.Optional[collections.abc.Iterable[Ingredient]]
    Default
    = None
    Description
- __len__(self) -> int
  Return len(self).
  Response
  Type
  int
  Description
- __contains__(self, value : typing.Union[Liquid, Sample]) -> bool
  Return value in self.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    typing.Union[Liquid, Sample]
    Default
    Description
  Response
  Type
  bool
  Description
- __getitem__(self, index : typing.Union[typing.SupportsIndex, slice]) -> typing.Union[Ingredient, list[Ingredient]]
  x.__getitem__(y) <==> x[y]
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    index
    Type
    typing.Union[typing.SupportsIndex, slice]
    Default
    Description
  Response
  Type
  typing.Union[Ingredient, list[Ingredient]]
  Description
- __setitem__(self, index : typing.Union[typing.SupportsIndex, slice], value : typing.Union[Ingredient, collections.abc.Iterable[Ingredient]]) -> None
  Set self[key] to value.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    index
    Type
    typing.Union[typing.SupportsIndex, slice]
    Default
    Description
  - Name
    value
    Type
    typing.Union[Ingredient, collections.abc.Iterable[Ingredient]]
    Default
    Description
- __delitem__(self, index : typing.Union[typing.SupportsIndex, slice]) -> None
  Delete self[key].
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    index
    Type
    typing.Union[typing.SupportsIndex, slice]
    Default
    Description
- __iter__(self) -> collections.abc.Iterator[Ingredient]
  Implement iter(self).
  Response
  Type
  collections.abc.Iterator[Ingredient]
  Description
- __reversed__(self) -> collections.abc.Iterator[Ingredient]
  Return a reverse iterator over the list.
  Response
  Type
  collections.abc.Iterator[Ingredient]
  Description
- __add__(self, other : typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]) -> Mixture
  Return self+other.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]
    Default
    Description
  Response
  Type
  Mixture
  Description
- __radd__(self, other : typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]) -> Mixture
  Return other+self.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]
    Default
    Description
  Response
  Type
  Mixture
  Description
- __iadd__(self, other : typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]) -> Mixture
  Implement self+=value.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    other
    Type
    typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]
    Default
    Description
  Response
  Type
  Mixture
  Description
- __str__(self) -> None
  Return str(self).
- __repr__(self) -> None
  Return repr(self).
- __eq__(self, value : typing.Union[Mixture, collections.abc.Iterable[Ingredient]]) -> bool
  Return self==value.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    typing.Union[Mixture, collections.abc.Iterable[Ingredient]]
    Default
    Description
  Response
  Type
  bool
  Description
- @log()
  add(self, value : typing.Union[Liquid, Sample], volume : Number) -> None
  Add volume of liquid to this mixture.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    typing.Union[Liquid, Sample]
    Default
    Description
    The type of liquid to add.
  - Name
    volume
    Type
    Number
    Default
    Description
    The volume of liquid in µl to add.
- @log()
  append(self, value : Ingredient) -> None
  Append object to the end of the list.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    Ingredient
    Default
    Description
- @log()
  extend(self, values : typing.Union[Mixture, collections.abc.Iterable[Ingredient]]) -> None
  Extend list by appending elements from the iterable.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    values
    Type
    typing.Union[Mixture, collections.abc.Iterable[Ingredient]]
    Default
    Description
- @log()
  insert(self, index : typing.SupportsIndex, value : Ingredient) -> None
  Insert value before index.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    index
    Type
    typing.SupportsIndex
    Default
    Description
  - Name
    value
    Type
    Ingredient
    Default
    Description
- @log()
  pop(self, index : typing.SupportsIndex) -> Ingredient
  Remove and return item at index (default last).
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    index
    Type
    typing.SupportsIndex
    Default
    Description
  Response
  Type
  Ingredient
  Description
  Exceptions
  Type
  IndexError
  Description
  if list is empty or index is out of range.
- @log()
  remove(self, volume : Number) -> Mixture
  Remove volume proportionally from mixture.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    volume
    Type
    Number
    Default
    Description
    The volume of liquid in µl to remove.
  Response
  Type
  Mixture
  Description
  The removed mixture of liquid.
  Exceptions
  Type
  ValueError
  Description
  If the volume to remove exceeds the current volume.
- @log()
  clear(self) -> None
  Remove all items from the mixture.
- copy(self) -> Mixture
  Return a shallow copy of the mixture.
  Response
  Type
  Mixture
  Description
- count(self, value : typing.Union[Liquid, Sample]) -> int
  Return number of occurrences of value.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    typing.Union[Liquid, Sample]
    Default
    Description
  Response
  Type
  int
  Description
- index(self, value : typing.Union[Liquid, Sample], start : typing.SupportsIndex, stop : typing.SupportsIndex) -> int
  Return first index of value.
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    typing.Union[Liquid, Sample]
    Default
    Description
  - Name
    start
    Type
    typing.SupportsIndex
    Default
    = 0
    Description
  - Name
    stop
    Type
    typing.SupportsIndex
    Default
    = sys.maxsize
    Description
  Response
  Type
  int
  Description
  Exceptions
  Type
  ValueError
  Description
  if the value is not present.
- reverse(self) -> None
  Reverse sequence in place.
Attributes
- Name
  _ingredients
  Type
  list[Ingredient]
  Value
  = list(ingredients) if ingredients is not None else []
  Description
- Name
  _volume
  Type
  decimal.Decimal
  Value
  = sum(v.amount for v in self._ingredients, start=decimal.Decimal(0))
  Description
- Name
  logger
  Type
  logging.Logger
  Value
  = None
  Description
- Name
  volume
  Type
  decimal.Decimal
  Value
  = None
  Description
  The current volume in µl of liquid in this mixture.
- Name
  ingredients
  Type
  list[Ingredient]
  Value
  = None
  Description
  The current ingredients in this mixture.
Sample
Traceable sample used in liquid handling.
Decorators
dataclasses.dataclass
Methods
- __init__(self, identifier : str) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    Description
- __str__(self) -> str
  Response
  Type
  str
  Description
Attributes
- Name
  identifier
  Type
  str
  Value
  = None
  Description

unitelabs.labware.liquids

Packages

Attributes

Classes

Container

Methods

__init__(self, height : Decimal, sections : list[Shape], max_volume : Decimal, liquids : list[tuple[Liquid, decimal.Decimal]]) -> None

Parameters

__post_init__(self) -> None

@log()add_liquid(self, liquid : Liquid, volume : Number) -> None

Parameters

Exceptions

@log()add_liquids(self, liquids : list[tuple[Liquid, decimal.Decimal]]) -> None

Parameters

@log()remove_liquid(self, volume : Number) -> list[tuple[Liquid, decimal.Decimal]]

Parameters

Response

Exceptions

volume_for_height(self, height) -> None

Parameters

height_for_volume(self, volume) -> None

Parameters

Attributes

Fillable

Methods

__init__(self, children : collections.abc.Sequence[T], container : Container) -> None

Parameters

get_holes_for_channels(self, channels : collections.abc.Sequence[int]) -> list[Hole]

Parameters

Response

__post_init__(self, *kwargs) -> None

Parameters

__init_subclass__(cls) -> None

Parameters

@typing_extensions.overriderotate_by(self, angle : int) -> None

Parameters

find(self, identifier) -> None

Parameters

__contains__(self, item : typing.Any) -> bool

Parameters

Response

__getitem__(self, key : typing.Union[int, str, slice]) -> typing.Union[T, collections.abc.Sequence[T]]

Parameters

Response

__len__(self) -> int

Response

__iter__(self) -> collections.abc.Iterator[T]

Response

_index(self, key : typing.Union[int, str, slice]) -> typing.Union[int, slice]

Parameters

Response

copy(self, **changes) -> None

Parameters

serialize(self) -> JsonSchema

Response

assign_to(self, parent : Group) -> None

Parameters

@deprecation.deprecated(deprecated_in='0.1.20', removed_in='0.2.0', current_version=__version__, details='Use `rotate_by` instead.')rotate(self, angle : int) -> None

Parameters

rotate_to(self, angle : int) -> None

Parameters

@classmethoddeserialize(cls, identifier : str, schema : JsonSchema) -> typing_extensions.Self

Parameters

Response

@classmethodsubclass_by_name(cls, name : str) -> typing.Optional[type[Resource]]

Parameters

Response

Exceptions

Attributes

Hole

Methods

__init__(self) -> None

__post_init__(self, *_kwargs) -> None

Parameters

__init_subclass__(cls) -> None

Parameters

assign_to(self, parent : Group) -> None

Parameters

@deprecation.deprecated(deprecated_in='0.1.20', removed_in='0.2.0', current_version=__version__, details='Use `rotate_by` instead.')rotate(self, angle : int) -> None

Parameters

init(
self,
height : Decimal,
sections : list[Shape],
max_volume : Decimal,
liquids : list[tuple[Liquid, decimal.Decimal]]
) -> None

@log()
add_liquid(self, liquid : Liquid, volume : Number) -> None

@log()
add_liquids(self, liquids : list[tuple[Liquid, decimal.Decimal]]) -> None

@log()
remove_liquid(self, volume : Number) -> list[tuple[Liquid, decimal.Decimal]]

init(
self,
children : collections.abc.Sequence[T],
container : Container
) -> None

@typing_extensions.override
rotate_by(self, angle : int) -> None

contains(self, item : typing.Any) -> bool

getitem(self, key : typing.Union[int, str, slice]) -> typing.Union[T, collections.abc.Sequence[T]]

len(self) -> int

iter(self) -> collections.abc.Iterator[T]

@deprecation.deprecated(deprecated_in='0.1.20', removed_in='0.2.0', current_version=version, details='Use `rotate_by` instead.')
rotate(self, angle : int) -> None

@classmethod
deserialize(cls, identifier : str, schema : JsonSchema) -> typing_extensions.Self

@classmethod
subclass_by_name(cls, name : str) -> typing.Optional[type[Resource]]

init(self) -> None

@deprecation.deprecated(deprecated_in='0.1.20', removed_in='0.2.0', current_version=version, details='Use `rotate_by` instead.')
rotate(self, angle : int) -> None

contains(self, item : typing.Any) -> bool

@classmethod
deserialize(cls, identifier : str, schema : JsonSchema) -> typing_extensions.Self

@classmethod
subclass_by_name(cls, name : str) -> typing.Optional[type[Resource]]

str(self) -> str

init(self, liquid : Mixture) -> None

str(self) -> str

init(self, liquid : typing.Union[Liquid, Sample], amount : Decimal) -> None

str(self) -> str

init(self, ingredients : typing.Optional[collections.abc.Iterable[Ingredient]]) -> None

len(self) -> int

contains(self, value : typing.Union[Liquid, Sample]) -> bool

getitem(self, index : typing.Union[typing.SupportsIndex, slice]) -> typing.Union[Ingredient, list[Ingredient]]

setitem(self, index : typing.Union[typing.SupportsIndex, slice], value : typing.Union[Ingredient, collections.abc.Iterable[Ingredient]]) -> None

delitem(self, index : typing.Union[typing.SupportsIndex, slice]) -> None

iter(self) -> collections.abc.Iterator[Ingredient]

reversed(self) -> collections.abc.Iterator[Ingredient]

add(self, other : typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]) -> Mixture

radd(self, other : typing.Union[Mixture, collections.abc.Iterable[Ingredient], Ingredient]) -> Mixture