Welcome to SiliconCompiler’s documentation!

User Guide

• 1. Introduction
  • 1.1. Motivation
  • 1.2. Our Approach
  • 1.3. Authors
• 2. Installation
  • 2.1. Installing 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. Installing SiliconCompiler
    • 2.2.1. Install from pypi.org
    • 2.2.2. Offline Install (Linux only)
    • 2.2.3. Install from GitHub Repo (Linux/MacOS)
  • 2.3. External Tools
• 3. Quickstart guide
  • 3.1. Remote Run
    • 3.1.1. Public Cloud Access
    • 3.1.2. Remote Run Results
  • 3.2. Local Run
    • 3.2.1. View Design
  • 3.3. What Next?
• 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
  • 8.1. Configuring a Different Remote Server
    • 8.1.1. Public Server
    • 8.1.2. Private Server
  • 8.2. Troubleshooting
• 9. Tools
  • 9.1. setup(chip)
  • 9.2. parse_version(stdout)
  • 9.3. normalize_version(version)
  • 9.4. pre_process(chip)
  • 9.5. post_process(chip)
  • 9.6. runtime_options(chip)
  • 9.7. make_docs()
  • 9.8. run(chip)
  • 9.9. TCL interface
  • 9.10. Tool and Task Modules
• 10. PDKs
  • 10.1. setup(chip)
  • 10.2. make_docs()
  • 10.3. PDK Modules
• 11. Flows
  • 11.1. setup(chip)
  • 11.2. make_docs()
  • 11.3. Flow Modules
• 12. Targets
• 13. Metrics
• 14. Records
• 15. Libraries
  • 15.1. Library Modules
• 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. Contributing modules
• 2. Parallel Programming
• 3. Python-based frontends
• 4. Chisel frontend
• 5. C HLS frontend
• 6. Bluespec frontend
• 7. Building Your Own SoC
  • 7.1. Download PicoRV32 Verilog Code
  • 7.2. Build the PicoRV32 Core using SiliconCompiler
  • 7.3. Adding an SRAM block
  • 7.4. Extending your design
• 8. Slurm setup
  • 8.1. Initial Slurm Configuration
    • 8.1.1. User and Group Configuration
    • 8.1.2. Slurm Daemon Installation
    • 8.1.3. Slurm Configuration Files
    • 8.1.4. Slurm Startup
    • 8.1.5. Running SiliconCompiler on a Cluster

Reference Manual

• 1. Schema
  • 1.1. Keywords
  • 1.2. Parameter Fields
    • 1.2.1. arg
    • 1.2.2. asic
    • 1.2.3. checklist
    • 1.2.4. constraint
    • 1.2.5. datasheet
    • 1.2.6. design
    • 1.2.7. flowgraph
    • 1.2.8. fpga
    • 1.2.9. input
    • 1.2.10. metric
    • 1.2.11. option
    • 1.2.12. output
    • 1.2.13. package
    • 1.2.14. pdk
    • 1.2.15. record
    • 1.2.16. schemaversion
    • 1.2.17. tool
    • 1.2.18. unit
  • 1.3. Nested keypaths
    • 1.3.1. history
    • 1.3.2. library
• 2. Core API
  • Chip
    • Chip.add()
    • Chip.allkeys()
    • Chip.archive()
    • Chip.audit_manifest()
    • Chip.calc_area()
    • Chip.calc_dpw()
    • Chip.calc_yield()
    • Chip.check_checklist()
    • Chip.check_filepaths()
    • Chip.check_logfile()
    • Chip.check_manifest()
    • Chip.clock()
    • Chip.create_cmdline()
    • Chip.design
    • Chip.edge()
    • Chip.error()
    • Chip.find_files()
    • Chip.find_function()
    • Chip.find_result()
    • Chip.get()
    • Chip.getdict()
    • Chip.getkeys()
    • Chip.graph()
    • Chip.grep()
    • Chip.hash_files()
    • Chip.help()
    • Chip.input()
    • Chip.join()
    • Chip.list_steps()
    • Chip.load_target()
    • Chip.maximum()
    • Chip.minimum()
    • Chip.mux()
    • Chip.node()
    • Chip.nop()
    • Chip.output()
    • Chip.pipe()
    • Chip.read_file()
    • Chip.read_manifest()
    • Chip.run()
    • Chip.set()
    • Chip.show()
    • Chip.summary()
    • Chip.top()
    • Chip.unset()
    • Chip.update()
    • Chip.use()
    • Chip.valid()
    • Chip.verify()
    • Chip.write_depgraph()
    • Chip.write_flowgraph()
    • Chip.write_manifest()
  • SiliconCompilerError
  • Checklist
  • Flow
  • Library
  • PDK
