Skip to content

Commit b4d12ad

Browse files
authored
Merge pull request #118 from OpenTrons/fix-docs-take-two
fixes
2 parents d88e1de + fb10e1e commit b4d12ad

File tree

1 file changed

+14
-22
lines changed

1 file changed

+14
-22
lines changed

docs/source/getting_started.rst

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Before running any code, you need to install the Opentrons API in your jupyter n
2020
2121
!pip install --upgrade opentrons
2222
23+
.. note::
24+
25+
You can update your API by repeating the !pip install, but remember to restart your notebook afterwards for the changes to take effect
26+
2327
Now that you've installed Opentrons API on your computer, you have access to a variety of robot container and instrument commands. You need to import them to each project (protocol) in order to access these commands. Unlike the install, this set of imports needs to be done at the start of each protocol.
2428

2529
.. testsetup:: main
@@ -58,19 +62,7 @@ Now that you've installed Opentrons API on your computer, you have access to a v
5862

5963
.. testcode:: main
6064

61-
from opentrons.robot import Robot
62-
from opentrons import containers
63-
from opentrons import instruments
64-
65-
Now that you have imported the opentrons modules, you need to declare a new robot object (so you can run your protocol commands on it).
66-
67-
.. code-block:: python
68-
69-
robot = Robot()
70-
71-
.. note::
72-
73-
You can update your API by repeating the !pip install, but remember to restart your notebook afterwards for the changes to take effect
65+
from opentrons import robot, containers, instruments
7466

7567

7668
Deck Set Up
@@ -132,24 +124,24 @@ Pipettes
132124

133125
.. code-block:: python
134126
135-
mypipette = instruments.Pipette(
136-
name="mypipette",
127+
mypipette = instruments.Pipette(
128+
name="mypipette",
129+
axis="b",
130+
max_volume=200,
131+
min_volume=20,
137132
trash_container=trash,
138-
tip_racks=[tiprack],
139-
min_volume=20,
140-
max_volume=200
141-
axis="b",
133+
tip_racks=[tiprack],
142134
channels=1
143135
)
144136
145137
**instruments.Pipette** (*name, trash_container, tip_racks, min_volume, max_volume, axis, channels*)
146138

147139
* **name -** name you give pipette
140+
* **axis -** axis the pipette is on (a or b)
141+
* **max_volume -** maximum volume of pipette
142+
* **min_volume -** minimum volume of pipette
148143
* **trash_container -** given name of container where you want to deposit tips
149144
* **tip_racks -** array (list) of container(s) where you want to pick up tips
150-
* **min_volume -** minimum volume of pipette
151-
* **max_volume -** maximum volume of pipette
152-
* **axis -** axis the pipette is on (a or b)
153145
* **channels -** number of channels (1 or 8)
154146

155147
This example loads a single channel, 20-200 uL pipette on the b axis that pulls tips from tiprack and deposits them in trash

0 commit comments

Comments
 (0)