unitelabs.labware.hamilton.carriers.plate_carriers

Attributes

  • Name
    PLT_CAR_L5PCR384
    Type
    Value

    = PCR_CAR_L5_384_A00

    Description

Classes

  • PCR_CAR_L5_384_A00

    Carries 5x 384-well PCR plates in landscape orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P12*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182035'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182035'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=123))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P12*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=392.5, z=113.5)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=296.5, z=113.5)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=200.5, z=113.5)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=104.5, z=113.5)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=8.5, z=113.5))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_P3AC_A00

    Carries 3x 96-well Deep Well plates in portrait orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 3
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = PORTRAIT
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = ''
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 3
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182065'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182065'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 3

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = ''

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=116)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=146)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=70)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 3

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=43.85, y=329.5, z=86.15)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=43.85, y=183.5, z=86.15)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=43.85, y=37.5, z=86.15))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_P3AC_A01

    Carries 3x 96-well deep well plates in portrait orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 3
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = PORTRAIT
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '01'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P03*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 3
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182065'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182065'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 3

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '01'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P03*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=116)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=146)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=70)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 3

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=329.5, z=85.9)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=183.5, z=85.9)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=37.5, z=85.9))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5PCR_A00

    Carries 5x 96-well PCR plates in landscape orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = ''
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182070'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182070'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = ''

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=393.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=297.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=201.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=105.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=9.5, z=109.2))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5PCR_A01

    Carries 5x 96-well PCR plates in landscape orientation. Occupies 6 tracks.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '01'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P05*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182070'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '01'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P05*****'

      Description

    • Name
      model
      Type
      str
      Value

      = '182070'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=393.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=297.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=201.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=105.5, z=109.2)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=5, y=9.5, z=109.2))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_P3MD_A00

    Carries 3x 96/384-well MTPs in portrait orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 3
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = PORTRAIT
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = ''
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 3
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182075'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182075'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 3

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = ''

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=116)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=146)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=70)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 3

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=329.5, z=111.5)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=183.5, z=111.5)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=37.5, z=111.5))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_P3MD_A01

    Carries 3x 96/384-well MTPs in portrait orientation. Occupies 6 tracks.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 3
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = PORTRAIT
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '01'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P02*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 3
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182075'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '01'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P02*****'

      Description

    • Name
      model
      Type
      str
      Value

      = '182075'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 3

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=116)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=146)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=70)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 3

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=329.5, z=111.5)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=183.5, z=111.5)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=44.1, y=37.5, z=111.5))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5AC_A00

    Carries 5x 96/384-well deep well plates or 384 tip racks (e.g. 384HEAD_384TIPS_30μl) in landscape orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P04*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182090'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182090'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P04*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=392.5, z=86.15)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=296.5, z=86.15)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=200.5, z=86.15)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=104.5, z=86.15)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=8.5, z=86.15))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5AC_P_A00

    Carries 5x 96/384-well deep well plates or 384 tip racks (e.g. 384HEAD_384TIPS_30μl) in landscape orientation. Occupies 6 tracks. Has a pin in the back.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P11*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '185295'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '185295'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P11*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=126.8, y=85.8), location=Vector(x=4, y=392.5, z=86.15)), CarrierSite(dimensions=Vector(x=126.8, y=85.8), location=Vector(x=4, y=296.5, z=86.15)), CarrierSite(dimensions=Vector(x=126.8, y=85.8), location=Vector(x=4, y=200.5, z=86.15)), CarrierSite(dimensions=Vector(x=126.8, y=85.8), location=Vector(x=4, y=104.5, z=86.15)), CarrierSite(dimensions=Vector(x=126.8, y=85.8), location=Vector(x=4, y=8.5, z=86.15))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L4HD

    Carries 4x 1536-well plates in landscape orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 4
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = ''
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 4
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '191287'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '191287'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 4

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = ''

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=88.3)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=110)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=40)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 4

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4.1, y=366.1, z=118.25)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4.1, y=256.1, z=118.25)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4.1, y=146.1, z=118.25)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4.1, y=36.1, z=118.25))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_P3HD

    Carries 3x 1536-well plates in portrait orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 3
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = PORTRAIT
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = ''
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 3
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182190'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182190'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 3

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = ''

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=116)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=146)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=70)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 3

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=43.9, y=319.05, z=117.65)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=43.9, y=173.05, z=117.65)), CarrierSite(dimensions=Vector(x=86, y=127), location=Vector(x=43.9, y=27.05, z=117.65))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5MD_A00

    Carries 5x 96/384-well plates in landscape orientation. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 6
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'P01*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '182365'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '182365'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 6

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=135, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'P01*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=392.5, z=111.75)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=296.5, z=111.75)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=200.5, z=111.75)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=104.5, z=111.75)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=4, y=8.5, z=111.75))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5FLEX_AC_A00

    Carries 5x archive plates in height adjustable landscape positions. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 7
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'X01*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = ''
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = ''

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 7

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=157.5, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'X01*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=392.5, z=89.1)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=296.5, z=89.1)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=200.5, z=89.1)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=104.5, z=89.1)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=8.5, z=89.1))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L5FLEX_MD_A00

    Carries 5x MTPs in height adjustable landscape positions. Occupies 6 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 5
        Description

      • Name
        tracks
        Type
        int
        Default
        = 7
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = 'X01*****'
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'horizontal'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 5
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = True
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = True
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = True
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = ''
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = ''

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 5

      Description

    • Name
      tracks
      Type
      int
      Value

      = 7

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=157.5, y=497, z=130))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'X01*****'

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'horizontal'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=61.6)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=96)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=30)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 5

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = True

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = True

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = True

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=392.5, z=115.8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=296.5, z=115.8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=200.5, z=115.8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=104.5, z=115.8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=15.25, y=8.5, z=115.8))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

  • PLT_CAR_L4HHC_A00

    Carries 4x Hamilton Heater Coolers or Shakers in landscape positions. Occupies 7 tracks.

    MRO
    Bases
    HamiltonCarrier[typing.Union[Plate, Lid, Trough]]
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        filled_with : dataclasses.InitVar[typing.Union[None, T, type[T]]],
        filled_at : dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]],
        cols : int,
        rows : int,
        tracks : int,
        variant : str,
        revision : str,
        barcode : str,
        barcode_orientation : typing.Literal['vertical', 'horizontal'],
        barcode_count : int,
        read_barcode : bool,
        is_auto_loadable : bool,
        is_loadable : bool,
        is_recognizable : bool,
        are_recognizable : bool,
        model : str,
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        tags
        Type
        dict
        Default
        Description

      • Name
        children
        Type
        collections.abc.Sequence[CarrierSite]
        Default
        Description

      • Name
        filled_with
        Type
        dataclasses.InitVar[typing.Union[None, T, type[T]]]
        Default
        = None
        Description

      • Name
        filled_at
        Type
        dataclasses.InitVar[typing.Optional[collections.abc.Sequence[typing.SupportsIndex]]]
        Default
        = None
        Description

      • Name
        cols
        Type
        int
        Default
        = 1
        Description

      • Name
        rows
        Type
        int
        Default
        = 4
        Description

      • Name
        tracks
        Type
        int
        Default
        = 7
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = PLATES
        Description

      • Name
        orientation
        Type
        dataclasses.InitVar[Orientation]
        Default
        = LANDSCAPE
        Description

      • Name
        variant
        Type
        str
        Default
        = 'A'
        Description

      • Name
        revision
        Type
        str
        Default
        = '00'
        Description

      • Name
        barcode
        Type
        str
        Default
        = ''
        Description

      • Name
        barcode_orientation
        Type
        typing.Literal['vertical', 'horizontal']
        Default
        = 'vertical'
        Description

      • Name
        barcode_position
        Type
        Decimal
        Default
        Description

      • Name
        barcode_distance
        Type
        Decimal
        Default
        Description

      • Name
        barcode_width
        Type
        Decimal
        Default
        Description

      • Name
        barcode_count
        Type
        int
        Default
        = 0
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = False
        Description

      • Name
        is_auto_loadable
        Type
        bool
        Default
        = False
        Description

      • Name
        is_loadable
        Type
        bool
        Default
        = False
        Description

      • Name
        is_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        are_recognizable
        Type
        bool
        Default
        = False
        Description

      • Name
        model
        Type
        str
        Default
        = '187001'
        Description

      • Name
        dimensions
        Type
        Vector
        Default
        Description

    • __post_init__(
        self,
        filled_with,
        filled_at,
        *kwargs
      ) -> None

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        filled_with
        Type
        Default
        Description

      • Name
        filled_at
        Type
        Default
        Description

      • Name
        orientation
        Type
        Orientation
        Default
        Description

      • Name
        *kwargs
        Type
        Default
        = ()
        Description

    • @typing_extensions.override

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        Default
        Description

      • Name
        value
        Type
        typing.Union[typing.Optional[T], collections.abc.Sequence[typing.Optional[T]]]
        Default
        Description

    • get(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Access the labware in the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from which to access the labware.

      Response

      Type
      typing.Optional[T]
      Description

    • @log()

      add(self, labware : T, key : typing.Union[int, str]) -> None

      Add labware to the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        T
        Default
        Description

        The labware to add to the spot.

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot where to add the labware.

    • @log()

      fill(self, labware : typing.Union[T, type[T], collections.abc.Sequence[T]], spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> None

      Fill the spots of the rack with the given labware.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        labware
        Type
        typing.Union[T, type[T], collections.abc.Sequence[T]]
        Default
        Description

        The labware to assign to the spots. Pass either a class or instance of labware that is copied or a list with the labware instance for each spot.

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots in which to assign the labware.

    • @log()

      remove(self, key : typing.Union[int, str]) -> typing.Optional[T]

      Remove labware from the spot at the given key.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str]
        Default
        Description

        The key of the spot from where to remove the labware.

      Response

      Type
      typing.Optional[T]
      Description

      The labware that was removed, if any.

    • @log()

      clear(self, spots : typing.Optional[collections.abc.Sequence[Spot[T]]]) -> collections.abc.Sequence[typing.Optional[T]]

      Clear the spots of the rack.

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        spots
        Type
        typing.Optional[collections.abc.Sequence[Spot[T]]]
        Default
        = None
        Description

        The spots from which to unassign the labware.

      Response

      Type
      collections.abc.Sequence[typing.Optional[T]]
      Description

      The list of labware that was removed, if any.

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

      Parameters

      • Name
        self
        Type
        Default
        Description

      • Name
        key
        Type
        typing.Union[int, str, slice]
        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
      model
      Type
      str
      Value

      = '187001'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 4

      Description

    • Name
      tracks
      Type
      int
      Value

      = 7

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=157.5, y=497, z=87.72))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.PLATES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = ''

      Description

    • Name
      barcode_orientation
      Type
      typing.Literal['vertical', 'horizontal']
      Value

      = 'vertical'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=0)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=0)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=0)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 0

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = False

      Description

    • Name
      is_auto_loadable
      Type
      bool
      Value

      = False

      Description

    • Name
      is_loadable
      Type
      bool
      Value

      = False

      Description

    • Name
      is_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      are_recognizable
      Type
      bool
      Value

      = False

      Description

    • Name
      children
      Type
      collections.abc.Sequence[CarrierSite]
      Value

      = dataclasses.field(repr=False, default_factory=lambda: [CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=16.89, y=373.1, z=8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=16.89, y=253.1, z=8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=16.89, y=133.1, z=8)), CarrierSite(dimensions=Vector(x=127, y=86), location=Vector(x=16.89, y=13.1, z=8))])

      Description

    • Name
      logger
      Type
      logging.Logger
      Value

      = None

      Description

    • Name
      tags
      Type
      dict
      Value

      = dataclasses.field(default_factory=dict)

      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
      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.

Copyright © 2024