Skip to content

index.md

Latest commit

 

History

History
54 lines (38 loc) · 2.03 KB

index.md

File metadata and controls

54 lines (38 loc) · 2.03 KB
Raw

ChipCompiler Documentation

Welcome to the ChipCompiler documentation center.

Core Documentation

  • Architecture - Detailed system architecture and design patterns

    • Layered architecture explanation
    • Core design patterns
    • Data flow and execution paths
    • Module details

  • Development Guide - Development environment setup and workflows

    • Environment configuration
    • Code quality tools
    • Adding new EDA tools
    • Debugging and testing

  • Workspace CLI Guide - Legacy runtime workspace command usage

    • Creating workspaces with PDK, top module, and RTL inputs
    • Loading, running, rerunning, and inspecting old-style workspaces
    • JSON input/output contract and common errors

Technical Specifications

File Format Specifications

ChipCompiler supports various EDA file formats. Technical specifications for parser implementations:

  • Filelist Grammar - EBNF grammar for EDA tool filelists
    • Supports file paths, +incdir directives, comments, quoted paths
    • Parser implementation: chipcompiler/utility/filelist.py

CLI Specifications

  • CLI Design - Progressive-disclosure CLI design and roadmap
    • Grep-friendly summary lines with disclosure commands
    • Project, run, step, metric, artifact, issue, and config object model
    • Phased roadmap for project setup, debug, traceability, and exploration

Quick Navigation

I want to...

Additional Resources