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: docs/source/getting_started.rst
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,9 +89,9 @@ For each container you want to use on the deck, you need to load it into your fi
89
89
90
90
**containers.load** (*container, slot, name*)
91
91
92
-
* **container -** type of container (trough-12-row, etc)
93
-
* **slot -** the slot location on the deck (A1-E3)
94
-
* **name -** custom name
92
+
* **container -** type of container (aka "trough-12row")
93
+
* **slot -** the slot location on the deck ("A1" through "E3")
94
+
* **name -** custom name, used inside API when saving calibration data
95
95
96
96
The example below declares 3 different containers and assigns them to the appropriate slots on the deck.
97
97
@@ -144,7 +144,7 @@ Pipettes
144
144
* **tip_racks -** array (list) of container(s) where you want to pick up tips
145
145
* **channels -** number of channels (1 or 8)
146
146
147
-
This example loads a single channel, 20-200 uL pipette on the b axis that pulls tips from tiprack and deposits them in trash
147
+
This example loads a single channel, 20-200 uL pipette on the ``b`` axis that pulls tips from tiprack and deposits them in trash
148
148
149
149
.. testcode:: main
150
150
@@ -340,9 +340,9 @@ Containers are calibrated to the bottom of the well, and each labware definition
340
340
341
341
.. testcode:: main
342
342
343
-
p200.dispense(plate['A1'].top())
344
-
p200.mix(3, 100, plate['B2'].bottom(5))
345
-
p200.dispense(plate['A1'].top(-3))
343
+
p200.dispense(plate['A1'].top()) # at the top of well
344
+
p200.mix(3, 100, plate['B2'].bottom(5)) # 5mm above bottom of well
345
+
p200.dispense(plate['A1'].top(-3)) # 3mm below top of well
346
346
347
347
Homing
348
348
------
@@ -354,13 +354,14 @@ You can instruct the robot to home at any point in the protocol, or just home on
354
354
* **axes -** the axes you want to home
355
355
* **enqueue -** True or False
356
356
357
-
When the python file is loaded into the protocol, it runs through all of the commands. When enqueue=False, this will cause the robot to home immediately upon loading the protocol, whereas if enqueue=True, it will run when it is called in the protocol.
357
+
When the python file is loaded into the protocol, it runs through all of the commands. When enqueue=False (default), this will cause the robot to home immediately upon loading the protocol, whereas if enqueue=True, it will run when it is called in the protocol.
358
358
359
359
.. testcode:: main
360
360
361
-
robot.home(enqueue=True)
362
-
robot.home('ab', enqueue=True)
363
-
robot.home('xyz', enqueue=True)
361
+
robot.home() # causes robot to home immediately
362
+
robot.home(enqueue=True) # adds "home" command to protocol queue
363
+
robot.home('ab', enqueue=True) # adds "home ab" command to protocol queue
364
+
robot.home('xyz', enqueue=True) # adds "home xyz" command to protocol queue
0 commit comments