pyplate.Plate

class Plate(name: str, max_volume_per_well: str, make: str = 'generic', rows=8, columns=12)[source]

Bases: object

A spatially ordered collection of Containers, like a 96 well plate. The spatial arrangement must be rectangular. Immutable.

__init__(name: str, max_volume_per_well: str, make: str = 'generic', rows=8, columns=12)[source]

Creates a generic plate.

name

name of plate

max_volume_per_well

maximum volume of each well. (50 uL)

make

name of this kind of plate

rows

number of rows or list of names of rows

Type:

int or list

columns

number of columns or list of names of columns

Type:

int or list

Methods

__init__(name, max_volume_per_well[, make, ...])

Creates a generic plate.

dataframe([unit, substance, cmap, highlight])

param unit:

unit to return quantities in.

fill_to(solvent, quantity)

Fills all wells in plate with solvent up to quantity.

get_moles(substance[, unit])

param unit:

unit to return moles in. ('mol', 'mmol', 'umol', etc.)

get_substances()

Returns: A set of substances present in the slice.

get_volume([unit])

param unit:

unit to return volumes in.

get_volumes([substance, unit])

param unit:

unit to return volumes in.

remove([what])

Removes substances from Plate

transfer(source, destination, quantity)

Move quantity ('10 mL', '5 mg') from source to destination, returning copies of the objects with amounts adjusted accordingly.
dataframe(unit: str = None, substance: str | Substance | Iterable[Substance] = 'all', cmap: str = None, highlight=False) → pandas.io.formats.style.Styler[source]
Parameters:

  • unit – unit to return quantities in.

  • substance – (optional) Substance or Substances to display quantity of.

  • cmap – Colormap to shade dataframe with.

  • highlight – Highlight all wells.

Returns: Shaded dataframe of quantities in each well.

fill_to(solvent, quantity)[source]

Fills all wells in plate with solvent up to quantity.

Parameters:

  • solvent – Substance to use to fill.

  • quantity – Desired final quantity in each well.

Returns: New Plate with desired final quantity in each well.

get_moles(substance: Substance | Iterable[Substance], unit: str | None = None) → ndarray[source]
Parameters:

  • unit – unit to return moles in. (‘mol’, ‘mmol’, ‘umol’, etc.)

  • substance – Substance to display moles of.

Returns: moles of substance in each well.

get_substances() → set[Substance][source]

Returns: A set of substances present in the slice.

get_volume(unit: str = 'uL') → float[source]
Parameters:

unit – unit to return volumes in.

Returns: total volume stored in slice in uL.

get_volumes(substance: Substance | Iterable[Substance] | None = None, unit: str | None = None) → ndarray[source]
Parameters:

  • unit – unit to return volumes in.

  • substance – (optional) Substance to display volumes of.

Returns:

numpy.ndarray of volumes for each well in desired unit.

remove(what=2) → Plate[source]

Removes substances from Plate

Parameters:

what – What to remove. Can be a type of substance or a specific substance. Defaults to LIQUID.

Returns: New Plate with requested substances removed.

static transfer(source: Container | Plate | PlateSlicer, destination: Plate | PlateSlicer, quantity: str) → Tuple[Container | Plate | PlateSlicer, Plate][source]

Move quantity (‘10 mL’, ‘5 mg’) from source to destination, returning copies of the objects with amounts adjusted accordingly.

Parameters:

  • source – What to transfer.

  • destination – Plate or slice of a plate to transfer to.

  • quantity – How much to transfer.

Returns:

A tuple of (T, Plate) where T is the type of the source.