Skip to content

Commit

Permalink
first draft landing page + links
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Dec 13, 2023
1 parent 4c86ca7 commit 4b13c75
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 5 deletions.
8 changes: 7 additions & 1 deletion api/docs/v2/new_pipette.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@ Pipettes
pipettes/characteristics
pipettes/configuring

TK pipettes intro
Opentrons pipettes are configurable devices used to move liquids throughout the working area during the execution of protocols. Flex and OT-2 each have their own pipettes, which are available for use in the Python API.

Pages in this section of the documentation cover:

- :ref:`Loading pipettes <loading-pipettes>` into your protocol.
- :ref:`Characteristics of pipettes <pipette-characteristics>`, such as how fast they can move liquid and how they move around the deck.
- :ref:`Configuring Flex pipettes <configuring-pipette-modes>` in different modes, such as for low-volume transfers or only using some of their nozzles.

For information about liquid handling, see :ref:`v2-atomic-commands` and :ref:`v2-complex-commands`.



Expand Down
2 changes: 2 additions & 0 deletions api/docs/v2/pipettes/characteristics.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _pipette-characteristics:

#######################
Pipette Characteristics
#######################
Expand Down
2 changes: 2 additions & 0 deletions api/docs/v2/pipettes/configuring.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _configuring-pipette-modes:

#########################
Configuring Pipette Modes
#########################
Expand Down
7 changes: 3 additions & 4 deletions api/docs/v2/pipettes/loading.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
When writing a protocol, you must inform the Protocol API about the pipettes you will be using on your robot. The :py:meth:`.ProtocolContext.load_instrument` function provides this information and returns an :py:class:`.InstrumentContext` object.

For information about liquid handling, see :ref:`v2-atomic-commands` and :ref:`v2-complex-commands`.

.. _new-create-pipette:
.. _loading-pipettes:

Loading Pipettes
================

When writing a protocol, you must inform the Protocol API about the pipettes you will be using on your robot. The :py:meth:`.ProtocolContext.load_instrument` function provides this information and returns an :py:class:`.InstrumentContext` object.

As noted above, you call the :py:meth:`~.ProtocolContext.load_instrument` method to load a pipette. This method also requires the :ref:`pipette's API load name <new-pipette-models>`, its left or right mount position, and (optionally) a list of associated tip racks. Even if you don't use the pipette anywhere else in your protocol, the Opentrons App and the robot won't let you start the protocol run until all pipettes loaded by ``load_instrument()`` are attached properly.

.. _new-pipette-models:
Expand Down

0 comments on commit 4b13c75

Please sign in to comment.