You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/docs/v2/liquid_classes.rst
+39-42Lines changed: 39 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,15 @@ Liquid Classes
8
8
9
9
Accounting for properties of liquids in your protocol can increase pipetting accuracy on the Flex. For example, a slower flow rate can improve pipetting for a viscous liquid, and an air gap can prevent a volatile liquid from dripping onto the deck.
10
10
11
-
This section covers:
12
-
* Opentrons-verified liquid classes and their optimized properties, like flow rate.
13
-
* Selecting and using a liquid class in a Flex protocol.
14
-
* Customizing a liquid class for your workflow.
11
+
This page covers the properties of Opentrons-verified liquid classes, how to use a verified liquid class in your protocol, and how to customize a liquid class.
15
12
16
13
17
14
.. _opentrons-verified-liquid-classes:
18
15
19
16
Opentrons-verified Liquid Classes
20
17
=================================
21
18
22
-
Opentrons-verified liquid classes are based on the properties of common liquids:
19
+
Opentrons-verified liquid classes are based on the properties of common liquids: water, ethanol, and glycerol.
23
20
24
21
.. list-table::
25
22
:header-rows: 1
@@ -28,9 +25,7 @@ Opentrons-verified liquid classes are based on the properties of common liquids:
28
25
- Description
29
26
- Load name
30
27
* - Aqueous
31
-
-
32
-
* Based on deionized water
33
-
* The system default
28
+
- Based on deionized water
34
29
- ``water``
35
30
* - Volatile
36
31
- Based on 80% ethanol
@@ -39,7 +34,7 @@ Opentrons-verified liquid classes are based on the properties of common liquids:
39
34
- Based on 50% glycerol
40
35
- ``glycerol_50``
41
36
42
-
Use an Opentrons-verified liquid class in your transfers to automatically apply optimized behavior. For example, choosing the ``glycerol_50`` liquid class changes *properties*, like flow rate, to accurately transfer viscous liquid.
37
+
Use an Opentrons-verified liquid class in your transfers to automatically apply optimized behavior. For example, choosing the ``glycerol_50`` liquid class changes properties, like flow rate, to accurately transfer viscous liquid.
43
38
44
39
.. _liquid-class-properties:
45
40
@@ -57,59 +52,75 @@ Each Opentrons-verified liquid class is defined by a set of properties:
- The pipette retracts from the liquid and moves to this position.
87
92
* - .. image:: ../img/lc_icons/retract_speed.png
93
+
88
94
**Retract speed**
89
95
- The pipette retracts from the liquid at the specified speed.
90
96
* - .. image:: ../img/lc_icons/push_out.png
97
+
91
98
**Push out**
92
99
- The pipette dispenses a small amount of air to ensure all liquid leaves the tip.
100
+
- Varies by volume.
93
101
* - .. image:: ../img/lc_icons/touch_tip.png
102
+
94
103
**Touch tip**
95
104
- The pipette touches the attached tip to the sides of a well to remove droplets.
96
105
* - .. image:: ../img/lc_icons/air_gap.png
106
+
97
107
**Air gap**
98
108
- The pipette aspirates a small amount of air after an aspirate or dispense.
109
+
- Varies by volume.
99
110
* - .. image:: ../img/lc_icons/blow_out.png
111
+
100
112
**Blow out**
101
113
- The pipette dispenses a larger amount of air to ensure all liquid leaves the tip.
102
114
103
115
104
116
105
-
A :ref:`liquid class definition <liquid-class-definitions>` specifies values for each property. When your Flex protocol includes a liquid class, these property values automatically define transfer behavior. For example, if you use `.InstrumentContext.transfer_with_liquid_class` to transfer a viscous liquid, the pipette submerges into the liquid and aspirates more slowly to prevent air bubbles from forming.
117
+
A :ref:`liquid class definition <liquid-class-definitions>` specifies values for each property. When your Flex protocol includes a liquid class, these property values automatically define transfer behavior. For example, if you use ``.transfer_with_liquid_class`` to transfer a viscous liquid, the pipette submerges into the liquid and aspirates more slowly to prevent air bubbles from forming.
118
+
106
119
107
-
Properties marked with an asterisk, as shown above, are determined by your pipette, tip, and volumbe combinations. For more information, see :ref:`liquid-class-definitions`.
120
+
.. _using-liquid-classes:
108
121
109
-
.. _selecting-a-liquid-class:
110
-
111
-
Selecting a Liquid Class
112
-
=========================
122
+
Using Liquid Classes
123
+
======================
113
124
114
125
You'll use a :ref:`liquid class definition <liquid-class-definitions>` in your protocol to optimize transfer behavior based on liquid properties, along with your chosen Flex pipettes and tips.
115
126
@@ -140,10 +151,6 @@ Start by definining the tips, trash, pipette, and labware used in your transfers
140
151
141
152
You'll need to add a label, like ``liquid_1``, to liquid classes in your protocol. This helps you keep track of multiple liquids of the same class in a protocol. It's also required by ``transfer_with_liquid_class()``, instead of a liquid class load name like ``glycerol_50``.
142
153
143
-
.. _liquid-class-transfers:
144
-
145
-
Liquid Class Transfers
146
-
=======================
147
154
148
155
Use the :py:meth:`.InstrumentContext.transfer_with_liquid_class` method to transfer an aqueous, volatile, or viscous liquid defined in a Flex protocol. This method accepts arguments that let you specify your liquid, volume, source and destination wells, tip handling preferences, and trash location.
149
156
@@ -165,19 +172,20 @@ In the example below, a Flex P50 1-channel pipette will transfer 50 µL of your
165
172
166
173
Here, the ``glycerol_50`` viscous liquid class definition accounts for all other transfer behavior, like flow rate, whether or not to add an air gap or delay, and submerge and retract speeds. For each aspirate, the pipette:
167
174
168
-
* Moves to the submerge start position of 2 mm above the top of the source well at 4 mm/sec.
169
-
* Submerges into ``liquid_1`` at 4 mm/sec to the aspirate start position of 2 mm above the bottom of the well.
170
-
* Aspirates 50 µL of ``liquid_1`` at 50 µL/sec with a correction by volume of -0.2 µL.
171
-
* Delays for 1 sec after aspirating.
172
-
* Moves to the retract position of 2 mm above the top of the well at 4 mm/sec.
175
+
* Moves to 2 mm above the top of the source well at 4 mm/sec.
176
+
* Submerges to 2 mm above the bottom of the source well at 4mm/sec.
177
+
* Aspirates 50 µL at 50 µL/sec with a correction of -0.2 µL.
178
+
* Delays for 1 second.
179
+
* Retracts to 2 mm above the top of the well at 4 mm/sec.
173
180
174
181
And for each dispense, the pipette:
175
182
176
-
* Moves to the submerge start position of 2 mm above the top of the destination well at 4 mm/sec.
177
-
* Moves to the dispense position of 2 mm above the top of the destination well at 4 mm/sec.
178
-
* Dispense 50 µL of ``liquid_1`` at 25 µL/sec with a correction by volume of -0.2 µL.
179
-
* Pushes out a volume of air equivalent to 3.9 µL to ensure all liquid leaves the tip, and delays for 0.5 sec afterward.
180
-
* Moves to the retract position of 2 mm above the top of the well at 4 mm/sec.
183
+
* Moves to 2 mm above the top of the destination well at 4 mm/sec.
184
+
* Submerges to 2 mm above the top of the destination well at 4 mm/sec.
185
+
* Dispenses 50 µL at 25 µL/sec with a correction of -0.2 µL.
186
+
* Pushes out a volume of air equivalent to 3.9 µL
187
+
* Delays for 0.5 second.
188
+
* Retracts to 2 mm above the top of the well at 4 mm/sec.
181
189
182
190
In many cases, the liquid class definition represents fine-tuned changes optimized for each liquid class. If you instead use the Flex P50 1-channel pipette to transfer 50 µL of the volatile ``liquid_2``, transfer behavior would include:
183
191
* Submerging into and retracting from the volatile ``liquid_2`` at 100 mm/sec.
@@ -192,21 +200,10 @@ Not all transfer behavior is easily visible. See :ref:`liquid-class-definitions`
192
200
Customizing Liquid Classes
193
201
===========================
194
202
195
-
You can create your own liquid class to customize transfer behavior for any liquid in a Flex protocol. To make changes, you can:
196
-
* Edit individual properties of an existing liquid class, or
197
-
* Add properties to a new liquid class.
203
+
You can create your own liquid class to customize transfer behavior for any liquid in a Flex protocol. To make changes, you can edit individual properties of an existing liquid class, or add properties to a new liquid class.
198
204
199
205
To customize an Opentrons-verified liquid class, use :py:meth:`InstrumentContext.define_liquid_class` to define your custom liquid class after adding your pipettes, tips, trash, and labware::
You can also create a new liquid class for your Flex protocols. Instead of using an Opentrons-verified ``base_liquid_class``, you'll start from scratch, providing a value for `every required property <https://github.com/Opentrons/opentrons/blob/edge/shared-data/liquid-class/schemas/1.json>` in your liquid class.
232
+
You can also create a new liquid class for your Flex protocols. Instead of using an Opentrons-verified ``base_liquid_class``, you'll start from scratch, providing a value for `every required property <https://github.com/Opentrons/opentrons/blob/edge/shared-data/liquid-class/schemas/1.json>`__ in your liquid class.
0 commit comments