Repository navigation
Conversation
Describe a plate by its intended end state (PlateDesign), detect geometric gradients and replicate groups, plan and record serial dilutions at a concentrate factor, premix replicate portions, arrange a plate from requirements, and assemble a design from declared sources under a direct, serial, or automatic strategy. The LMSF destination CSV is read and written by lab.plugins.lmsf as a view of a design. The concentration-series example runs on these functions and prepares the layout's Van gradients serially by default.
Each target reports its heads as PipettingLimits; compile() compares every liquid step with the smallest covering head's trusted floor or the lab's warn_below and records Diagnostics on the Compilation, in plan.json, and in a worksheet Advisories section. advise_design() gives the same advice for a plate design before any protocol exists.
Protocol.transfer() and mix() accept sequences of wells and record MultiTransfer and MultiMix lane sets. Opentrons 8-channel heads run a full-column lane set in one stroke, STAR layouts configure up to eight channels and run lanes across them, and single-channel heads run lanes in turn. A TipPolicy recorded with the protocol (or overridden at compile time) decides when targets replace tips, including David Ross's containment rule with a pre-wetting stroke; lab.tips numbers and counts tips for the targets and the worksheet. Serial dilution levels are recorded as lane sets and the example's STAR layout has eight channels.
infer_requirements() reads materials, the longest gradient, the constant conditions along it, every other well as a control, and the lane count off a design, and reports whether arranging them reproduces the plate exactly. Concentrations in advice and labels show in bench units.
ConditionSpec.steps and include_zero shorten or extend the plate's gradient for one condition, so a layout whose row pairs carry 8- and 5-step series counts and arranges as it is laid out. infer_requirements reads them off each gradient and notes when control placement differs.
A Material carries a display name plus optional strain, construct, and SBOL design IRI. Well targets and requirements reference the record, well_target and Requirements accept bare names, and a design rejects two different records under one name. The LMSF plugin builds its materials from the sheet's strain and plasmid columns and reads them back from those attributes instead of parsing the name.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe a plate by what each well must contain at the end, and let the compiler decide how to pipette it.
Example
Plate designs (
lab.plates)PlateDesign/WellTarget: aMaterialand the final concentration of every solute, per well. No steps. A material is a name, or a strain and construct that name it (Material(strain="BL21", construct="pA")is calledBL21 / pA), with an optional SBOL design IRI. A bare name is accepted anywhere a material is; nothing in it is parsed.Requirementswitharrange()(materials × conditions × a dilution series, plus controls), or read it back from any design withinfer_requirements().find_serial_dilutions()detects geometric gradients whose other conditions are constant (tolerant of float-rounded sheet values);parallelize()merges rows into multichannel lanes;find_replicate_groups()finds identical chemistry.plan_serial_dilution()/record_serial_dilution()build a gradient well to well at a concentrate factor so the peak volume fits the well;plan_premix()/record_premix()prepare replicate portions once.assemble()prepares a design from declared stocks, medium, vehicle, and inocula underStrategy.DIRECT,SERIAL, orAUTO, and reports what it decided.lab.plugins.lmsfas a view overPlateDesign; core has no knowledge of it. The plugin builds materials from the sheet's strain and plasmid columns and reads them back from those attributes. The concentration-series example runs onassemble()and prepares its Van gradients serially by default (--strategyswitches).Advisories and pipetting limits
compile(..., warn_below=, resolution=)recordsDiagnostics on theCompilation, inplan.json, and in a worksheet Advisories section for steps below a head's trusted floor or the lab's own minimum. Hard limits stayCompileErrors.lab.limits.PipettingLimitsdescribes each head's range and trusted floor; everyTargetPlanlists its heads;Manual(pipettes=...)takes a bench set;advise_design()gives the same advice before any protocol exists.Multichannel lanes and tip policy
p.transfer(plate.column(12), plate.column(11), ...)andp.mix(...)on sequences recordMultiTransfer/MultiMixlane sets. Opentrons 8-channel heads run a full column in one stroke, STAR layouts take up to eightChannels, single-channel heads run lanes in turn, and the worksheet animates them together.TipPolicyis recorded with the protocol or overridden at compile time: fresh per step, reuse per source, or reuse while every destination's contents are contained in the source's (withprewet()for the pre-wetting stroke). Targets pick up and drop tips at the numbered boundaries;lab.tipsnumbers and counts them.Also
Protocol.capacity(),lab.uM/lab.mM,lab.config.PlateDesignConfig/PreparationConfig.docs/plates.mdplus updates to the configuration and worksheet pages; CHANGELOG under Unreleased.