Skip to content

Commit

Permalink
docs(api): additional partial tip pickup layouts in 2.20 (#15778)
Browse files Browse the repository at this point in the history
# Overview

Document the new `ROW`, `SINGLE`, and `PARTIAL_COLUMN` configurations
for partial tip pickup.

# Test Plan

-
[Sandbox](http://sandbox.docs.opentrons.com/docs-more-partial-pickup/v2/pipettes/partial_tip_pickup.html)
- Code snippets passed simulation.

# Changelog

- Added three new sections to the Partial Tip Pickup page, one for each
layout.
- Added new layouts to Versioning page.
- Various consistency edits throughout the docs.

# Review requests

- Double check code (eye test and simulate).
- Keep an eye out for any other inconsistencies / dependencies between
Partial Tip Pickup and other pages.
- Confirm that the explanations make sense and there are no pitfalls for
API users.

# Risk assessment

v low
  • Loading branch information
ecormany authored Aug 16, 2024
1 parent 7fa6cda commit 1a42392
Show file tree
Hide file tree
Showing 6 changed files with 275 additions and 49 deletions.
2 changes: 1 addition & 1 deletion api/docs/v2/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
# use rst_prolog to hold the subsitution
# update the apiLevel value whenever a new minor version is released
rst_prolog = f"""
.. |apiLevel| replace:: 2.19
.. |apiLevel| replace:: 2.20
.. |release| replace:: {release}
"""

Expand Down
6 changes: 1 addition & 5 deletions api/docs/v2/new_pipette.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,7 @@ Pages in this section of the documentation cover:

- :ref:`Loading pipettes <loading-pipettes>` into your protocol.
- :ref:`Pipette characteristics <pipette-characteristics>`, such as how fast they can move liquid and how they move around the deck.
- The :ref:`partial tip pickup <partial-tip-pickup>` configuration for the Flex 96-Channel Pipette, which uses only 8 channels for pipetting. Full and partial tip pickup can be combined in a single protocol.
- :ref:`Partial tip pickup <partial-tip-pickup>` configurations for multi-channel pipettes. Full and partial tip pickup configurations can be combined in a single protocol.
- The :ref:`volume modes <pipette-volume-modes>` of Flex 50 µL pipettes, which must operate in low-volume mode to accurately dispense very small volumes of liquid.

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




2 changes: 1 addition & 1 deletion api/docs/v2/pipettes/characteristics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Multi-Channel Movement

All :ref:`building block <v2-atomic-commands>` and :ref:`complex commands <v2-complex-commands>` work with single- and multi-channel pipettes.

To keep the protocol API consistent when using single- and multi-channel pipettes, commands treat the back left channel of a multi-channel pipette as its *primary channel*. Location arguments of pipetting commands use the primary channel. The :py:meth:`.InstrumentContext.configure_nozzle_layout` method can change the pipette's primary channel, using its ``start`` parameter. See :ref:`partial-tip-pickup` for more information.
To keep the protocol API consistent when using single- and multi-channel pipettes, location arguments of pipetting commands use the pipette's *primary channel*. For multi-channel pipettes picking up tips with all of their channels, the back-left channel is considered primary. When using fewer channels, the ``start`` parameter of the :py:meth:`.InstrumentContext.configure_nozzle_layout` method can change the pipette's primary channel. See :ref:`partial-tip-pickup` for more information.

With a pipette's default settings, you can generally access the wells indicated in the table below. Moving to any other well may cause the pipette to crash.

Expand Down
Loading

0 comments on commit 1a42392

Please sign in to comment.