Installation

Warning

The following instructions are a work-in-progress and may not be entirely up to date.

Torii ILA is as the name implies, a Torii library, so make sure you have Torii installed first and foremost. Once done you should be all set to install Torii ILA.

Depending on which ILA Interface you want, if any, there are some needed prerequisites.

For the USB based ILA and backhaul interface, you need pyusb and Torii-USB installed, and for UART support you need pyserial. There is also a pyvcd dependency regardless if you want USB and or UART ILA support, but that came free with the Torii install.

To install Torii ILA as either standalone, with USB support, with UART support, or with everything simply follow the steps below.

Standalone

pypi

$ pip install torii-ila

From Source

$ pip install 'torii_ila @ git+https://github.com/shrine-maiden-heavy-industries/torii-ila.git'

USB

pypi

$ pip install 'torii-ila[usb]'

From Source

$ pip install 'torii_ila[usb] @ git+https://github.com/shrine-maiden-heavy-industries/torii-ila.git'

UART

pypi

$ pip install 'torii-ila[serial]'

From Source

$ pip install 'torii_ila[serial] @ git+https://github.com/shrine-maiden-heavy-industries/torii-ila.git'

Everything

pypi

$ pip install 'torii-ila[usb,serial]'

From Source

$ pip install 'torii_ila[usb,serial] @ git+https://github.com/shrine-maiden-heavy-industries/torii-ila.git'

From here on you can head over to Getting Started to see the basic usage and the examples.