science_jubilee.tools.PumpDispenser
#
Module Contents#
Classes#
Class to manage dispenser tool, for example for a color mixing demo |
- class science_jubilee.tools.PumpDispenser.PumpDispenser(index, name, pump_group, dispense_tip_offsets, line_volume, waste=None)#
Bases:
science_jubilee.tools.Tool.Tool
Class to manage dispenser tool, for example for a color mixing demo
- Parameters:
index – The tool index of the dispenser head on the machine
name (str) – The tool name
pump_group (science_jubilee.tools.PeristalticPump.PeristalticPumps) – science_jubilee.tools.PeristalticPump.PeristalticPumps object to assign to dispenser head
dispense_tip_offset (list) – Offsets from tool reference point for every dispense tip on the tool
line_volume (int, float) – Volume in mL of tubing line between pump and dispense head for 1 line
waste (class 'Well') – Location of waste basin
- classmethod from_config(index, pump_group, config_file: str, path: str = os.path.join(os.path.dirname(__file__), 'configs'))#
Initialize the pipette object from a config file
- Parameters:
index (int) – The tool index of the dispenser_head on the machine
config_file (str) – The name of the config file containign the dispenser tool parameters
- Returns:
A
PumpDispenser
object- Return type:
- add_waste(location: science_jubilee.labware.Labware.Well | Tuple | science_jubilee.labware.Labware.Location)#
Specify a waste collection container to dump extra liquid into. This should be large enough to catch liquid from all dispenser tips simultaneously.
- Parameters:
location (class 'Well') – location of container
- dispense(vol: float | int | list, location: science_jubilee.labware.Labware.Well | Tuple | science_jubilee.labware.Labware.Location, dispense_head_index=None)#
Dispense volume vol from dispense head dispense_head_index into location
- Parameters:
vol (float, int list) – Volume to dispense, in mL. Specify a single number (float, int) and a dispense head index (int) to dispense from a single specific dispense head, the single volume with no dispense head to dispense this amount from all dispense tips, or a list of volumes to dispense unique amount from each dispense tip
location (class 'Well') – Location to dispense
dispense_head_index (int) – index of dispense tip to dispense from, if passing single number for vol
- prime_lines(volume: int | float = None, location: science_jubilee.labware.Labware.Well | Tuple | science_jubilee.labware.Labware.Location = None)#
Fill all lines with liquid from all pumps simultaneously.
- Parameters:
volume – volume to prime with, if not specified in config file
location (class 'Well') – location of waste container, if not already specified
- empty_lines(volume: int | float = None)#
return line contents to stock wells.
- Parameters:
volume (int, float) – line volume to return, if not set in instance already