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.2.1. Offline Install (Linux only)
  • 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. Package Management
• 10. Tools
  • 10.1. setup(chip)
  • 10.2. parse_version(stdout)
  • 10.3. normalize_version(version)
  • 10.4. pre_process(chip)
  • 10.5. post_process(chip)
  • 10.6. runtime_options(chip)
  • 10.7. make_docs()
  • 10.8. run(chip)
  • 10.9. TCL interface
• 11. PDKs
  • 11.1. setup(chip)
  • 11.2. make_docs()
• 12. Flows
  • 12.1. setup(chip)
  • 12.2. make_docs()
• 13. Targets
• 14. Metrics
• 15. Records
• 16. Libraries
  • 16.1. Library Modules
• 17. Packages
• 18. FAQ
  • 18.1. How do I…
• 19. Licenses
  • 19.1. Software License
  • 19.2. Documentation License
  • 19.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. arg
    • 1.3.2. asic
    • 1.3.3. checklist
    • 1.3.4. constraint
    • 1.3.5. datasheet
    • 1.3.6. design
    • 1.3.7. flowgraph
    • 1.3.8. fpga
    • 1.3.9. input
    • 1.3.10. metric
    • 1.3.11. model
    • 1.3.12. option
    • 1.3.13. output
    • 1.3.14. package
    • 1.3.15. pdk
    • 1.3.16. record
    • 1.3.17. schemaversion
    • 1.3.18. tool
    • 1.3.19. unit
  • 1.4. Nested keypaths
    • 1.4.1. history
    • 1.4.2. library
• 2. Core API
  • Chip
    • Chip.add()
    • 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.import_library()
    • Chip.join()
    • Chip.list_metrics()
    • Chip.list_steps()
    • Chip.load_checklist()
    • Chip.load_flow()
    • Chip.load_lib()
    • Chip.load_pdk()
    • Chip.load_target()
    • Chip.maximum()
    • Chip.merge_manifest()
    • Chip.minimum()
    • Chip.mux()
    • Chip.node()
    • Chip.nop()
    • Chip.pipe()
    • Chip.read_file()
    • Chip.read_lef()
    • Chip.read_manifest()
    • Chip.record_history()
    • Chip.run()
    • Chip.set()
    • Chip.show()
    • Chip.summary()
    • Chip.top()
    • Chip.update()
    • Chip.valid()
    • Chip.verify()
    • Chip.write_depgraph()
    • Chip.write_flowgraph()
    • Chip.write_manifest()
  • SiliconCompilerError
• 3. Sup API
  • Sup
    • Sup.check()
    • Sup.clear()
    • Sup.info()
    • Sup.install()
    • Sup.publish()
    • Sup.search()
    • Sup.uninstall()
• 4. Server API
  • 4.1. remote_run
  • 4.2. check_user
  • 4.3. delete_job
  • 4.4. get_results/{job_hash}.tar.gz
  • 4.5. check_progress
• 5. Floorplan API
  • Floorplan
    • Floorplan.available_cells
    • Floorplan.diearea
    • Floorplan.layers
    • Floorplan.stdcell_width
    • Floorplan.stdcell_height
    • Floorplan.add_net()
    • Floorplan.add_via()
    • Floorplan.create_diearea()
    • Floorplan.fill_io_region()
    • Floorplan.generate_rows()
    • Floorplan.generate_tracks()
    • Floorplan.get_layers()
    • Floorplan.insert_vias()
    • Floorplan.place_blockage()
    • Floorplan.place_macros()
    • Floorplan.place_obstruction()
    • Floorplan.place_pins()
    • Floorplan.place_ring()
    • Floorplan.place_vias()
    • Floorplan.place_wires()
    • Floorplan.snap()
    • Floorplan.snap_to_x_track()
    • Floorplan.snap_to_y_track()
    • Floorplan.write_def()
    • Floorplan.write_lef()
  • render_tuple()
• 6. Leflib API
  • parse()
• 7. CLI apps
  • 7.1. sc-env
  • 7.2. sc-ping
  • 7.3. sc-run
  • 7.4. sc-show
  • 7.5. sup
• 8. Flows directory
  • 8.1. asicflow
    • 8.1.1. Configuration
  • 8.2. asictopflow
    • 8.2.1. Configuration
  • 8.3. dvflow
    • 8.3.1. Configuration
  • 8.4. fpgaflow
    • 8.4.1. Configuration
  • 8.5. lintflow
    • 8.5.1. Configuration
  • 8.6. signoffflow
    • 8.6.1. Configuration
• 9. Tools directory
  • 9.1. bambu
  • 9.2. bluespec
  • 9.3. chisel
  • 9.4. genfasm
  • 9.5. ghdl
  • 9.6. icarus
  • 9.7. icepack
  • 9.8. klayout
  • 9.9. magic
  • 9.10. netgen
  • 9.11. nextpnr
  • 9.12. openfpgaloader
  • 9.13. openroad
  • 9.14. surelog
  • 9.15. sv2v
  • 9.16. template
  • 9.17. verilator
    • 9.17.1. Steps supported
  • 9.18. vivado
  • 9.19. vpr
  • 9.20. xyce
  • 9.21. yosys
• 10. PDK directory
  • 10.1. asap7
    • 10.1.1. Configuration
  • 10.2. freepdk45
    • 10.2.1. Configuration
  • 10.3. skywater130
    • 10.3.1. Configuration
• 11. Libraries directory
  • 11.1. asap7sc7p5t
    • 11.1.1. asap7sc7p5t_rvt
    • 11.1.2. asap7sc7p5t_lvt
    • 11.1.3. asap7sc7p5t_slvt
  • 11.2. nangate45
    • 11.2.1. nangate45
  • 11.3. sky130hd
    • 11.3.1. sky130hd
  • 11.4. sky130io
    • 11.4.1. sky130io
• 12. Targets directory
  • 12.1. asap7_demo
    • 12.1.1. Flows
    • 12.1.2. PDK
    • 12.1.3. Libraries
    • 12.1.4. Configuration
  • 12.2. fpgaflow_demo
    • 12.2.1. Flows
    • 12.2.2. Configuration
  • 12.3. freepdk45_demo
    • 12.3.1. Flows
    • 12.3.2. PDK
    • 12.3.3. Libraries
    • 12.3.4. Configuration
  • 12.4. skywater130_demo
    • 12.4.1. Flows
    • 12.4.2. PDK
    • 12.4.3. Libraries
    • 12.4.4. 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