GetstartedImportaprotocol

Citation

OpenTrons. (2023). Get started: Import a protocol. OpenTrons Support. Retrieved from https://support.opentrons.com/s/article/Get-started-Import-a-protocol

URL: https://support.opentrons.com/s/article/Get-started-Import-a-protocol

Title: Get started: Import a protocol

After you’ve attached pipettes and finished deck, tip length, and pipette offset calibrations, you can import a protocol.

Introduction

Before starting

Procedure

Step 1: Import Python (.py) or Protocol Designer (.json) file

Troubleshooting: “Module not found” or “File not found” errors during protocol analysis

Step 2: Select protocol

Step 3: Proceed to run setup

Troubleshooting: Help! I don't see any available robots listed / I'm unable to connect

Step 4: Review details on run setup page

Setup

Module Controls

Run Preview

Step 5: Start run

Continue to the next section

Introduction

Before starting

If you haven't yet decided on a protocol method, see Get started: Choose which protocol method is right for you.

Procedure

Step 1: Import Python (.py) or Protocol Designer (.json) file

In the Opentrons App, select the Protocols tab. If you have not imported any protocols, you will be able to select Choose File or drag and drop to import your Python (.py) or Protocol Designer (.json) file.

import protocol_edit.png

If you have already imported a protocol, this is also where you will see it listed.

Troubleshooting: “Module not found” or “File not found” errors during protocol analysis

When a protocol is imported into the app, it undergoes protocol analysis local to the Opentrons App (this is before it is simulated on the OT-2 itself). This process extracts information from the protocol and loads it into the app to display the metadata and graphics.

If you are using the Python API and see an error such as “Module not found” for Python packages or “File not found” for csv files loaded onto your OT-2, please review the troubleshooting steps found in Protocol analysis.

Step 2: Select protocol

To proceed, select the protocol you want to run.

first protocol_edit.png

Note: You can select Import to add more protocols. You can also change the way the list is organized by selecting a different option from the Sort by dropdown menu in the upper right.

Step 3: Proceed to run setup

After selecting your protocol, you'll be taken to the protocol overview page. Select Run protocol to continue setting up your run.

protocol page_edit.png

You will be prompted to choose an available robot before you can select Proceed to setup.

choose robot_edit.png

Troubleshooting: Help! I don't see any available robots listed / I'm unable to connect

If this is your first time connecting to the robot, please see:

If you've successfully connected to the robot before but are suddenly unable to, please see:

Step 4: Review details on run setup page

Details about your protocol are broken down into 3 tabs on the run setup page:

  • Setup

  • Module Controls

  • Run Preview

Setup

The Setup tab displays the statuses of Robot Calibration, Module Setup (if your protocol uses Opentrons modules), Labware Setup, and Liquid Setup. Click on a step to expand it.

setup run_edit.PNG

Note: If your protocol does not use any modules, the Module Setup step will not be shown.

Robot Calibration allows you to review current calibration data and will flag any required calibrations that are missing or need to be redone.

setup run_cals_edit.PNG

Module Setup displays information about the modules used in the protocol.

setup run_mods_edit.PNG

Labware Setup displays information about labware used in the protocol. This is also where you can run Labware Position Check. See How Labware Offsets work for additional details.

setup run_labware_edit.PNG

Initial Liquid Setup displays the volume and starting location of each liquid used in the protocol. Click on a liquid to further expand it.

setup run_liquid_expand_edit.PNG

You can click on an expanded liquid's details to see specific information about the labware containing the liquid, as well as its starting deck state.

setup run_liquid_expand_select.PNG

setup run_liquid_detail_edit.PNG

Module Controls

The Module Controls tab allows you to interact with connected Opentrons modules that will be used in your protocol.

The protocol in the example shown throughout this article uses a Magnetic Module. You can set the engage height of the magnets by selecting the three-dot menu (⋮) > Set engage height.

setup run_mod controls_three-dot_edit.PNG

Run Preview

The Run Preview tab displays a preview of your protocol's steps.

setup run_run preview_edit.png

Step 5: Start run

When you're ready to run your protocol, select Start run at the top.

setup run_start.PNG

Copyright © 2023 Opentrons

Was this helpful?