Development Setup

Some of you might be interested in testing out the Python protocols you've coded using our API locally on your computer. To do this, you'll need to install some of our software on your computer. Here are the step-by-step instructions to do that. 

Individual projects may have additional instructions, so be sure to check out the various project READMEs, too.

Environment and Repository

Your computer will need the following tools installed to be able to develop with the Opentrons platform:

  • macOS 10.11+, Linux, or Windows 10On Windows, please configure Git’s core.autocrlf setting (see the Git config docs) to input so that shell scripts required for the robot’s boot process in api/opentrons/resources do not have carriage returns inserted.
  • Python 3.6 (pyenv is optional, but recommended for macOS / Linux. If pyenv is not available for your system or you do not want to use it, you can set the environment variable OT_PYTHON to the full path to the Python 3.6 executable) pyenv install 3.6.4
  • Node v8 LTS (Carbon) - nvm is optional, but recommendednvm install lts/carbon
  • yarn - JavaScript package manager
  • commitizen - Commit message formatteryarn global add commitizen
  • GNU Make - we use Makefiles to manage our builds
  • cURL - used to push development updates to robots

Once you're set up, clone the repository and install all project dependencies:

git clone https://github.com/Opentrons/opentrons.git
cd opentrons
make install 

Did this answer your question?