Apio is written in Python and works on Linux (+ARM), Mac OS X, Windows.

System requirements

Operating System:

Linux (+ARM), Mac OS X or Windows

Python Interpreter:

Python 2.7, Python 3.5+


Windows Users: Please Download the latest Python and install it. DON’T FORGET to select Add python.exe to Path feature on the “Customize” stage, otherwise Python Package Manager pip command will not be available.

Terminal Application:

All commands below should be executed in Command-line application (Terminal). For Mac OS X and Linux OS - Terminal application, for Windows OS – cmd.exe application.

Access to Serial Ports (USB/UART):

Windows Users: Please check that you have correctly installed USB driver from board manufacturer.

Linux Users: Ubuntu/Debian users may need to add own “username” to the “dialout” group if they are not “root”, doing this issuing a sudo usermod -a -G dialout $USER.

Install Apio

The latest stable version of Apio may be installed or upgraded via Python Package Manager (pip) as follows:

$ pip install -U apio

If pip command is not available run easy_install pip.

Note that you may run into permissions issues running these commands. You have a few options here:

  • Run with sudo to install Apio and dependencies globally
  • Specify the pip install –user option to install local to your user
  • Run the command in a virtualenv local to a specific project working set.


Debian users can also install the application and its packages by executing the following commands. (These packages may not be updated).

$ curl -sSL | sudo sh
$ sudo apt-get install apio
$ sudo apt-get install apio-scons apio-icestorm apio-iverilog apio-examples apio-system

Install FTDI drivers

For boards with a FTDI interface.

$ apio drivers --ftdi-enable

To revert the FTDI drivers configuration.

$ apio drivers --ftdi-disable

Install Serial drivers

For boards with a Serial interface.

$ apio drivers --serial-enable

To revert the Serial drivers configuration.

$ apio drivers --serial-disable