https://github.com/siliconcompiler/scgallery

SiliconCompiler Design Gallery
https://github.com/siliconcompiler/scgallery

Last synced: 2 months ago
JSON representation

SiliconCompiler Design Gallery

• Host: GitHub
• URL: https://github.com/siliconcompiler/scgallery
• Owner: siliconcompiler
• License: apache-2.0
• Created: 2023-06-10T18:00:21.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2026-01-14T13:02:04.000Z (5 months ago)
• Last Synced: 2026-01-14T17:22:43.318Z (5 months ago)
• Language: Verilog
• Homepage:
• Size: 685 MB
• Stars: 57
• Watchers: 4
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![General CI](https://github.com/siliconcompiler/scgallery/actions/workflows/general_ci.yml/badge.svg)](https://github.com/siliconcompiler/scgallery/actions/workflows/general_ci.yml)

[![Lint](https://github.com/siliconcompiler/scgallery/actions/workflows/lint.yml/badge.svg)](https://github.com/siliconcompiler/scgallery/actions/workflows/lint.yml)

[![codecov](https://codecov.io/github/siliconcompiler/scgallery/graph/badge.svg?token=8U7RP0A3K2)](https://codecov.io/github/siliconcompiler/scgallery)

# SiliconCompiler Design Gallery

Design gallery for [SiliconCompiler](https://github.com/siliconcompiler/siliconcompiler).

This library uses the rtl2gds flow in SiliconCompiler to compile the designs from RTL to a GDS file.

![Gallery](images/montage.jpg)

# To install:

Utilize the same python environment as SiliconCompiler.

    git clone https://github.com/siliconcompiler/scgallery.git

    cd scgallery

    python3 -m pip install .

# To run a design:

    sc-gallery -design sha512  # Will run on all supported targets

    sc-gallery -design sha512 -target asap7_demo  # Will only run on asap7

    sc-gallery -target asap7_demo  # Will run all designs supported on asap7

    sc-gallery  # Will run all designs on all targets

# Extending with proprietary design and technologies:

    sc-gallery -gallery private.gallery -design aes  # Will run on all supported targets in your private gallery

    sc-gallery -gallery private.gallery  # Will run all designs on all targets in your private gallery

# To check, create, and update rules:

    python3 -m scgallery.rules -cfg  -rules  -check  # Check if run met the rule requirements.

    python3 -m scgallery.rules -cfg  -rules  -create  # Create an initial set of rules.

    python3 -m scgallery.rules -cfg  -rules  -update_all  # Update rules based on the run.

    python3 -m scgallery.rules -cfg  -rules  -tighten_passing  # Update passing rules based on the run.

    python3 -m scgallery.rules -cfg  -rules  -update_failing  # Update failing rules based on the run.

# Contributing

## To add a design:

1. Create a folder with the design name (\) in scgallery/designs

2. add source files to scgallery/designs/\/src

3. add constraints to scgallery/designs/\/constraints (using the name of the library it is associated with)

4. create scgallery/designs/\/\.py

5. add the design to [scgallery/designs/\_\_init\_\_.py](scgallery/designs/__init__.py)

# Issues / Bugs

We use [GitHub Issues](https://github.com/siliconcompiler/scgallery/issues)

for tracking requests and bugs.

# License

[Apache License 2.0](LICENSE)