Skip to main content

SiliconCompiler

Python CI Tests Tools CI Tests Daily CI Tests Wheels Lint Documentation Status codecov Downloads

Introduction

SiliconCompiler is a modular hardware build system ("make for silicon"). The project philosophy is to "make the complex possible while keeping the simple simple".

Supported Technologies

Type Supported
Design Languages C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec, MLIR
Simulation Tools Verilator, Icarus, GHDL, Xyce
Synthesis Yosys, Vivado, Synopsys, Cadence
ASIC APR OpenROAD, Synopsys, Cadence
FPGA APR VPR, nextpnr, Vivado
Layout Viewer Klayout, OpenROAD, Cadence, Synopsys
DRC/LVS Klayout, Magic, Synopsys, Siemens
Open PDKs sky130, ihp130, gf180, asap7, freepdk45, gt2n, icsprout55, interposer — all shipped by lambdapdk
Foundry PDKs gf12lp, gf22fdx, intel16 — require a foundry agreement; package them yourself following the external library guide

Getting Started

SiliconCompiler is available as wheel packages on PyPI for macOS, Windows and Linux platforms. For working Python 3.10-3.14 environment, just use pip. On Windows, use Docker or remote execution — local tool flows are supported on Linux and macOS.

pip install --upgrade siliconcompiler

Converting RTL into DRC clean GDS takes 13 lines of simple Python code. (asicflow reports geometric violations from detailed routing as the drcs metric, and electrical ones — slew, capacitance, fanout, antenna — as drvs. Signoff DRC and LVS run in the separate signoffflow.)

from siliconcompiler import ASIC, Design               # import python package
from siliconcompiler.targets import skywater130_demo
design = Design("heartbeat")                           # create design object
design.set_topmodule("heartbeat", fileset="rtl")       # set top module
design.add_file("heartbeat.v", fileset="rtl")          # add input sources
design.add_file("heartbeat.sdc", fileset="sdc")        # add input sources
project = ASIC(design)                                 # create project
project.add_fileset(["rtl", "sdc"])                    # enable filesets
skywater130_demo(project)                              # load a pre-defined target
project.option.scheduler.set_name("docker")            # run the tools in containers
project.run()                                          # run compilation
project.summary()                                      # print summary
project.show()                                         # show layout

Not building an ASIC?

The example above is an ASIC build, but the same Design feeds every flow. The project class is what decides what happens to it:

Goal Class Tools needed Start here
Lint your RTL Lint none Lint your RTL
Simulate, or prove properties formally Sim Verilator, Icarus, GHDL or SymbiYosys Simulate and verify
Build an FPGA bitstream FPGA Yosys, plus VPR or nextpnr Build for an FPGA

Linting is the quickest way to see SiliconCompiler work: the default linter ships as a Python package, so it needs no EDA tools installed at all. For a complete FPGA build with no EDA tools installed locally, the demo runs in containers:

python3 -m siliconcompiler.demos.fpga_demo -scheduler docker

Why SiliconCompiler?

Documentation

New here? Start with the Quickstart guide, which walks through the example above line by line.

The SiliconCompiler reference manual and tutorials cover the rest.

License

Apache License 2.0

How to Cite

If you want to cite our work, please use the following paper:

A. Olofsson, W. Ransohoff, N. Moroze, "Invited: A Distributed Approach to Silicon Compilation", 59th Design Automation Conference (DAC), 10-14 July 2022, San Francisco, CA, USA. Published, 7/2022.

Bibtex:

@inproceedings{10.1145/3489517.3530673,
  author = {Olofsson, Andreas and Ransohoff, William and Moroze, Noah},
  title = {A Distributed Approach to Silicon Compilation: Invited},
  year = {2022},
  booktitle = {Proceedings of the 59th ACM/IEEE Design Automation Conference},
  pages = {1343–1346},
  location = {San Francisco, California}
}

Installation

Complete installation instructions are available in the Installation Guide.

To install the project from source (recommended for developers only).

git clone https://github.com/siliconcompiler/siliconcompiler
cd siliconcompiler
python3 -m venv .venv        # Setup virtual environment
source .venv/bin/activate
pip install --upgrade pip    # Update pip
pip install -e .             # Required install step
pip install -e .[test,lint]  # Optional install step for running tests and lint
pip install -e .[docs]       # Optional install step for generating docs

EDA Tool Installation

Installation instructions for all external tools can be found in the External Tools section of the user guide. We have included shell setup scripts (Ubuntu) for most of the supported tools, which can be accessed via sc-install. See the siliconcompiler/toolscripts directory for a complete set of scripts and siliconcompiler/toolscripts/_tools.json for the currently recommended tool versions.

Contributing

SiliconCompiler is an open-source project and welcomes contributions. To find out how to contribute to the project, see our Contributing Guidelines.

Getting help

Discussions is the best place to ask a question. The Help (Q&A) category is actively answered and is worth searching before you post — the answer to "how do I harden a macro", "how are filesets ordered" or "why won't this PDK build" is often already there.

Also useful:

We use GitHub Issues for tracking requests and bugs. If you hit a tool failure, sc-issue packages a runnable test case to attach.

More information

Resources Link
Website https://www.siliconcompiler.com
Documentation https://docs.siliconcompiler.com
Discussions https://github.com/siliconcompiler/siliconcompiler/discussions
Sources https://github.com/siliconcompiler/siliconcompiler
Issues https://github.com/siliconcompiler/siliconcompiler/issues
Open PDKs https://github.com/siliconcompiler/lambdapdk — every open PDK and standard cell library SiliconCompiler ships
Portable RTL libraries https://github.com/siliconcompiler/lambdalib — technology-independent blocks, including the pad ring

Metadata

Release files for siliconcompiler 0.38.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for siliconcompiler 0.38.12
File Size Uploaded Provenance Actions
siliconcompiler-0.38.12.tar.gz 4.1 MB With provenance Details for siliconcompiler-0.38.12.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for siliconcompiler 0.38.12
File Interpreter ABI Platform Actions
siliconcompiler-0.38.12-py3-none-any.whl Python 3 none any Details for siliconcompiler-0.38.12-py3-none-any.whl

Total release size: 8.8 MB

Release files / siliconcompiler-0.38.12.tar.gz

Download URL siliconcompiler-0.38.12.tar.gz
Size 4.1 MB
Tags Source
SHA-256 checksum
How to use checksums
7e6f73429864be845b319dc72cd2f79a3be5b1fef886f679399567fd6b69711f
BLAKE2b-256 checksum
How to use checksums
92003fceaff6b9905c589abca8cf4b7b75dc85c7499b526b09d2ba690bf0bede
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / siliconcompiler-0.38.12-py3-none-any.whl

Download URL siliconcompiler-0.38.12-py3-none-any.whl
Size 4.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
eedce6342ad3622accf9b753e4bb75f20a4a20b87a9a0351080a3b7ae5677a2a
BLAKE2b-256 checksum
How to use checksums
639507c0933529de6b2d2e2afc67fd4350209a093d3071872eaa4bceb6e9ad23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for siliconcompiler 0.38.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for siliconcompiler-0.38.12.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.38.12 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page