unitelabs.labware.hamilton.carriers.sample_carriers

Classes

  • SMP_CAR_12_A00

    Sample carrier for 12x tubes of 29x115 mm (50ml Falcon tubes). Occupies 2 tracks.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        children : collections.abc.Sequence[TubeSpot],
        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[TubeSpot]
        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
        = 12
        Description

      • Name
        tracks
        Type
        int
        Default
        = 2
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = SAMPLES
        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
        = 12
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = False
        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
        = True
        Description

      • Name
        model
        Type
        str
        Default
        = '182245'
        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

      = '182245'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 12

      Description

    • Name
      tracks
      Type
      int
      Value

      = 2

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=45, y=497, z=140))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.SAMPLES

      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=53.7)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=36.5)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=14)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 12

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = False

      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

      = True

      Description

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

      = dataclasses.field(repr=False, default_factory=lambda: [TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=428.75, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=392.25, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=355.75, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=319.25, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=282.75, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=246.25, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=209.75, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=173.25, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=136.75, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=100.25, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=63.75, z=14)), TubeSpot(dimensions=Vector(x=29, y=29), location=Vector(x=11.55, y=27.25, z=14))])

      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.

  • SMP_CAR_24_A00

    Sample carrier for 24x tubes of 14.5x60 - 18x120mm (e.g. 15x75, 15x95, 15x100, 17x75, 17x95 or 17x100 mm). Occupies 1 track.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        children : collections.abc.Sequence[TubeSpot],
        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[TubeSpot]
        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
        = 24
        Description

      • Name
        tracks
        Type
        int
        Default
        = 1
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = SAMPLES
        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
        = 'S01*****'
        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
        = 24
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = False
        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
        = True
        Description

      • Name
        model
        Type
        str
        Default
        = '173400'
        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

      = '173400'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 24

      Description

    • Name
      tracks
      Type
      int
      Value

      = 1

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=22.5, y=497, z=140))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.SAMPLES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'S01*****'

      Description

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

      = 'vertical'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=20)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=20)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=14)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 24

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = False

      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

      = True

      Description

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

      = dataclasses.field(repr=False, default_factory=lambda: [TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=470.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=450.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=430.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=410.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=390.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=370.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=350.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=330.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=310.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=290.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=270.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=250.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=230.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=210.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=190.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=170.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=150.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=130.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=110.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=90.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=70.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=50.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=30.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=10.35, z=10))])

      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.

  • SMP_CAR_24C12_A00

    Sample carrier for 20x tubes of 14.5x60 - 18x120mm (e.g. 15x75, 15x95, 15x100, 17x75, 17x95, 17x100). Ideal for 12 channel instruments. Occupies 1 track.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        children : collections.abc.Sequence[TubeSpot],
        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[TubeSpot]
        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
        = 20
        Description

      • Name
        tracks
        Type
        int
        Default
        = 1
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = SAMPLES
        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
        = 'S04*****'
        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
        = 20
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = False
        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
        = True
        Description

      • Name
        model
        Type
        str
        Default
        = '173400'
        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

      = '173400'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 20

      Description

    • Name
      tracks
      Type
      int
      Value

      = 1

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=22.5, y=497, z=140))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.SAMPLES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'S04*****'

      Description

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

      = 'vertical'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=60)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=20)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=9)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 20

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = False

      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

      = True

      Description

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

      = dataclasses.field(repr=False, default_factory=lambda: [TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=430.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=410.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=390.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=370.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=350.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=330.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=310.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=290.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=270.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=250.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=230.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=210.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=190.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=170.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=150.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=130.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=110.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=90.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=70.35, z=10)), TubeSpot(dimensions=Vector(x=13.3, y=13.3), location=Vector(x=6.85, y=50.35, z=10))])

      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.

  • SMP_CAR_32_A00

    Sample carrier for 32x tubes of 11x60 - 14x120mm (e.g. 12x75, 12x95, 12x100, 13x75, 13x95, 13x100). Occupies 1 track.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        children : collections.abc.Sequence[TubeSpot],
        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[TubeSpot]
        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
        = 32
        Description

      • Name
        tracks
        Type
        int
        Default
        = 1
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = SAMPLES
        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
        = 'S02*****'
        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
        = 32
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = False
        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
        = True
        Description

      • Name
        model
        Type
        str
        Default
        = '173410'
        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

      = '173410'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 32

      Description

    • Name
      tracks
      Type
      int
      Value

      = 1

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=22.5, y=497, z=140))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.SAMPLES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'S02*****'

      Description

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

      = 'vertical'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=17.5)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=15)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=9)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 32

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = False

      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

      = True

      Description

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

      = dataclasses.field(repr=False, default_factory=lambda: [TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=474.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=459.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=444.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=429.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=414.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=399.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=384.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=369.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=354.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=339.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=324.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=309.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=294.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=279.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=264.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=249.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=234.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=219.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=204.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=189.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=174.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=159.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=144.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=129.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=114.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=99.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=84.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=69.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=54.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=39.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=24.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=9.1, z=10))])

      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.

  • SMP_CAR_32C12_A00

    Sample carrier for 32x tubes of 11x60 - 14x120mm (e.g. 12x75, 12x95, 12x100, 13x75, 13x95, 13x100). Ideal for 12 channel instruments. Occupies 1 track.

    MRO
    Decorators
    dataclasses.dataclass

    Methods

    • __init__(
        self,
        tags : dict,
        children : collections.abc.Sequence[TubeSpot],
        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[TubeSpot]
        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
        = 24
        Description

      • Name
        tracks
        Type
        int
        Default
        = 1
        Description

      • Name
        labware
        Type
        LabwareType
        Default
        = SAMPLES
        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
        = 'S05*****'
        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
        = 24
        Description

      • Name
        read_barcode
        Type
        bool
        Default
        = False
        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
        = True
        Description

      • Name
        model
        Type
        str
        Default
        = '173410'
        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

      = '173410'

      Description

    • Name
      cols
      Type
      int
      Value

      = 1

      Description

    • Name
      rows
      Type
      int
      Value

      = 24

      Description

    • Name
      tracks
      Type
      int
      Value

      = 1

      Description

    • Name
      dimensions
      Type
      Vector
      Value

      = dataclasses.field(default_factory=lambda: Vector(x=22.5, y=497, z=140))

      Description

    • Name
      labware
      Type
      LabwareType
      Value

      = LabwareType.SAMPLES

      Description

    • Name
      variant
      Type
      str
      Value

      = 'A'

      Description

    • Name
      revision
      Type
      str
      Value

      = '00'

      Description

    • Name
      barcode
      Type
      str
      Value

      = 'S05*****'

      Description

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

      = 'vertical'

      Description

    • Name
      barcode_position
      Type
      Decimal
      Value

      = Decimal(default=77.5)

      Description

    • Name
      barcode_distance
      Type
      Decimal
      Value

      = Decimal(default=15)

      Description

    • Name
      barcode_width
      Type
      Decimal
      Value

      = Decimal(default=9)

      Description

    • Name
      barcode_count
      Type
      int
      Value

      = 24

      Description

    • Name
      read_barcode
      Type
      bool
      Value

      = False

      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

      = True

      Description

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

      = dataclasses.field(repr=False, default_factory=lambda: [TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=414.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=399.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=384.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=369.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=354.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=339.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=324.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=309.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=294.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=279.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=264.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=249.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=234.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=219.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=204.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=189.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=174.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=159.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=144.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=129.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=114.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=99.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=84.1, z=10)), TubeSpot(dimensions=Vector(x=10.8, y=10.8), location=Vector(x=9.1, y=69.1, z=10))])

      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