siliconcompiler 0.31.1__tar.gz → 0.32.1__tar.gz

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/.readthedocs.yaml

@@ -24,9 +24,8 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
         - test
         - lint
+        - docs
         - profile
-        - examples
         - optimizer

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/Changes

@@ -8,6 +8,33 @@ The changes in each SiliconCompiler release version are described below. Commit
 version shown in (). Where applicable, the contributors that suggested a given
 feature are shown in [].
 
+SiliconCompiler 0.32.1 (2025-03-13)
+=========================================
+
+**Minor:**
+
+ * Added github specific url resolver for downloading artifacts from github.
+ * Added support to specify step and index for `sc-show` and `sc-dashboard`.
+
+
+SiliconCompiler 0.32.0 (2025-03-11)
+=========================================
+
+**Major:**
+
+ * Changed default behavior of `.summary` to only print metrics summary, and added `.snapshot` to generate and display job summary image.
+ * Moved default verilog/system verilog frontend parser to Slang.
+
+
+**Minor:**
+
+ * Changed examples to use a `requirements.txt` file for external dependencies.
+
+ * Tools:
+
+  * openroad: added timing histogram reports.
+
+
 SiliconCompiler 0.31.1 (2025-03-06)
 =========================================
 

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: siliconcompiler
-Version: 0.31.1
+Version: 0.32.1
 Summary: A compiler framework that automates translation from source code to silicon.
 Author-email: Andreas Olofsson <andreas.d.olofsson@gmail.com>
 License: Apache License 2.0
@@ -45,10 +45,10 @@ Requires-Dist: fasteners==0.19
 Requires-Dist: fastjsonschema==2.21.1
 Requires-Dist: docker==7.1.0
 Requires-Dist: importlib_metadata; python_version < "3.10"
-Requires-Dist: sc-surelog==1.84.1
 Requires-Dist: orjson==3.10.15
+Requires-Dist: pyslang==8.0.0
 Requires-Dist: streamlit==1.40.1; python_version <= "3.8"
-Requires-Dist: streamlit==1.42.2; python_version >= "3.9" and python_full_version != "3.9.7"
+Requires-Dist: streamlit==1.43.1; python_version >= "3.9" and python_full_version != "3.9.7"
 Requires-Dist: streamlit_agraph==0.0.45; python_full_version != "3.9.7"
 Requires-Dist: streamlit-antd-components==0.3.2; python_full_version != "3.9.7"
 Requires-Dist: streamlit_javascript==0.1.5; python_full_version != "3.9.7"
@@ -74,9 +74,6 @@ Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "docs"
 Requires-Dist: sc-leflib>=0.2.0; extra == "docs"
 Provides-Extra: profile
 Requires-Dist: gprof2dot==2024.6.6; extra == "profile"
-Provides-Extra: examples
-Requires-Dist: migen==0.9.2; extra == "examples"
-Requires-Dist: lambdalib==0.3.3; extra == "examples"
 Provides-Extra: optimizer
 Requires-Dist: google-vizier[jax]==0.1.21; python_version >= "3.10" and extra == "optimizer"
 

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/pyproject.toml

