science_jubilee.decks package#

Submodules#

science_jubilee.decks.Deck module#

class science_jubilee.decks.Deck.Deck(deck_filename, path: str = '/home/docs/checkouts/readthedocs.org/user_builds/science-jubilee/checkouts/latest/docs/../src/science_jubilee/decks/deck_definition')[source]#

Bases: SlotSet

Class that defines the Jubilee deck.

The deck is a set of slots that can have labware loaded into them. The deck is defined by a configuration file that specifies the number of slots, their offsets, and the type of bed they are arranged in.

Parameters:

  • deck_filename (str) – The name of the deck configuration file.

  • path (str, optional) – The path to the deck configuration .json files for the labware, defaults to the ‘deck_definition/’ in the science_jubilee/decks directory.

property bedType[source]#

Function that returns the type of bed loaded onto Jubilee.

Returns:

The name/type of deck loaded onto Jubilee, e.g., Lab Automation Deck, Heated Deck, etc.

Return type:

str

property deck_material[source]#

Function that returns the material that the deck and possible mask are made of.

Returns:

The material that the deck is made of, as well as any mask that is applied to it.

Return type:

Dict[str, str]

load_labware(labware_filename: str, slot: int, path='/home/docs/checkouts/readthedocs.org/user_builds/science-jubilee/checkouts/latest/docs/../src/science_jubilee/decks/../labware/labware_definition', order: str = 'rows')[source]#
Function that loads a labware and associates it with a specific slot on the deck.

The slot offset is also applied to the labware asocaite with it.

Parameters:

  • labware_filename (str) – The name of the labware configuration file.

  • slot (int) – The index of the slot to load the labware into.

  • path (str, optional) – The path to the labware configuration .json files for the labware, defaults to the ‘labware_definition/’ in the science_jubilee/labware directory.

  • order (str, optional) – The order in which the labware is arranged on the deck. Can be ‘rows’ or ‘columns’, defaults to ‘rows’.

Returns:

The Labware object that has been loaded into the slot.

Return type:

Labware

property offsetFrom[source]#

Function that returns which corner or the slot to apply to a labware loaded on it.

Returns:

The corner of the slot to apply to the labware. This is inidcated in the configuration file.

Return type:

str

property safe_z[source]#

Function that returns the movement clearance height of the deck.

Returns:

The height at which the pipette can freely move without colliding with labware on the deck.

Return type:

float

property slotType[source]#

Function that returns the type of slot arrangement the deck might have.

Returns:

The slot arrangement type. This is inidcated in the configuration file. Standard is “SLAS”.

Return type:

str

property totalslots[source]#

Function that returns the total number of slots on the deck.

Returns:

The total number of slots on the deck.

Return type:

int

class science_jubilee.decks.Deck.Slot(slot_index: int, offset: Tuple[float], has_labware: bool, labware: str)[source]#

Bases: object

Class that defines a slot on the Jubilee deck. Each slot has a unique index, offset, and can have a labware associated with it.

Parameters:

  • slot_index (int) – The unique index of the slot, usually a number between 0 and 5.

  • offset (Tuple[float]) – The (x,y) offset of the slot from the origin of the deck/machine.

  • has_labware (bool) – A boolean that indicates whether a labware has been loaded into the slot.

  • labware (Labware) – The Labware object that has been loaded into the slot.

has_labware: bool[source]#
labware: str[source]#
offset: Tuple[float][source]#
slot_index: int[source]#
class science_jubilee.decks.Deck.SlotSet(slots: Dict[str, Slot])[source]#

Bases: object

Class that defines a set of slots on the Jubilee deck.

Parameters:

  • slots (Dict[str, Slot]) – A dictionary of Slot objects, where the key is the slot’s index.

  • bedType (str) – The type of bed that the slots are arranged in. Usually ‘fixed’ or ‘removable’.

slots: Dict[str, Slot][source]#

science_jubilee.decks.Plate module#

class science_jubilee.decks.Plate.Plate(machine, name)[source]#

Bases: object

get_root_dir()[source]#
exception science_jubilee.decks.Plate.PlateConfigurationError[source]#

Bases: Exception

Raise this error if there is something wrong with how the plate is configured

exception science_jubilee.decks.Plate.PlateStateError[source]#

Bases: Exception

Raise this error if the plate is in the wrong state to perform such a command.

Module contents#