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/module.rst
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Just like a pipette, you need to set up and name your module.
20
20
21
21
**instruments.Magbead** (*mofset, name*)
22
22
23
-
* **mofset -** default to =0
23
+
* **mosfet -** integer 0-5 (defaults to 0)
24
24
* **name -** the name you want to call your module
25
25
26
26
.. testsetup:: main
@@ -31,23 +31,20 @@ Just like a pipette, you need to set up and name your module.
31
31
32
32
.. testcode:: main
33
33
34
-
mag_deck = instruments.Magbead(
35
-
mosfet=0,
36
-
name='mag_deck'
37
-
)
34
+
mag_deck = instruments.Magbead(name='mag_deck')
38
35
39
36
Activate and Deactivate Magnets
40
37
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
41
38
42
-
To activate the magnets, use the following command
39
+
To activate the magnets and raise the module's platform, run ``.engage()``:
43
40
44
41
**module.engage** ()
45
42
46
43
.. testcode:: main
47
44
48
45
mag_deck.engage()
49
46
50
-
To deactive the magnets, use the following command
47
+
To deactivate the magnets and lower the module's platform, run ``.disengage()``:
51
48
52
49
**module.disengage** ()
53
50
@@ -58,7 +55,7 @@ To deactive the magnets, use the following command
58
55
Chain Other Commands
59
56
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60
57
61
-
Just like aspirate() and dispense() can be chained, you can chain engage() and disengage(), as well as the delay() if you don't want to do anything between engaging and disengaging the magnets.
58
+
Just like ``aspirate()`` and ``dispense()`` can be chained, you can chain ``engage()`` and ``disengage()``, as well as the ``delay()`` if you don't want to do anything between engaging and disengaging the magnets.
62
59
63
60
.. testcode:: main
64
61
@@ -68,7 +65,7 @@ Just like aspirate() and dispense() can be chained, you can chain engage() and d
68
65
69
66
mag_deck.engage().delay(60).disengage()
70
67
71
-
You can call delay() with a pipette or a mag_deck module.
68
+
You can call ``delay()`` with a ``Pipette`` or a ``Magbead`` module.
0 commit comments