Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siliconcompiler/siliconcompiler
A modular build system for hardware
https://github.com/siliconcompiler/siliconcompiler
Last synced: 3 months ago
JSON representation
A modular build system for hardware
- Host: GitHub
- URL: https://github.com/siliconcompiler/siliconcompiler
- Owner: siliconcompiler
- License: apache-2.0
- Created: 2020-12-10T21:52:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-12T00:09:01.000Z (6 months ago)
- Last Synced: 2024-05-12T00:15:36.135Z (6 months ago)
- Language: Python
- Homepage: https://docs.siliconcompiler.com/en/latest/
- Size: 331 MB
- Stars: 774
- Watchers: 23
- Forks: 82
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-opensource-hardware - siliconcompiler
README
[](https://github.com/siliconcompiler/siliconcompiler/actions/workflows/python_ci.yml)
[](https://github.com/siliconcompiler/siliconcompiler/actions/workflows/tools_ci.yml)
[](https://github.com/siliconcompiler/siliconcompiler/actions/workflows/daily_ci.yml)
[](https://github.com/siliconcompiler/siliconcompiler/actions/workflows/wheels.yml)
[](https://github.com/siliconcompiler/siliconcompiler/actions/workflows/lint.yml)
[](https://docs.siliconcompiler.com/en/latest/?badge=latest)
[](https://codecov.io/github/siliconcompiler/siliconcompiler)
[](https://pepy.tech/project/siliconcompiler)
# 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
|**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**| Magic, Synopsys, Siemens
|**PDKs**| sky130, gf180, asap7, freepdk45, gf12lp, gf22fdx, intel16
# Getting Started
SiliconCompiler is available as wheel packages on PyPI for macOS, Windows and
Linux platforms. For working Python 3.8-3.12 environment, just use pip.
```sh
python -m pip install --upgrade siliconcompiler
```
Converting RTL into DRC clean GDS takes less than 10 lines of simple Python code.
```python
import siliconcompiler # import python package
chip = siliconcompiler.Chip('heartbeat') # create chip object
chip.load_target('skywater130_demo') # load a pre-defined target
chip.input('heartbeat.v') # set input sources
chip.clock('clk', period=10) # set constraints
chip.set('option','remote', True) # enable remote execution
chip.run() # run compilation
chip.summary() # print summary
chip.show() # show layout
```
Simple designs can be compiled in a single line using the built in command line 'sc' app:
```sh
sc -remote -target "asic_demo"
```
# Why SiliconCompiler?
* **Ease-of-use**: Programmable with a simple [Python API](https://docs.siliconcompiler.com/en/stable/reference_manual/core_api.html)
* **Portability:** Powerful dynamic JSON [schema](https://docs.siliconcompiler.com/en/stable/reference_manual/schema.html) supports ASIC and FPGA design and simulation
* **Speed:** Flowgraph [execution model](https://docs.siliconcompiler.com/en/stable/user_guide/execution_model.html) enables cloud scale execution.
* **Friction-less:** [Remote execution model](https://docs.siliconcompiler.com/en/stable/development_guide/remote_processing.html) enables "zero install" compilation
* **Modularity:** [Tool abstraction layer](https://docs.siliconcompiler.com/en/latest/development_guide/tools.html) makes it easy to add/port new tools to the project.
* **Provenance:** [Compilation manifests](https://docs.siliconcompiler.com/en/stable/user_guide/data_model.html) created automatically during execution.
* **Documented:** An extensive set of auto-generated high quality [reference documents](https://docs.siliconcompiler.com/).
* **In-use:** Actively used by Zero ASIC for commercial tapeouts at advanced process nodes.
# Documentation
The full reference manual and tutorials can be found [HERE](https://docs.siliconcompiler.com/).
# License
[Apache License 2.0](LICENSE)
# 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](docs/papers/sc_dac2022.pdf)", 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](https://docs.siliconcompiler.com/en/stable/user_guide/installation.html).
To install the project from source (recommended for developers only).
```bash
git clone https://github.com/siliconcompiler/siliconcompiler
cd siliconcompiler
python -m pip install -e . # Required install step
python -m pip install -e .[docs,test] # Optional install step for generating docs and running tests
```
# EDA Tool Installation
Installation instructions for all external tools can be found in the
[External Tools](https://docs.siliconcompiler.com/en/stable/user_guide/installation.html#external-tools) section
of the user guide. We have included shell setup scripts (Ubuntu) for most of the supported tools.
See the [./setup](./setup) directory for a complete set of scripts and [./setup/_tools.json](./setup/_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.](./CONTRIBUTING.md)
# Issues / Bugs
We use [GitHub Issues](https://github.com/siliconcompiler/siliconcompiler/issues)
for tracking requests and bugs.
# More information
| Resources | Link|
|-----------|-----|
| **Website**| https://www.siliconcompiler.com
| **Documentation**| https://docs.siliconcompiler.com
| **Sources**| https://github.com/siliconcompiler/siliconcompiler
| **Issues**| https://github.com/siliconcompiler/siliconcompiler/issues
| **RFCs**| https://github.com/siliconcompiler/rfcs
| **Discussion**| https://github.com/siliconcompiler/siliconcompiler/discussions