siliconcompiler 0.31.0__tar.gz → 0.32.0__tar.gz

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/.readthedocs.yaml

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

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/Changes

@@ -8,6 +8,38 @@ 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.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)
+=========================================
+
+**Minor:**
+
+ * Fixed tcl manifest to correctly reflect the data types from the schema.
+ * Added end of install status message to `sc-install`.
+
+
+ * Tools:
+
+  * vpr: updated to v9.0 and added timing metrics extraction.
+
+
 SiliconCompiler 0.31.0 (2025-03-03)
 =========================================
 

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: siliconcompiler
-Version: 0.31.0
+Version: 0.32.0
 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"
 
@@ -99,19 +96,19 @@ SiliconCompiler is a modular hardware build system ("make for silicon"). The pro
 
 | Type | Supported|
 |------|----------|
-|**Design Languages**| C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec
+|**Design Languages**| C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec, [MLIR](https://en.wikipedia.org/wiki/MLIR_(software))
 |**Simulation Tools**| Verilator, Icarus, GHDL, Xyce
 |**Synthesis**| Yosys, Vivado, Synopsys, Cadence
-|**ASIC APR**| OpenRoad, 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, ihp130
+|**Layout Viewer**| Klayout, OpenROAD, Cadence, Synopsys
+|**DRC/LVS**| Klayout, Magic, Synopsys, Siemens
+|**PDKs**| sky130, ihp130, 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.
+Linux platforms. For working Python 3.8-3.13 environment, just use pip.
 
 ```sh
 python3 -m pip install --upgrade siliconcompiler
@@ -166,17 +163,15 @@ A. Olofsson, W. Ransohoff, N. Moroze, "[Invited: A Distributed Approach to Silic
 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}
+  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).
@@ -194,14 +189,14 @@ python3 -m pip install -e .[docs,test]  # Optional install step for generating d
 
 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.
+of the user guide. We have included shell setup scripts (Ubuntu) for most of the supported tools, which can be accessed via [sc-install](https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html#apps-sc-install-ref).
 See the [./siliconcompiler/toolscripts](./siliconcompiler/toolscripts) directory for a complete set of scripts and [./siliconcompiler/toolscripts/_tools.json](./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.](./CONTRIBUTING.md)
+[Contributing Guidelines](./CONTRIBUTING.md).
 
 # Issues / Bugs
 

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/README.md

@@ -17,19 +17,19 @@ SiliconCompiler is a modular hardware build system ("make for silicon"). The pro
 
 | Type | Supported|
 |------|----------|
-|**Design Languages**| C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec
+|**Design Languages**| C, Verilog, SV, VHDL, Chisel, Migen/Amaranth, Bluespec, [MLIR](https://en.wikipedia.org/wiki/MLIR_(software))
 |**Simulation Tools**| Verilator, Icarus, GHDL, Xyce
 |**Synthesis**| Yosys, Vivado, Synopsys, Cadence
-|**ASIC APR**| OpenRoad, 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, ihp130
+|**Layout Viewer**| Klayout, OpenROAD, Cadence, Synopsys
+|**DRC/LVS**| Klayout, Magic, Synopsys, Siemens
+|**PDKs**| sky130, ihp130, 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.
+Linux platforms. For working Python 3.8-3.13 environment, just use pip.
 
 ```sh
 python3 -m pip install --upgrade siliconcompiler
@@ -84,17 +84,15 @@ A. Olofsson, W. Ransohoff, N. Moroze, "[Invited: A Distributed Approach to Silic
 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}
+  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).
@@ -112,14 +110,14 @@ python3 -m pip install -e .[docs,test]  # Optional install step for generating d
 
 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.
+of the user guide. We have included shell setup scripts (Ubuntu) for most of the supported tools, which can be accessed via [sc-install](https://docs.siliconcompiler.com/en/latest/reference_manual/apps.html#apps-sc-install-ref).
 See the [./siliconcompiler/toolscripts](./siliconcompiler/toolscripts) directory for a complete set of scripts and [./siliconcompiler/toolscripts/_tools.json](./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.](./CONTRIBUTING.md)
+[Contributing Guidelines](./CONTRIBUTING.md).
 
 # Issues / Bugs
 

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/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'",
@@ -90,6 +90,10 @@ scsetup = "siliconcompiler.utils.showtools:setup"
 [project.entry-points."siliconcompiler.target"]
 targets = "siliconcompiler.targets:get_targets"
 
+[project.entry-points."siliconcompiler.path_resolver"]
+https = "siliconcompiler.package.https:get_resolver"
+git = "siliconcompiler.package.git:get_resolver"
+
 [project.entry-points."siliconcompiler.docs"]
 linkcode = "siliconcompiler.sphinx_ext:get_codeurl"
 targets = "siliconcompiler.sphinx_ext:targets"
@@ -126,10 +130,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'"
 ]

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/siliconcompiler/_metadata.py

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

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/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.0 → siliconcompiler-0.32.0}/siliconcompiler/apps/sc_install.py

@@ -101,6 +101,19 @@ def print_machine_info():
     print("Scripts:  ", _get_tool_script_dir())
 
 
+def __print_summary(successful, failed):
+    max_len = 64
+    print("#"*max_len)
+    if successful:
+        msg = f"Installed: {', '.join(sorted(successful))}"
+        print(f"# {msg}")
+
+    if failed:
+        msg = f"Failed to install: {failed}"
+        print(f"# {msg}")
+    print("#"*max_len)
+
+
 def _get_tool_script_dir():
     return Path(siliconcompiler.__file__).parent / "toolscripts"
 
@@ -242,6 +255,7 @@ To system debugging information (this should only be used to debug):
                 args.tool.extend(tool_groups[group])
 
     tools_handled = set()
+    tools_completed = set()
     for tool in args.tool:
         if tool in tools_handled:
             continue
@@ -250,9 +264,14 @@ To system debugging information (this should only be used to debug):
             show_tool(tool, tools[tool])
         else:
             if not install_tool(tool, tools[tool], args.build_dir, args.prefix):
+                __print_summary(tools_completed, tool)
                 return 1
+            else:
+                tools_completed.add(tool)
 
     if not args.show:
+        __print_summary(tools_completed, None)
+
         msgs = []
         for env, path in (
                 ("PATH", "bin"),
@@ -262,7 +281,6 @@ To system debugging information (this should only be used to debug):
                 os.path.expandvars(os.path.expanduser(p))
                 for p in os.getenv(env, "").split(":")
             ]
-            print(envs)
             if check_path not in envs:
                 msgs.extend([
                     "",

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/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.0 → siliconcompiler-0.32.0}/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'):

{siliconcompiler-0.31.0 → siliconcompiler-0.32.0}/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)