Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Add opentrons container defs and images #2531

Merged
merged 2 commits into from
Oct 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ lint: $(ot_py_sources)
$(python) -m pylama src/opentrons tests

.PHONY: docs
docs:
docs: local-install
pipenv run sphinx-build -b html -d docs/build/doctrees docs/source docs/build/html
pipenv run sphinx-build -b doctest -d docs/build/doctrees docs/source docs/build/doctest
shx mkdir -p docs/dist
Expand Down
2 changes: 1 addition & 1 deletion api/docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Pipette
.. module:: opentrons.legacy_api.instruments

.. autoclass:: opentrons.legacy_api.instruments.Pipette
:members: aspirate, dispense, mix, delay, drop_tip, blow_out, touch_tip, pick_up_tip, return_tip, move_to, home, set_flow_rate
:members: aspirate, dispense, mix, delay, drop_tip, blow_out, touch_tip, pick_up_tip, return_tip, transfer, distribute, consolidate, move_to, home, set_flow_rate
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
144 changes: 143 additions & 1 deletion api/docs/source/labware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,148 @@ Some containers might only take up half a slot. You must explicitly say `share=T

**********************

*********************
Opentrons Containers
*********************

Tipracks
========

opentrons-300ul-tiprack
-----------------------
Tiprack for both a 50ul and 300ul pipette (single or 8-channel)

.. code-block:: python

labware.load('opentrons-300ul-tiprack', slot)

**Accessing Tips:** *single channel* ``['A1']-['H12']``, *8-channel* ``['A1']-['A12']``

|tiprack_left| |tiprack_right|


.. |tiprack_left| image:: img/labware_lib/OT2TipRackP50_P300_TOP.png

.. |tiprack_right| image:: img/labware_lib/OT2TipRackP50_P300_ISO.png

Aluminum Blocks
===============

Aluminum blocks are typically paired with a temperature module. Can also be used as a standalone container.

opentrons-aluminum-block-2ml-eppendorf
--------------------------------------
A 2ml tube holder, specifically based off of eppendorf snapcap tubes.

.. code-block:: python

labware.load('opentrons-aluminum-block-2ml-eppendorf', slot)

**Accessing Wells:** *single channel* ``['A1']-['D6']``

|2ml_alum_left| |2ml_alum_right|

.. |2ml_alum_left| image:: img/labware_lib/24x1.5mL_TOP.png

.. |2ml_alum_right| image:: img/labware_lib/24x1.5mL_ISO.png


opentrons-aluminum-block-2ml-screwcap
-------------------------------------
A 2ml tube holder, specifically based off of screwcap tubes

.. code-block:: python

labware.load('opentrons-aluminum-block-2ml-screwcap', slot)

**Accessing Wells:** *single channel* ``['A1']-['D6']``

|2ml_alum_left| |2ml_alum_right|

.. |2ml_alum_left| image:: img/labware_lib/24x1.5mL_TOP.png

.. |2ml_alum_right| image:: img/labware_lib/24x1.5mL_ISO.png

opentrons-aluminum-block-96-PCR-plate
-------------------------------------
A flat plate which acts as an adaptor for a well plate. This particular definition is modeled after the
96-well biorad hardshell plate.

.. code-block:: python

labware.load('opentrons-aluminum-block-96-PCR-plate', slot)

**Accessing Wells:** *single channel* ``['A1']-['H12']``, *8-channel* ``['A1']-['A12']``

opentrons-aluminum-block-PCR-strips-200ul
-----------------------------------
A 96 well adaptor meant to hold 96 PCR strips with 200ul max volume.

.. code-block:: python

labware.load('opentrons-aluminum-block-PCR-strips-200ul', slot)

**Accessing Wells:** *single channel* ``['A1']-['H12']``, *8-channel* ``['A1']-['A12']``

|96tube_left| |96tube_right|

.. |96tube_left| image:: img/labware_lib/96well_aluminumblock_TOP.png

.. |96tube_right| image:: img/labware_lib/96well_aluminumblock_ISO.png

Modular Tuberack
================

opentrons-tuberack-2ml-eppendorf
--------------------------------

This tuberack insert definition is for snapcap tubes ranging from 2-5ml.

|2ml_left| |2ml_right|

.. |2ml_left| image:: img/labware_lib/24x2mL-5mL_TOP.png

.. |2ml_right| image:: img/labware_lib/24x2mL-5mL_ISO.png

opentrons-tuberack-2ml-screwcap
-------------------------------

This tuberack insert definition is for screwcap tubes ranging from 2-5ml.

|2ml_left| |2ml_right|

.. |2ml_left| image:: img/labware_lib/24x2mL-5mL_TOP.png

.. |2ml_right| image:: img/labware_lib/24x2mL-5mL_ISO.png


opentrons-tuberack-15ml
-----------------------

|15ml_left| |15ml_right|

.. |15ml_left| image:: img/labware_lib/15x15mL_TOP.png

.. |15ml_right| image:: img/labware_lib/15x15mL_ISO.png

opentrons-tuberack-50ml
-----------------------

|50ml_left| |50ml_right|

.. |50ml_left| image:: img/labware_lib/6x50mL_TOP.png

.. |50ml_right| image:: img/labware_lib/6x50mL_ISO.png

opentrons-tuberack-15_50ml
--------------------------

|15_50ml_left| |15_50ml_right|

.. |15_50ml_left| image:: img/labware_lib/6x15mL_4x50mL_TOP.png

.. |15_50ml_right| image:: img/labware_lib/6x15mL_4x50mL_ISO.png

Point
=====

Expand Down Expand Up @@ -533,7 +675,7 @@ will print out...

Wells To
--------

Instead of having to list the name of every well, we can also create a range of wells with a start and end point. The first argument is the starting well, and the ``to=`` argument is the last well.

.. code-block:: python
Expand Down
11 changes: 10 additions & 1 deletion api/docs/source/writing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If Python is new to you, we suggest going through a few simple tutorials to acqu
8) `Dictionaries <http://www.learnpython.org/en/Dictionaries>`_

After going through the above tutorials, you should have enough of an understanding of Python to work with the Opentrons API and start designing your experiments!

More detailed information on python can always be found at `the python docs <https://docs.python.org/3/index.html>`_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick, but should Python be capitalized?

*******************************

*******************
Expand Down Expand Up @@ -63,3 +63,12 @@ You can access Jupyter Notebook using the following:

1. Open your Opentrons App and look for the IP address of your robot on the robot information page.
2. Type in ``(Your Robot's IP Address):48888`` into any browser on your computer.

***************************
Simulating Python Protocols
***************************

As our OT 2 software is no longer bundled with our desktop app, there are a few more steps you have to follow in order
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick, but this sort of implies that at one point, our OT-2 software was bundled with the app, which (for OT-2) it never was). Could we gear the language a little more towards "this is how the OT-2 operates" rather than "this is how the OT-1 used to operate?

For example would this be ok: "Since the OT-2 runs its own copy of the Opentrons API, you have to go through a few extra steps if you'd like to simulate a Python protocol on your own computer without being connected to a robot."

(Also super picky nitpick: but I think we stylize it "OT-2" rather than "OT 2". Sorry.)

to simulate your protocol without being connected to a robot.

To set up your environment, please view `this article <https://support.opentrons.com/ot-2/getting-started-software-setup/installing-the-opentrons-api-on-your-computer>`_