Installation Method

Warning

Windows Support

FABulous is not officially supported on native Windows. While the tool may work, you may encounter errors and unexpected behavior. For the best experience on Windows-based systems, we strongly recommend using Windows Subsystem for Linux (WSL).

To set up WSL, visit: https://docs.microsoft.com/en-us/windows/wsl/install

We provide multiple ways to install and use FABulous.

We recommend uv for most users as it provides fast, reproducible dependency resolution. If you prefer a simpler setup using Python’s built-in tooling, use venv. After FABulous installation you will also need to install the CAD tools. If you want an all-in-one package with full encapsulation, go with docker. If you want to run the GDS flow, go with nix.

• uv based setup
  • Installing uv
  • Install FABulous
• venv based setup
  • Dependencies
  • FABulous repository
  • Virtual environment
  • Install FABulous
• Install Required CAD tools
  • Installing Non required CAD tools
• docker based setup
  • Pre-built Docker Images
    • Release Image (Recommended for Users)
    • Development Image (For Contributors)
  • Running the Docker Container
    • Basic Usage
    • Development Usage
    • With GUI Support (Linux)
  • Using Dev Containers (Local Development)
    • Prerequisites
    • Getting Started
  • Troubleshooting
    • GUI applications crash with “could not connect to display”
    • Permission denied errors
    • OpenGL/GLX warnings
• Nix-based Development Environment
  • Setting Up the Nix Environment
  • Already have Nix setup
  • Activating the Nix Shell