science_jubilee.tools.Loop#

Classes#

`Well`	A class representing a well of a labware.
`Tool`
`Loop`	A class representation of an inoculation loop.

Functions#

requires_active_tool(func)

Decorator to ensure that a tool cannot complete an action unless it is the

Module Contents#

class science_jubilee.tools.Loop.Well[source]#

A class representing a well of a labware.

Each Well is associated with a specific name, depth, total liquid volume, shape, diameter, x, y, and z dimension, y-dimension, as well as its coordinates and any applied offset

Returns:: A Well object with various information about the geometry of the well and its position in the labware
Return type:: Well

name: str#

depth: float#

totalLiquidVolume: float#

shape: str#

diameter: float = None#

xDimension: float = None#

yDimension: float = None#

x: float#

y: float#

z: float#

offset: Tuple[float] = None#

slot: int = None#

has_tip: bool = False#

clean_tip: bool = False#

labware_name: str = None#

property x#

Offsets the x-position of the each well with respect to the deck-slot coordinates

Returns:: The x-coordinate of the well
Return type:: float

property y#

Offsets the y-position of the each well with respect to the deck-slot coordinates

Returns:: The y-coordinate of the well
Return type:: float

property z#

Offsets the z-position of each well with respect to the deck-slot coordinates

Returns:: The z-coordinate of the well
Return type:: float

apply_offset(offset: Tuple[float])[source]#

Allows the user to offset the coordinates of the well with respect to the deck-slot coordinates

Parameters:: offset (Tuple[float]) – A tuple of floats with the new offset of the well

property top_#

Defines the top-most point of the well

Returns:: The z-coordinate of the top of the well
Return type:: float

property bottom_#

Defines the bottom-most point of the well

Returns:: The z-coordinate of the bottom of the well
Return type:: float

bottom(z: float, check=False)[source]#

Allows the user to dinamically indicate a new Z location relative to the bottom of the well.

Parameters:

z (float) – the distance in mm to offset the coordinates from the bottom of the well. Should be +
check (bool, optional) – the ‘z’ parameters can either be + or -. If negative, an assert error is raised to avoid collision with the labware. However, there might be instances of custom labware where the bottom of the well is purposely set as higher during the generation of its config .json file., defaults to False

Returns:

A Location which contains information about the new coordinates generated and the Well object

Return type:

Location

top(z: float)[source]#

Allows the user to dinamically indicate a new Z location relative to the top of the well.

Parameters:: z (float) – the distance in mm to offset the coordinates from the top of the well.Can be either + or -
Returns:: A Location which contains information about the new coordinates generated and the Well object.
Return type:: Location

__repr__()[source]#

Displayed representation of a Well object indicating its name and its coordinates

Returns:: A string representation of the name and coordinates of a well
Return type:: str

set_has_tip(value: bool)[source]#

Set the value of the has_tip attribute.

Parameters:: value (bool) – The new value for the has_tip attribute

set_clean_tip(value: bool)[source]#

Returns the value of the clean_tip attribute.

Parameters:: value (bool) – The new value for the clean_tip attribute

class science_jubilee.tools.Loop.Tool(index, name, **kwargs)[source]#

post_load()[source]#: Run any code after tool has been associated with the machine.

science_jubilee.tools.Loop.requires_active_tool(func)[source]#: Decorator to ensure that a tool cannot complete an action unless it is the current active tool.

class science_jubilee.tools.Loop.Loop(index, name)[source]#

Bases: science_jubilee.tools.Tool.Tool

A class representation of an inoculation loop.

Parameters:: Tool (Tool) – The base tool class

transfer(source: science_jubilee.labware.Labware.Well = None, destination: science_jubilee.labware.Labware.Well = None, s: int = 2000, sweep_x: float = 5, sweep_y: float = 5, sweep_z: float = 10, sweep_speed: float = 100, up_speed: float = 800, randomize_pickup: bool = False)[source]#

Dip into a number of (source, destination) well pairs. Used for transferring items from source to destination.

Parameters:

source (Well, optional) – Source well, defaults to None
destination (Well, optional) – Destination well, defaults to None
s (int, optional) – Movement speed in mm/min, defaults to 2000
sweep_x (float, optional) – Distance (in mm) to sweep in the x direction to pick up material, defaults to 5
sweep_y (float, optional) – Distance (in mm) to sweep in the y direction to pick up material, defaults to 5
sweep_z (float, optional) – Distance (in mm) to move in the z direction to pick up material, defaults to 10
sweep_speed (float, optional) – Speed (in mm/min) at which to sweep to pick up material, defaults to 100
up_speed (float, optional) – Speed to move out of well (in mm/min), defaults to 800
randomize_pickup (bool, optional) – Move to a random position in the source well to pick up material, defaults to False

static _get_xyz(well: science_jubilee.labware.Labware.Well = None, location: Tuple[float] = None)[source]#

Get the (x,y,z) position of a well.

Parameters:

well (Well, optional) – The well to fetch position of, defaults to None
location (Tuple[float], optional) – Directly specify an (x,y,z) location, defaults to None

Raises:

ValueError – Must specify either a well or a location

Returns:

The well location

Return type:

Tuple[float, float, float]

static _get_top_bottom(well: science_jubilee.labware.Labware.Well = None)[source]#

Get the top and bottom heights of a well.

Parameters:: well (Well, optional) – The well to fetch position of, defaults to None
Returns:: The z-height of the top and bottom of the well
Return type:: Tuple[float, float]