API reference

Classes for representing a Gemini WorkList (gwl).

The gwl file specification is based on the Freedom EVOware Software Manual, 393172, v3.5 (2015), for the Tecan Freedom EVOware v2.7 software (note different versioning for manual and software). Specifications are the same for the newer v3.16 of the manual (393172) and corresponding v2.8 of the software.

A gwl file is made up of records. A record consists of a single character indicating the operation type, and one or more ‘parameters’.

DiTi is short for ‘Disposable Tip’.

class dioscuri.Break

Bases: object

The Break record.

to_string()

Return string representation of the record.

class dioscuri.Comment(comment)

Bases: object

The Comment record (ignored by Freedom EVOware).

Parameters:

comment (str) – The comment. Newlines (\n) will be escaped with \.

to_string()

Return string representation of the record.

class dioscuri.Decontamination

Bases: object

The Decontamination Wash record.

to_string()

Return string representation of the record.

class dioscuri.Flush

Bases: object

The Flush record.

to_string()

Return string representation of the record.

class dioscuri.GeminiWorkList(name='worklist', records=None)

Bases: object

Gemini WorkList (gwl) class.

A WorkList is a list of pipetting commands, or ‘records’.

Parameters:

  • name (str) – Name of the worklist.

  • records (list) – List of records (e.g. Pipette class instances).

add_record(record)

Add record.

Parameters:

record (Pipette or WashTipOrReplaceDITI or Decontamination or Flush or Break or SetDITIType or Comment or ReagentDistribution or StartTimer or WaitForTimer) – A record class instance.

check_status()

Update pipetting status attribute.

list_records()

List records in a worklist.

records_to_file(filename)

Print records into a gwl file.

Parameters:

filename (str) – Path to the target gwl file.

records_to_string()

Return string representation of the records.

class dioscuri.Pipette(operation, rack_label, rack_type, position, volume, tube_id='', rack_id='', liquid_class='', tip_mask='', forced_rack_type='')

Bases: object

General class for Aspirate and Dispense records.

Note that parameter MinDetectedVolume is not implemented.

Parameters:

  • operation (str) – The type of the transfer: A for aspirate, or D for dispense. The first letter of the specified string is used.

  • rack_label (str) – Label which is assigned to the labware. Maximum 32 characters.

  • rack_id (str) – Labware barcode. Maximum 32 characters.

  • rack_type (str) – Labware type: configuration name, for example “384 Well, landscape”. Maximum 32 characters.

  • position (int) – Well position in the labware. The position starts with 1 and increases from rear to front and left to right. Range: 1 .. number of wells.

  • tube_id (str) – Tube barcode. Maximum 32 characters.

  • volume (int) – Pipetting volume in µl (microliter). Range: 0 .. 7158278.

  • liquid_class (str, optional) – Overwrites the liquid class specified in the Tecan EVOware Worklist command that calls the gwl file. Maximum 32 characters.

  • tip_mask (str, optional) – Specifies the tip you want to use. See details in the program that uses the gwl output file. Range: 1 .. 128.

  • forced_rack_type (str, optional) – The configuration name of the labware. Maximum 32 characters.

to_string()

Return string representation of the record.

class dioscuri.ReagentDistribution(SrcRackLabel, SrcRackID, SrcRackType, SrcPosStart, SrcPosEnd, DestRackLabel, DestRackID, DestRackType, DestPosStart, DestPosEnd, Volume, LiquidClass='', NoOfDitiReuses=1, NoOfMultiDisp=1, Direction=0, ExcludeDestWell='')

Bases: object

The Reagent Distribution record.

Parameters:

  • SrcRackLabel (str) – Label of source labware. Maximum 32 characters.

  • SrcRackID (str) – Source labware barcode. Maximum 32 characters.

  • SrcRackType (str) – Source labware type: configuration name. Maximum 32 characters.

  • SrcPosStart (int) – First well to be used in the source labware. Range: 1 .. number of wells.

  • SrcPosEnd (int) – Last well to be used in the source labware. Range: 1 .. number of wells.

  • DestRackLabel (str) – Label of destination labware. Maximum 32 characters.

  • DestRackID (str) – Destination labware barcode. Maximum 32 characters.

  • DestRackType (str) – Destination labware type: configuration name. Maximum 32 characters.

  • DestPosStart (int) – First well to be used in the destination labware. Range: 1 .. number of wells.

  • DestPosEnd (int) – Last well to be used in the destination labware. Range: 1 .. number of wells.

  • Volume (int) – Dispense volume in the destination labware in µl (microliter). Range: 0..7158278.

  • LiquidClass (str, optional) – Overwrites the liquid class specified in the Tecan EVOware Worklist command. Maximum 32 characters.

  • NoOfDitiReuses (int, optional) – Maximum number of DiTi reuses allowed (default 1 = no DiTi reuse).

  • NoOfMultiDisp (int, optional) – Maximum number of dispenses in a multidispense sequence (default 1 = no multi-dispense).

  • Direction (int, optional) – Pipetting direction (0 = left to right, 1 = right to left; default = 0).

  • ExcludeDestWell (str, optional) – List of wells in destination labware to be excluded from pipetting.

to_string()

Return string representation of the record.

class dioscuri.SetDITIType(diti_index)

Bases: object

The Set DiTi Type record.

The Set DiTi Type record can only be used at the very beginning of the worklist or directly after a Break record.

Parameters:

DiTi_Index (str) – The index of DiTi Type. Used to switch DiTi types from within a worklist.

to_string()

Return string representation of the record.

class dioscuri.StartTimer(timernumber)

Bases: object

The Start Timer record (for Fluent).

Parameters:

timernumber (int) – The timer number.

to_string()

Return string representation of the record.

class dioscuri.WaitForTimer(timernumber, time)

Bases: object

The Wait for Timer record (for Fluent).

Parameters:

  • timernumber (int) – The timer number.

  • time (int) – Wait time in seconds.

to_string()

Return string representation of the record.

class dioscuri.WashTipOrReplaceDITI(scheme=None)

Bases: object

Class for WashTip or ReplaceDITI records.

Parameters:

scheme (int, optional) – Number of wash scheme to use. Default None, which uses the first wash scheme.

to_string()

Return string representation of the record.

dioscuri.read_gwl(filepath)

Read gwl file into a GeminiWorkList object.

Parameters:

filepath (str) – Path to the gwl file.