FuseSoC Examples

This repository contains examples to help one better understand FuseSoC features.

• prims_lib: A demonstration project highlighting approaches to handling primitive libraries in FuseSoC-based projects.

Developer Environment

The easiest way to get up and running is to use the nix environment, but it's not required and one can manually install dependencies.

The Nix Environment

If you don't already have Nix installed, you can follow the instructions at: https://zero-to-nix.com/start/install.

Once you have nix installed, run the following to enter the developer environment.

nix develop .

Manual Environment Setup

You'll need to install a recent version of verilator and poetry.

Then run poetry shell install all the required python dependencies. Once in this poetry environment, you'll need to add the python_plugins directory to your PYTHONPATH environment variable.

poetry shell
PYTHONPATH="$(pwd)/python_plugins:$PYTHONPATH"

Checks

You can run the following command to run all lints and checks.

nix flake check

This is especially useful if you're contributing a change and want to check nothing's been broken.