@@ -52,12 +52,12 @@ dependencies = [
     "fastjsonschema == 2.21.1",
     "docker == 7.1.0",
     "importlib_metadata; python_version < '3.10'",
-    "sc-surelog == 1.84.1",
     "orjson == 3.10.15",
+    "pyslang == 8.0.0",
 
     # dashboard, streamlit does not support 3.9.7
     "streamlit == 1.40.1; python_version <= '3.8'",
-    "streamlit == 1.42.2; python_version >= '3.9' and python_full_version != '3.9.7'",
+    "streamlit == 1.43.1; python_version >= '3.9' and python_full_version != '3.9.7'",
     "streamlit_agraph == 0.0.45; python_full_version != '3.9.7'",
     "streamlit-antd-components == 0.3.2; python_full_version != '3.9.7'",
     "streamlit_javascript == 0.1.5; python_full_version != '3.9.7'",
@@ -93,6 +93,7 @@ targets = "siliconcompiler.targets:get_targets"
 [project.entry-points."siliconcompiler.path_resolver"]
 https = "siliconcompiler.package.https:get_resolver"
 git = "siliconcompiler.package.git:get_resolver"
+github = "siliconcompiler.package.github:get_resolver"
 
 [project.entry-points."siliconcompiler.docs"]
 linkcode = "siliconcompiler.sphinx_ext:get_codeurl"
@@ -130,10 +131,6 @@ docs = [
 profile = [
     "gprof2dot == 2024.6.6"
 ]
-examples = [
-    "migen == 0.9.2",
-    "lambdalib == 0.3.3"
-]
 optimizer = [
     "google-vizier[jax] == 0.1.21; python_version >= '3.10'"
 ]
@@ -152,7 +149,6 @@ markers = [
     "eda: this test requires EDA tools installed to run. By default these tests will be run nightly, not on push.",
     "quick: always run this test on push, even if it requires EDA tools.",
     "nostrict: don't automatically set [option, strict] parameter for Chip objects in this test.",
-    "nolocal: don't use the local data for siliconcompiler_data.",
     "docker: test requires docker",
 ]
 testpaths = [

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/_metadata.py

@@ -1,5 +1,5 @@
 # Version number following semver standard.
-version = '0.31.1'
+version = '0.32.1'
 
 # Default server address for remote runs, if unspecified.
 default_server = 'https://server.siliconcompiler.com'

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/apps/_common.py

@@ -98,11 +98,28 @@ def pick_manifest(chip, src_file=None):
     if chip.get('option', 'jobname') not in all_manifests[chip.design]:
         jobname = list(all_manifests[chip.design].keys())[0]
 
+    step, index = chip.get('arg', 'step'), chip.get('arg', 'index')
+    if step and not index:
+        all_nodes = list(all_manifests[chip.design][jobname].keys())
+        try:
+            all_nodes.remove((None, None))
+        except ValueError:
+            pass
+        for found_step, found_index in sorted(all_nodes):
+            if found_step == step:
+                index = found_index
+        if index is None:
+            index = '0'
+    if step and index:
+        if (step, index) in all_manifests[chip.design][jobname]:
+            return all_manifests[chip.design][jobname][(step, index)]
+        else:
+            chip.logger.error(f'{step}{index} is not a valid node.')
+            return None
+
     if (None, None) in all_manifests[chip.design][jobname]:
-        manifest = all_manifests[chip.design][jobname][None, None]
-    else:
-        # pick newest manifest
-        manifest = list(sorted(all_manifests[chip.design][jobname].values(),
-                               key=lambda file: os.stat(file).st_ctime))[-1]
+        return all_manifests[chip.design][jobname][None, None]
 
-    return manifest
+    # pick newest manifest
+    return list(sorted(all_manifests[chip.design][jobname].values(),
+                       key=lambda file: os.stat(file).st_ctime))[-1]

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/apps/sc.py

@@ -99,6 +99,7 @@ def main():
 
         # Print Job Summary
         chip.summary()
+        chip.snapshot()
     except SiliconCompilerError:
         return 1
     except Exception as e:

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/apps/sc_dashboard.py

@@ -63,6 +63,8 @@ To include another chip object to compare to:
         if manifest:
             chip.logger.info(f'Loading manifest: {manifest}')
             chip.read_manifest(manifest)
+    else:
+        manifest = chip.get('option', 'cfg')
 
     # Error checking
     design = chip.get('design')
@@ -70,6 +72,10 @@ To include another chip object to compare to:
         chip.logger.error('Design not loaded')
         return 1
 
+    if not manifest:
+        chip.logger.error('Unable to determine job manifest')
+        return 2
+
     graph_chips = []
     if switches['graph_cfg']:
         for i, name_and_file_path in enumerate(switches['graph_cfg']):
@@ -86,7 +92,7 @@ To include another chip object to compare to:
                 raise ValueError(('graph_cfg accepts a max of 2 values, you supplied'
                                   f' {args} in "-graph_cfg {name_and_file_path}"'))
             if not os.path.isfile(file_path):
-                raise ValueError(f'not a valid file path : {file_path}')
+                raise ValueError(f'not a valid file path: {file_path}')
             graph_chip = siliconcompiler.core.Chip(design='')
             graph_chip.read_manifest(file_path)
             graph_chips.append({

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/apps/sc_show.py

@@ -111,6 +111,8 @@ def main():
         if manifest:
             chip.logger.info(f'Loading manifest: {manifest}')
             chip.read_manifest(manifest)
+    else:
+        manifest = chip.get('option', 'cfg')
 
     # Error checking
     design = chip.get('design')
@@ -120,6 +122,10 @@ def main():
                           '-cfg, -design, and/or inputs.')
         return 1
 
+    if not manifest:
+        chip.logger.error('Unable to determine job manifest')
+        return 2
+
     # Read in file
     if filename:
         chip.logger.info(f"Displaying {filename}")

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/apps/utils/summarize.py

@@ -37,7 +37,7 @@ def main():
         return 1
 
     # Print Job Summary
-    chip.summary(generate_image=False, generate_html=False)
+    chip.summary()
 
     return 0
 

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/core.py

@@ -26,7 +26,6 @@ from siliconcompiler import _metadata
 from siliconcompiler import NodeStatus, SiliconCompilerError
 from siliconcompiler.report import _show_summary_table
 from siliconcompiler.report import _generate_summary_image, _open_summary_image
-from siliconcompiler.report import _generate_html_report, _open_html_report
 from siliconcompiler.report import Dashboard
 from siliconcompiler import package as sc_package
 import glob
@@ -211,6 +210,8 @@ class Chip:
 
         self.logger.addHandler(file_handler)
 
+        return file_handler
+
     ###########################################################################
     def _init_logger(self, step=None, index=None, in_run=False):
 
@@ -2889,7 +2890,7 @@ class Chip:
         return self._dash
 
     ###########################################################################
-    def summary(self, show_all_indices=False, generate_image=True, generate_html=False):
+    def summary(self, show_all_indices=False):
         '''
         Prints a summary of the compilation manifest.
 
@@ -2902,13 +2903,6 @@ class Chip:
             show_all_indices (bool): If True, displays metrics for all indices
                 of each step. If False, displays metrics only for winning
                 indices.
-            generate_image (bool): If True, generates a summary image featuring
-                a layout screenshot and a subset of metrics. Requires that the
-                current job has an ending node that generated a PNG file.
-            generate_html (bool): If True, generates an HTML report featuring a
-                metrics summary table and manifest tree view. The report will
-                include a layout screenshot if the current job has an ending node
-                that generated a PNG file.
 
         Examples:
             >>> chip.summary()
@@ -2921,36 +2915,36 @@ class Chip:
 
         _show_summary_table(self, flow, nodes_to_execute, show_all_indices=show_all_indices)
 
-        # Create a report for the Chip object which can be viewed in a web browser.
-        # Place report files in the build's root directory.
-        work_dir = self.getworkdir()
-        if os.path.isdir(work_dir):
-            # Mark file paths where the reports can be found if they were generated.
-            results_img = os.path.join(work_dir, f'{self.design}.png')
-            results_html = os.path.join(work_dir, 'report.html')
-
-            for path in (results_img, results_html):
-                if os.path.exists(path):
-                    os.remove(path)
-
-            if generate_image:
-                _generate_summary_image(self, results_img)
-
-            if generate_html:
-                _generate_html_report(self, flow, nodes_to_execute, results_html)
-
-            # dashboard does not generate any data
-            self.logger.info(f'Dashboard at "sc-dashboard -cfg {work_dir}/{self.design}.pkg.json"')
-
-            # Try to open the results and layout only if '-nodisplay' is not set.
-            # Priority: PNG > HTML > dashboard.
-            if not self.get('option', 'nodisplay'):
-                if os.path.isfile(results_img):
-                    _open_summary_image(results_img)
-                elif os.path.isfile(results_html):
-                    _open_html_report(self, results_html)
-                else:
-                    self.dashboard(wait=False)
+        # dashboard does not generate any data
+        self.logger.info('Dashboard at "sc-dashboard '
+                         f'-cfg {self.getworkdir()}/{self.design}.pkg.json"')
+
+    ###########################################################################
+    def snapshot(self, path=None, display=True):
+        '''
+        Creates a snapshot image of the job
+
+        Args:
+            path (str): Path to generate the image at, if not provided will default to
+                <job>/<design>.png
+            display (bool): If True, will open the image for viewing. If :keypath:`option,nodisplay`
+                is True, this argument will be ignored.
+
+        Examples:
+            >>> chip.snapshot()
+            Creates a snapshot image in the default location
+        '''
+
+        if not path:
+            path = os.path.join(self.getworkdir(), f'{self.design}.png')
+
+        if os.path.exists(path):
+            os.remove(path)
+
+        _generate_summary_image(self, path)
+
+        if os.path.isfile(path) and not self.get('option', 'nodisplay') and display:
+            _open_summary_image(path)
 
     ###########################################################################
     def clock(self, pin, period, jitter=0, mode='global'):
@@ -3245,9 +3239,10 @@ class Chip:
             if sc_step and sc_index:
                 search_nodes.append((sc_step, sc_index))
             elif sc_step:
-                for check_step, check_index in nodes_to_execute(self, flow):
-                    if sc_step == check_step:
-                        search_nodes.append((check_step, check_index))
+                if flow is not None:
+                    for check_step, check_index in nodes_to_execute(self, flow):
+                        if sc_step == check_step:
+                            search_nodes.append((check_step, check_index))
             else:
                 if flow is not None:
                     for nodes in _get_flowgraph_execution_order(self,

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/flows/_common.py

@@ -1,4 +1,5 @@
 from siliconcompiler.tools.surelog import parse as surelog_parse
+from siliconcompiler.tools.slang import elaborate as slang_preprocess
 from siliconcompiler.tools.chisel import convert as chisel_convert
 from siliconcompiler.tools.bambu import convert as bambu_convert
 from siliconcompiler.tools.bluespec import convert as bluespec_convert
@@ -7,6 +8,8 @@ from siliconcompiler.tools.sv2v import convert as sv2v_convert
 
 from siliconcompiler.tools.builtin import concatenate
 
+from siliconcompiler.tools.slang import has_pyslang
+
 
 def _make_docs(chip):
     from siliconcompiler.targets import freepdk45_demo
@@ -20,9 +23,12 @@ def _make_docs(chip):
     chip.use(freepdk45_demo)
 
 
-def __get_frontends(allow_system_verilog):
+def __get_frontends(allow_system_verilog, use_surelog=False):
+    parser = surelog_parse
+    if not use_surelog and has_pyslang():
+        parser = slang_preprocess
     systemverilog_frontend = [
-        ('import.verilog', surelog_parse)
+        ('import.verilog', parser)
     ]
     if not allow_system_verilog:
         systemverilog_frontend.append(('import.convert', sv2v_convert))
@@ -36,7 +42,7 @@ def __get_frontends(allow_system_verilog):
     }
 
 
-def setup_multiple_frontends(flow, allow_system_verilog=False):
+def setup_multiple_frontends(flow, allow_system_verilog=False, use_surelog=False):
     '''
     Sets of multiple frontends if different frontends are required.
 
@@ -45,7 +51,7 @@ def setup_multiple_frontends(flow, allow_system_verilog=False):
 
     concat_nodes = []
     flowname = flow.design
-    for _, pipe in __get_frontends(allow_system_verilog).items():
+    for _, pipe in __get_frontends(allow_system_verilog, use_surelog=use_surelog).items():
         prev_step = None
         for step, task in pipe:
             flow.node(flowname, step, task)

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/fpgas/lattice_ice40.py

@@ -1,5 +1,4 @@
-import siliconcompiler
-from siliconcompiler.utils import register_sc_data_source
+from siliconcompiler import Chip, FPGA
 
 
 ####################################################
@@ -13,22 +12,13 @@ def setup():
     yosys + nextpnr
     '''
 
-    vendor = 'lattice'
-
-    lut_size = '4'
-
     all_fpgas = []
 
-    all_part_names = [
-        "ice40up5k-sg48",
-    ]
-
-    for part_name in all_part_names:
-        fpga = siliconcompiler.FPGA(part_name, package='siliconcompiler_data')
-        register_sc_data_source(fpga)
+    for part_name in ("ice40up5k-sg48",):
+        fpga = FPGA(part_name)
 
-        fpga.set('fpga', part_name, 'vendor', vendor)
-        fpga.set('fpga', part_name, 'lutsize', lut_size)
+        fpga.set('fpga', part_name, 'vendor', 'lattice')
+        fpga.set('fpga', part_name, 'lutsize', 4)
 
         all_fpgas.append(fpga)
 
@@ -37,5 +27,5 @@ def setup():
 
 #########################
 if __name__ == "__main__":
-    for fpga in setup(siliconcompiler.Chip('<fpga>')):
+    for fpga in setup(Chip('<fpga>')):
         fpga.write_manifest(f'{fpga.design}.json')

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/package/__init__.py

@@ -10,9 +10,6 @@ import functools
 import time
 from pathlib import Path
 
-from github import Github
-import github.Auth
-
 from siliconcompiler.utils import get_plugins
 
 
@@ -41,11 +38,11 @@ def get_download_cache_path(chip, package, ref):
         os.path.join(cache_path, f'{package}-{ref}.lock')
 
 
-def _file_path_resolver(chip, package, path, ref, url):
+def _file_path_resolver(chip, package, path, ref, url, fetch):
     return os.path.abspath(path.replace('file://', ''))
 
 
-def _python_path_resolver(chip, package, path, ref, url):
+def _python_path_resolver(chip, package, path, ref, url, fetch):
     return path_from_python(chip, url.netloc)
 
 
@@ -66,7 +63,7 @@ def _get_path_resolver(path):
     raise ValueError(f"{path} is not supported")
 
 
-def _path(chip, package):
+def _path(chip, package, fetch):
     # Initially try retrieving data source from schema
     data = {}
     data['path'] = chip.get('package', 'source', package, 'path')
@@ -84,22 +81,23 @@ def _path(chip, package):
 
     path_resolver, url = _get_path_resolver(data['path'])
 
-    return path_resolver(chip, package, data['path'], data['ref'], url)
+    return path_resolver(chip, package, data['path'], data['ref'], url, fetch)
 
 
-def path(chip, package):
+def path(chip, package, fetch=True):
     """
     Compute data source data path
     Additionally cache data source data if possible
     Parameters:
         package (str): Name of the data source
+        fetch (bool): Flag to indicate that the path should be fetched
     Returns:
         path: Location of data source on the local system
     """
 
     if package not in chip._packages:
         changed = False
-        data_path = _path(chip, package)
+        data_path = _path(chip, package, fetch)
 
         if isinstance(data_path, tuple) and len(data_path) == 2:
             data_path, changed = data_path
@@ -218,58 +216,6 @@ def register_python_data_source(chip,
                          ref=ref)
 
 
-def register_private_github_data_source(chip,
-                                        package_name,
-                                        repository,
-                                        release,
-                                        artifact):
-    gh = Github(auth=github.Auth.Token(__get_github_auth_token(package_name)))
-    repo = gh.get_repo(repository)
-
-    if not release:
-        release = repo.get_latest_release().tag_name
-
-    url = None
-    for repo_release in repo.get_releases():
-        if repo_release.tag_name == release:
-            for asset in repo_release.assets:
-                if asset.name == artifact:
-                    url = asset.url
-
-    if not url:
-        raise ValueError(f'Unable to find release asset: {repository}/{release}/{artifact}')
-
-    chip.register_source(
-        package_name,
-        path=url,
-        ref=release)
-
-
-def __get_github_auth_token(package_name):
-    token_name = package_name.upper()
-    for tok in ('#', '$', '&', '-', '=', '!', '/'):
-        token_name = token_name.replace(tok, '')
-
-    search_env = (
-        f'GITHUB_{token_name}_TOKEN',
-        'GITHUB_TOKEN',
-        'GIT_TOKEN'
-    )
-
-    token = None
-    for env in search_env:
-        token = os.environ.get(env, None)
-
-        if token:
-            break
-
-    if not token:
-        raise ValueError('Unable to determine authorization token for GitHub, '
-                         f'please set one of the following environmental variables: {search_env}')
-
-    return token
-
-
 @functools.lru_cache(maxsize=1)
 def __get_python_module_mapping():
     mapping = {}
@@ -297,3 +243,14 @@ def __get_python_module_mapping():
                 mapping.setdefault(module, []).append(dist_name)
 
     return mapping
+
+
+def register_private_github_data_source(chip,
+                                        package_name,
+                                        repository,
+                                        release,
+                                        artifact):
+    chip.register_source(
+        package_name,
+        path=f"github+private://{repository}/{release}/{artifact}",
+        ref=release)

{siliconcompiler-0.31.1 → siliconcompiler-0.32.1}/siliconcompiler/package/git.py

@@ -15,9 +15,12 @@ def get_resolver(url):
     return None
 
 
-def git_resolver(chip, package, path, ref, url):
+def git_resolver(chip, package, path, ref, url, fetch):
     data_path, data_path_lock = get_download_cache_path(chip, package, ref)
 
+    if not fetch:
+        return data_path, False
+
     # Acquire lock
     data_lock = InterProcessLock(data_path_lock)
     aquire_data_lock(data_path, data_lock)