• 3. Server API
  • 3.1. remote_run
  • 3.2. check_user
  • 3.3. delete_job
  • 3.4. get_results/{job_hash}.tar.gz
  • 3.5. check_progress
• 4. Leflib API
  • parse()
• 5. CLI apps
  • 5.1. sc
  • 5.2. sc-configure
  • 5.3. sc-ping
  • 5.4. sc-run
  • 5.5. sc-show
  • 5.6. sup
• 6. Flows directory
  • 6.1. asicflow
    • 6.1.1. Configuration
  • 6.2. asictopflow
    • 6.2.1. Configuration
  • 6.3. dvflow
    • 6.3.1. Configuration
  • 6.4. fpgaflow
    • 6.4.1. Configuration
  • 6.5. lintflow
    • 6.5.1. Configuration
  • 6.6. showflow
    • 6.6.1. Configuration
  • 6.7. signoffflow
    • 6.7.1. Configuration
• 7. Tools directory
  • 7.1. bambu
    • 7.1.1. import
  • 7.2. bluespec
    • 7.2.1. import
  • 7.3. chisel
    • 7.3.1. import
  • 7.4. genfasm
    • 7.4.1. bitstream
  • 7.5. ghdl
    • 7.5.1. import
  • 7.6. icarus
    • 7.6.1. compile
  • 7.7. icepack
    • 7.7.1. bitstream
  • 7.8. klayout
    • 7.8.1. export
    • 7.8.2. screenshot
    • 7.8.3. show
  • 7.9. magic
    • 7.9.1. drc
    • 7.9.2. extspice
  • 7.10. netgen
    • 7.10.1. lvs
  • 7.11. nextpnr
    • 7.11.1. apr
  • 7.12. openfpgaloader
  • 7.13. openroad
    • 7.13.1. cts
    • 7.13.2. dfm
    • 7.13.3. export
    • 7.13.4. floorplan
    • 7.13.5. physyn
    • 7.13.6. place
    • 7.13.7. route
    • 7.13.8. screenshot
    • 7.13.9. show
  • 7.14. surelog
    • 7.14.1. import
  • 7.15. sv2v
    • 7.15.1. convert
  • 7.16. verilator
    • 7.16.1. compile
    • 7.16.2. import
    • 7.16.3. lint
  • 7.17. vivado
  • 7.18. vpr
    • 7.18.1. apr
  • 7.19. xyce
  • 7.20. yosys
    • 7.20.1. lec
    • 7.20.2. syn_asic
    • 7.20.3. syn_fpga
• 8. PDK directory
  • 8.1. asap7
    • 8.1.1. Configuration
  • 8.2. freepdk45
    • 8.2.1. Configuration
  • 8.3. skywater130
    • 8.3.1. Configuration
• 9. Libraries directory
  • 9.1. asap7sc7p5t
    • 9.1.1. asap7sc7p5t_rvt
    • 9.1.2. asap7sc7p5t_lvt
    • 9.1.3. asap7sc7p5t_slvt
  • 9.2. nangate45
    • 9.2.1. nangate45
  • 9.3. sky130hd
    • 9.3.1. sky130hd
  • 9.4. sky130io
    • 9.4.1. sky130io
• 10. Targets directory
  • 10.1. asap7_demo
    • 10.1.1. Flows
    • 10.1.2. PDK
    • 10.1.3. Libraries
    • 10.1.4. Configuration
  • 10.2. asic_demo
    • 10.2.1. Flows
    • 10.2.2. PDK
    • 10.2.3. Libraries
    • 10.2.4. Checklists
    • 10.2.5. Configuration
  • 10.3. fpgaflow_demo
    • 10.3.1. Flows
    • 10.3.2. Configuration
  • 10.4. freepdk45_demo
    • 10.4.1. Flows
    • 10.4.2. PDK
    • 10.4.3. Libraries
    • 10.4.4. Configuration
  • 10.5. skywater130_demo
    • 10.5.1. Flows
    • 10.5.2. PDK
    • 10.5.3. Libraries
    • 10.5.4. Checklists
    • 10.5.5. Configuration
• 11. Checklists directory
  • 11.1. oh_tapeout
    • 11.1.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