Apio 1.x.x introduces many improvements compared to Apio 0.x.x. Many of the changes were done in a backward compatible way but some do require user attention. In this page we outline the main changes from compatibility point of view to help Apio 0.x.x to migrate their projects successfully to Apio 1.x.x.

It is recommended to first delete Apio 0.x.x before installing Apio 1.x.x. The steps to do so are:

1. Delete the Apio Python package pip uninstall apio

2. Delete the directory .apio under the user home directory. That directory contains packages and other transient files used by Apio.

Apio 1.x.x requires a project file called apio.ini in the directory of each Apio project. Make sure your project have a text file called apio.ini with the content below, replace with the id of your board (e.g. alhambra-ii) and replace with the name of the top Verilog module of your project (e.g. Blinky).

[env:default]
board = <board>
main-module = <my-module>

Remove from your testbenches all calls to the Verilog function `$dumpfile(). The location of the generated simulation files is now automatically controlled by Apio.

The hierarchy and names of some Apio commands where changed in Apio 1.x.x and the table below will help you migrating from the old to the new commands. You can also use the -h for detail information on any command level, for example apio -, apio devices -h, and apio devices usb -h.