Skip to main content

Design gallery for SiliconCompiler

Project description

General CI Lint

SiliconCompiler Design Gallery

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

Gallery

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 <cfg> -rules <rules> -check  # Check if run met the rule requirements.
python3 -m scgallery.rules -cfg <cfg> -rules <rules> -create  # Create an initial set of rules.
python3 -m scgallery.rules -cfg <cfg> -rules <rules> -update_all  # Update rules based on the run.
python3 -m scgallery.rules -cfg <cfg> -rules <rules> -tighten_passing  # Update passing rules based on the run.
python3 -m scgallery.rules -cfg <cfg> -rules <rules> -update_failing  # Update failing rules based on the run.

Contributing

To add a design:

  1. Create a folder with the design name (<design>) in scgallery/designs
  2. add source files to scgallery/designs/<design>/src
  3. add constraints to scgallery/designs/<design>/constraints (using the name of the library it is associated with)
  4. create scgallery/designs/<design>/<design>.py
  5. add the design to scgallery/designs/__init__.py

Issues / Bugs

We use GitHub Issues for tracking requests and bugs.

License

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sc_gallery-0.0.9.tar.gz (48.4 MB view hashes)

Uploaded Source

Built Distribution

sc_gallery-0.0.9-py3-none-any.whl (5.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page