Location

Description

Represents a targetable physical location within the Jubilee system. Each Location combines a Point (spatial coordinates) with an associated Well or Labware object for precise motion planning and operations.

Constructor

Location(point: Point, labware: Union[Well, Labware])

Initializes a Location object with coordinates and a related labware or well.

Parameter	Type	Description
point	Point	The 3D coordinates representing the location.
labware	Well or Labware	The object (either a specific well or an entire labware) associated with the coordinates.

Properties

Property	Type	Description
point	Point	Returns the (x, y, z) coordinate of the location.
labware	Well or Labware	Returns the associated labware or well object.

Methods

Method	Returns	Description
__iter__()	Iterable[Point, Well or Labware]	Allows unpacking into (point, labware) tuple.
__eq__(other)	bool	Checks equality of two Location objects (both point and labware must match).
__repr__()	str	Returns a human-readable string representation of the Location.

Short Example

# Example usage of Location
p = Point(x=100.0, y=50.0, z=20.0)
labware = Labware("falcon_96_wellplate_360ul_flat")
loc = Location(point=p, labware=labware)

# Access point and labware
print(loc.point)
print(loc.labware)

# Unpack location
pt, lw = loc
print(pt, lw)

# Compare two locations
loc2 = Location(point=p, labware=labware)
print(loc == loc2)  # True

Important Notes

• Location objects bundle a 3D coordinate and a related physical object (well or labware) together for motion planning.
• Supports iterable unpacking into (Point, Labware/Well) tuple, allowing easy usage in motion APIs.
• Location equality (==) requires both the point coordinates and the labware object to match exactly.
• String representation is human-readable and displays both the point and the associated labware or well.