synbiopython.lab_automation.picklist

Classes to represent picklists and liquid transfers in general.

class synbiopython.lab_automation.picklist.PickList.PickList(transfers_list=(), data=None)

Bases: object

Representation of a list of well-to-well transfers.

Parameters

• transfers_list – A list of Transfer objects that will be part of the same dispensing operation, in the order in which they are meant to be simulated.

• data – A dict with information on the picklist.

add_transfer(source_well=None, destination_well=None, volume=None, data=None, transfer=None)

Add a transfer to the picklist’s tranfers list.

You can either provide a Transfer object with the transfer parameter, or the parameters.

enforce_maximum_dispense_volume(max_dispense_volume)

Return a new picklist were every too-large dispense is broken down into smaller dispenses.

static merge_picklists(picklists_list)

Merge the list of picklists into a single picklist.

The transfers in the final picklist are the concatenation of the transfers in the different picklists, in the order in which they appear in the list.

restricted_to(transfer_filter=None, source_well=None, destination_well=None)

Return a version of the picklist restricted to transfers with the right source/destination well.

You can provide source_well and destination_well or alternatively just a function transfer_filter with signature (transfer)=>True/False that will be used to filter out transfers (for which it returns false).

simulate(content_field='content', inplace=True)

Simulate the execution of the picklist.

sorted_by(sorting_method='source_well')

Return a new version of the picklist sorted by some parameter.

The sorting_method is either the name of an attribute of the transfers, such as “source_well”, or a function f(transfer) -> value.

to_plain_string()

Return the list of transfers in human-readable format.

to_plain_textfile(filename)

Write the picklist in a file in a human reable format.

total_transferred_volume()

Return the sum of all volumes from all transfers.

class synbiopython.lab_automation.picklist.Transfer.Transfer(source_well, destination_well, volume, data=None)

Bases: object

Class representing a transfer from a source well to a destination well.

Parameters

• source_well – A Well object from which to transfer.

• destination_well – A Well object to which to transfer.

• volume – Volume to be transferred, expressed in liters.

• data – A dict containing any useful information about the transfer. This information can be used later e.g. as parameters for the transfer when exporting a picklist.

apply()

to_plain_string()

Return “Transfer {volume}L from {source_well} into {dest_well}”.

to_short_string()

Return “Transfer {volume}L {source_well} -> {dest_well}”.

with_new_volume(new_volume)

Return a version of the transfer with a new volume.

exception synbiopython.lab_automation.picklist.Transfer.TransferError

Bases: ValueError