index.md

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

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

Quick Navigation

I want to...

• Get started with ChipCompiler → See main README
• Understand the architecture → Architecture
• Set up development environment → Development Guide
• Add new tools → Development Guide - Adding EDA Tools
• Debug workflows → Development Guide - Debugging

Additional Resources

• Main README