Transferring Protocols

Every protocol will begin as a file on your computer, regardless of what method of protocol development you use. You need to import the protocol into the Opentrons App and then transfer it to your Flex. When transferring a protocol, you can choose to begin run setup immediately or later.

Import a protocol¶

When you first launch the Opentrons App, you will see the Protocols screen. (Click Protocols in the left sidebar to access it at any other time.) Click Import in the top right corner to reveal the Import a Protocol pane. Then click Choose File and find your protocol in the system file picker, or drag and drop your protocol file into the well.

The Opentrons App will analyze your protocol as soon as you import it. Protocol analysis is the process of taking the JSON object or Python code contained in the protocol file and turning it into a series of commands that the robot can execute in order. If there are any errors in your protocol file, or if you're missing custom labware definitions, a warning banner will appear on the protocol's card. Correct the errors and re-import the protocol. If there are no errors, your protocol is ready to transfer to Flex.

Expanded three-dot menu for a protocol, showing these options: Start setup, Reanalyze, Send to Opentrons Flex, Show in folder, and Delete — Actions available in the three-dot menu (⋮) for imported protocols.

Note

In-app protocol analysis is only a preliminary check of the validity of your protocol. Protocol analysis will run again on the robot once you transfer the protocol to it. It's possible for analysis to fail in the app and succeed on the robot, or vice versa. Analysis mismatches may occur when your app and robot software versions are out of sync, or if you have customized the Python environment on your Flex.

Run immediately¶

Click the three-dot menu (⋮) on your protocol and choose Start setup. Choose a connected and available Flex from the list to transfer the protocol and begin run setup immediately. The run setup screen will appear both in the app and on the touchscreen, and you can continue from either place.

If you stay in the app, expand the sections under the Setup tab and follow the instructions in each one: Robot Calibration, Module Setup (if your protocol uses modules), Labware Position Check (recommended), and Labware Setup. Then click Start run to to begin the protocol.

If you move to the touchscreen, follow the steps in the Protocol Setup section.

Run later¶

Click the three-dot menu (⋮) on your protocol and choose Send to Opentrons Flex. Choose a connected and available Flex from the list to transfer the protocol. A message indicating a successful transfer will pop up both in the app and on the touchscreen. To set up your protocol, you need to move to the touchscreen and follow the steps in the Protocol Setup section.

Recent protocol runs¶

The robot details page lists up to 20 recent protocol runs. This provides additional information compared to the touchscreen, which only shows the most recent run for each unique protocol.

Each entry in the recent protocol runs list includes the protocol name, its timestamp, whether the run was canceled or completed, and the duration of the run. Click the disclosure triangle next to any run to show its associated labware offset data. Click the three-dot menu (⋮) for related actions:

View protocol run record: Show the protocol run screen as it appeared when the protocol ended (succeeded, failed, or was canceled), including all performed steps.
Rerun protocol now: The same as choosing Start setup on the corresponding protocol.
Download run log: Save to your computer a JSON file containing information about the protocol run, including all performed steps.
Delete protocol run record: Delete all information about this protocol run from Flex, including labware offset data. When you choose this option, it's as though the protocol run never happened.

Note

If you need to maintain a comprehensive record of all runs performed on your Flex, you must use the Download run log feature to save this information to your computer.

Download image files: Save to your computer a .zip file containing all the still images taken during a protocol run, if the camera was enabled.

Flex will not retain information about more than 20 runs on the robot. Proceeding to the Run Setup screen generates an entry in the list and counts towards the maximum of 20 runs, even if you never begin the protocol.