Welcome to SiliconCompiler’s documentation!

User Guide

• 1. Introduction
  • 1.1. Motivation
  • 1.2. Our Approach
  • 1.3. Authors
• 2. Installation
  • 2.1. Python
    • 2.1.1. Ubuntu (>=18.04)
    • 2.1.2. RHEL (>=RHEL 7)
    • 2.1.3. macOS (>=10.15)
    • 2.1.4. Windows (>= Windows 10)
  • 2.2. SiliconCompiler
  • 2.3. Cloud Access
  • 2.4. Layout Viewer
  • 2.5. External Tools
• 3. Quickstart guide
  • 3.1. Design
  • 3.2. Setup
  • 3.3. Compilation
  • 3.4. View layout
• 4. Glossary
• 5. Data model
• 6. Programming model
  • 6.1. Object Creation
  • 6.2. Setup
  • 6.3. Run
  • 6.4. Inspection
• 7. Execution model
• 8. Remote processing
• 9. Tools
  • 9.1. setup_tool(chip)
  • 9.2. parse_version(stdout)
  • 9.3. pre_process(chip)
  • 9.4. post_process(chip)
  • 9.5. runtime_options(chip)
  • 9.6. make_docs()
  • 9.7. TCL interface
• 10. PDKs
  • 10.1. setup_pdk(chip)
  • 10.2. make_docs()
• 11. Flows
  • 11.1. setup_flow(chip)
  • 11.2. make_docs()
• 12. Targets
• 13. Metrics
• 14. Records
• 15. Libraries
• 16. Packages
• 17. FAQ
  • 17.1. How do I…
• 18. Licenses
  • 18.1. Software License
  • 18.2. Documentation License
  • 18.3. Dependency Licenses

Tutorials

• 1. Floorplanning
  • 1.1. Floorplanning methodology
  • 1.2. Getting Started
  • 1.3. Minimal chip configuration
  • 1.4. Chip dimensions
  • 1.5. Specifying die area
  • 1.6. Placing RAM
  • 1.7. Placing Pins
  • 1.8. PDN
  • 1.9. Top-level padring
  • 1.10. Building ZeroSoC
• 2. Contributing targets
• 3. Parallel Programming
• 4. Slurm setup
  • 4.1. Initial Slurm Configuration
    • 4.1.1. User and Group Configuration
    • 4.1.2. Slurm Daemon Installation
    • 4.1.3. Slurm Configuration Files
    • 4.1.4. Slurm Startup
    • 4.1.5. Running SiliconCompiler on a Cluster
    • 4.1.6. Troubleshooting
• 5. Python-based frontends
• 6. Chisel frontend
• 7. C HLS frontend
• 8. Bluespec frontend

Reference Manual

• 1. Schema
  • 1.1. Keywords
  • 1.2. Parameter Fields
  • 1.3. Parameters
    • 1.3.1. root
    • 1.3.2. arg
    • 1.3.3. asic
    • 1.3.4. checklist
    • 1.3.5. clock
    • 1.3.6. eda
    • 1.3.7. flowgraph
    • 1.3.8. flowstatus
    • 1.3.9. fpga
    • 1.3.10. library
    • 1.3.11. mcmm
    • 1.3.12. metric
    • 1.3.13. package
    • 1.3.14. pdk
    • 1.3.15. read
    • 1.3.16. record
    • 1.3.17. supply
    • 1.3.18. version
• 2. Core API
• 3. Server API
  • 3.1. remote_run
  • 3.2. check_user
  • 3.3. get_results/{job_hash}.tar.gz
  • 3.4. check_progress
  • 3.5. delete_job
• 4. Floorplan API
• 5. Leflib API
• 6. CLI apps
  • 6.1. sc-env
  • 6.2. sc-ping
  • 6.3. sc-run
  • 6.4. sc-show
• 7. Flows directory
  • 7.1. asicflow
    • 7.1.1. Configuration
  • 7.2. dvflow
    • 7.2.1. Configuration
  • 7.3. fpgaflow
    • 7.3.1. Configuration
• 8. Tools directory
  • 8.1. bambu
  • 8.2. bluespec
  • 8.3. chisel
  • 8.4. ghdl
  • 8.5. icarus
  • 8.6. icepack
  • 8.7. klayout
  • 8.8. magic
  • 8.9. netgen
  • 8.10. nextpnr
  • 8.11. openfpga
  • 8.12. openfpgaloader
  • 8.13. openroad
  • 8.14. surelog
  • 8.15. sv2v
  • 8.16. template
  • 8.17. verilator
  • 8.18. vivado
  • 8.19. vpr
  • 8.20. xyce
  • 8.21. yosys
• 9. PDK directory
  • 9.1. asap7
    • 9.1.1. Configuration
  • 9.2. freepdk45
    • 9.2.1. Configuration
  • 9.3. skywater130
    • 9.3.1. Configuration

Resources

• 1. Design Glossary
  • 1.1. Architecture
  • 1.2. Design
  • 1.3. Manufacturing
  • 1.4. Packaging
  • 1.5. Test

Indices and tables

• Index

• Module Index

• Search Page