science_jubilee.tools.Syringe#

Module Contents#

Classes#

Syringe

A class representation of a syringe.

class science_jubilee.tools.Syringe.Syringe(index, name, config)#

Bases: science_jubilee.tools.Tool.Tool

A class representation of a syringe.

Parameters:

Tool (Tool) – The base tool class

load_config(config)#

Loads the confirguration file for the syringe tool

Parameters:

config (str) – Name of the config file for your syringe. Expects the file to be in /tools/configs

post_load()#

Query the object model after loading the tool to find the extruder number of this syringe.

check_bounds(pos)#

Disallow commands outside of the syringe’s configured range

Parameters:

pos (float) – The E position to check

_aspirate(vol: float, s: int = 2000)#

Aspirate a certain volume in milliliters. Used only to move the syringe; to aspirate from a particular well, see aspirate()

Parameters:
  • vol (float) – Volume to aspirate, in milliliters

  • s (int, optional) – Speed at which to aspirate in mm/min, defaults to 2000

_dispense(vol, s: int = 2000)#

Dispense a certain volume in milliliters. Used only to move the syringe; to dispense into a particular well, see dispense()

Parameters:
  • vol (float) – Volume to dispense, in milliliters

  • s (int, optional) – Speed at which to dispense in mm/min, defaults to 2000

aspirate(vol: float, location: science_jubilee.labware.Labware.Well | Tuple | science_jubilee.labware.Labware.Location, s: int = 2000)#

Aspirate a certain volume from a given well.

Parameters:
  • vol (float) – Volume to aspirate, in milliliters

  • location (Union[Well, Tuple, Location]) – The location (e.g. a Well object) from where to aspirate the liquid from.

  • s (int, optional) – Speed at which to aspirate in mm/min, defaults to 2000

dispense(vol: float, location: science_jubilee.labware.Labware.Well | Tuple | science_jubilee.labware.Labware.Location, s: int = 2000)#

Dispense a certain volume into a given well.

Parameters:
  • vol (float) – Volume to dispense, in milliliters

  • location (Union[Well, Tuple, Location]) – The location to dispense the liquid into.

  • s (int, optional) – Speed at which to dispense in mm/min, defaults to 2000

transfer(vol: float, s: int = 2000, source: science_jubilee.labware.Labware.Well = None, destination: science_jubilee.labware.Labware.Well = None, mix_before: tuple = None, mix_after: tuple = None)#

Transfer liquid from source well(s) to a set of destination well(s). Accommodates one-to-one, one-to-many, many-to-one, and uneven transfers.

Parameters:
  • vol (float) – Volume to transfer in milliliters

  • s (int, optional) – Speed at which to aspirate and dispense in mm/min, defaults to 2000

  • source (Well, optional) – A source well or set of source wells, defaults to None

  • destination (Well, optional) – A destination well or set of destination wells, defaults to None

  • mix_before (tuple, optional) – Mix the source well before transfering, defaults to None

  • mix_after (tuple, optional) – Mix the destination well after transfering, defaults to None