<!– SPDX-FileCopyrightText: 2026 Ahmed Imamović SPDX-FileCopyrightText: 2026 Tarik Hamedović SPDX-License-Identifier: CC-BY-SA-4.0 –>

Quickstart

This quickstart assumes you are at the repository root and already have a working Python environment for LiteX development.

Install the Python package

Editable install keeps the package importable while you edit the source tree.

python -m pip install -e 2.soc/8.python

If you use the build Makefile under 3.build, you can also run:

make -C 3.build install-python

The preferred package entry point is:

python -m uberclock_soc --build --with-uberclock --with-uberddr3 --with-ethernet

Equivalent workflow through the repository Makefile:

make -C 3.build build-board \
  OPTIONS="--with-uberclock --with-uberddr3 --with-ethernet"

The canonical published docs site is the main Sphinx project under 0.doc/docs.

python -m pip install -r 0.doc/docs/requirements.txt
python -m sphinx -b html 0.doc/docs/source 0.doc/docs/build/html

Open:

0.doc/docs/build/html/index.html

After building the SoC, the software/demo tree can be driven with:

make -C 3.build build-sw
make -C 3.build term PORT=/dev/ttyUSB0