readme.md

FABulator is the graphical frontend of FABulous. It can be used to explore fabrics generated by FABulous and provides several functionalities:

• Exploration and Searching
• Easy Navigation and a High Detail View of the Fabric
• Displaying user designs (experimental)
• Viewing HDL code of Bels, Switch Matrices

Additional features are planned, including:

• Interactive architecture editing
• User design editing

For infos on planned features, refer to Planned Features

Disclaimer

FABulator is in its alpha stage and several features are still experimental. Known bugs can be found in Known Bugs.

Getting Started

Prerequisites

FABulator uses Java 17. On linux, the jdk can be installed with

sudo apt install openjdk-17-jdk

To build and run FABulator, maven is required. On a linux machine, it can be installed with

sudo apt install maven

Setup

To set up FABulator:

git clone https://github.com/FPGA-Research-Manchester/FABulator
cd FABulator

To build and run:

mvn javafx:run

For information on how to use FABulator, see How To Use

Screenshots

View of a DSP tile with the HDL code of its bel

Clicking on a port displays its routable connections

Displaying a user design

Tiles can be color coded

Documentation

Documentation both for the user and developer side can be found at Documentation