Installation¶

Warning

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

Torii-USB requires Python >= 3.10, and Yosys >= 0.30 except for 0.37 due to a Verilog backend bug. Torii-USB has been tested with CPython, but might possibly run under PyPy.

Torii-USB is built off of the Torii Hardware Definition Language, as such that is also required.

Installing Prerequisites¶

Prior to installing Torii-USB, you must install all of its prerequisites and requirements.

Installing Python¶

First off, install python and pip onto your system if the’re not there already.

Arch-like

$ sudo pacman -S python python-pip

Other Linux

Warning

These instructions may be incorrect or incomplete!

Debian-like

For Debian based systems, use apt to install python3 and python3-pip

$ sudo apt install python3 python3-pip

macOS

Install Homebrew if not done already, then install the requirements.

$ brew install python

Windows

Warning

These instructions may be incorrect or incomplete!

Download the latest Python installer from the python downloads page.

Follow the instructions and ensure that the installer installs pip and puts the python executable in your %PATH%

Installing Yosys¶

Arch-like

On Arch Linux and Arch-likes, you can install nightly packages which are located in the AUR with an AUR helper or using makepkg directly.

Via an AUR helper like yay

$ yay -S yosys-nightly nextpnr-ice40-nightly nextpnr-ecp5-nightly

Via makepkg directly

$ git clone https://aur.archlinux.org/yosys-nightly.git
$ git clone https://aur.archlinux.org/prjtrellis-nightly.git
$ git clone https://aur.archlinux.org/icestorm-nightly.git
$ git clone https://aur.archlinux.org/nextpnr-ecp5-nightly.git
$ git clone https://aur.archlinux.org/nextpnr-ice40-nightly.git
$ (cd yosys-nightly && makepkg -sic)
$ (cd prjtrellis-nightly && makepkg -sic)
$ (cd icestorm-nightly && makepkg -sic)
$ (cd nextpnr-ecp5-nightly && makepkg -sic)
$ (cd nextpnr-ice40-nightly && makepkg -sic)

Other Linux

Warning

These instructions may be incorrect or incomplete!

With other Linux distributions, it is recommended to use the OSS Cad Suite nightly build. It provides a full environment of all the tools needed built on a nightly basis.

Simply download the latest release for your architecture, extract it to a good home, and then add it to your $PATH

$ curl -LOJ https://github.com/YosysHQ/oss-cad-suite-build/releases/download/2024-07-02/oss-cad-suite-linux-x64-20240702.tgz
$ tar xfv oss-cad-suite-linux-x64-20240702.tgz
$ export PATH="`pwd`/oss-cad-suite/bin:$PATH"

macOS

For macOS systems, it is recommended to use the YoWASP distribution of the toolchain. However if you want to use the native tools, and you are using an Intel based Mac, then the OSS Cad Suite has nightly builds for x86_64 versions of Darwin.

Simply download the latest release for your architecture, extract it to a good home, and then add it to your $PATH

$ curl -LOJ https://github.com/YosysHQ/oss-cad-suite-build/releases/download/2024-07-02/oss-cad-suite-darwin-x64-20240702.tgz
$ tar xfv oss-cad-suite-darwin-x64-20240702.tgz
$ export PATH="`pwd`/oss-cad-suite/bin:$PATH"

Windows

Warning

These instructions may be incorrect or incomplete!

For Windows systems, it is recommended to use the YoWASP distribution of the toolchain. However if you want to use the native tools, and you are using an Intel based PC, then the OSS Cad Suite has nightly builds for x86_64 versions of Windows.

Simply download the latest release for your architecture, extract it to a good home, and then add it to your %PATH%

$ call %cd%\oss-cad-suite\environment.bat

Installing Torii¶

Next, install the latest stable version of Torii from PyPi.

Arch-like

$ pip install --user --upgrade torii

Other Linux

$ pip install --user --upgrade torii

macOS

$ pip install --user --upgrade torii

Windows

> pip install --upgrade torii

Installing Torii-USB¶

The latest release of Torii-USB is recommended for any new projects planning to use Torii-USB. It provides the most up-to-date stable version of the API. However, if needed, you can also install a development snapshot to get access to the bleeding-edge, however the API may be unstable.

Latest release¶

Arch-like

$ pip install --user --upgrade torii-usb

Other Linux

$ pip install --user --upgrade torii-usb

macOS

$ pip install --user --upgrade torii-usb

Windows

> pip install --upgrade torii-usb

Development snapshot¶

```{eval-rst} .. tab:: Arch-like

$ pip install --user --upgrade 'torii-usb @ git+https://github.com/shrine-maiden-heavy-industries/torii-usb.git'

Other Linux

$ pip install --user --upgrade 'torii-usb @ git+https://github.com/shrine-maiden-heavy-industries/torii-usb.git'

macOS

$ pip install --user --upgrade 'torii-usb @ git+https://github.com/shrine-maiden-heavy-industries/torii-usb.git'

Windows

> pip install --upgrade "torii-usb @ git+https://github.com/shrine-maiden-heavy-industries/torii-usb.git"

### Editable development snapshot

To install an editable development snapshot of Torii-USB for the first time, run:

```{eval-rst}
.. tab:: Arch-like

	.. code-block:: console

		$ git clone https://github.com/shrine-maiden-heavy-industries/torii-usb
		$ cd torii-usb
		$ pip3 install --user --editable '.'

.. tab:: Other Linux

	.. code-block:: console

		$ git clone https://github.com/shrine-maiden-heavy-industries/torii-usb
		$ cd torii-usb
		$ pip3 install --user --editable '.'


.. tab:: macOS

	.. code-block:: console

		$ git clone https://github.com/shrine-maiden-heavy-industries/torii-usb
		$ cd torii-usb
		$ pip3 install --user --editable '.'


.. tab:: Windows

	.. code-block:: doscon

		> git clone https://github.com/shrine-maiden-heavy-industries/torii-usb
		> cd torii-usb
		> pip install --editable .

Any changes made to the torii-usb directory will immediately affect any code that uses Torii-USB. To update the snapshot, run:

Arch-like

$ cd tori-usb
$ git pull --ff-only origin main
$ pip3 install --user --editable '.'

Other Linux

$ cd tori-usb
$ git pull --ff-only origin main
$ pip3 install --user --editable '.'

macOS

$ cd tori-usb
$ git pull --ff-only origin main
$ pip3 install --user --editable '.'

Windows

> cd sol
> git pull --ff-only origin main
> pip install --editable .

Run the pip3 install --editable . command each time the editable development snapshot is updated in case package dependencies have been added or changed. Otherwise, code using Torii-USB may misbehave or crash with an ImportError.