siliconcompiler 0.35.0__tar.gz → 0.35.2__tar.gz

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/Changes

@@ -8,6 +8,41 @@ 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.35.2 (2025-10-28)
+=========================================
+
+**Minor:**
+
+ * Corrected `sc-issue` handling of libraries to properly include pdk information.
+ * Added `.find_task` to `Task` class to replace `get_task` and deprecated this method.
+ * Restored missing copy flags in schema to ensure proper upload to remote runners.
+ * Added tool version check to start of `.run()` to allow for early version checking when possible.
+ * `.check_filepaths` now checks dependency filepaths too.
+
+ * Tools:
+
+  * builtin: added tasks for filtering files between nodes and entry node to copy files into the build directory.
+  * gtkwave: added fst to supported file extensions.
+  * openroad: fixed screenshot task to allow for insertion into flows and handling of timing information.
+  * surfer: added fst to supported file extensions.
+  * verilator: fixed path used for automatic VCD dump.
+
+
+SiliconCompiler 0.35.1 (2025-10-17)
+=========================================
+
+**Minor:**
+
+ * Added support for providing external tool install scripts and groups to sc-install.
+ * Fixed installation order in `sc-install` to use lists instead of sets, preserving the intended group ordering.
+ * Fixed path handling to correctly resolve paths when dataroot starts with an environment variable.
+ * Updated task scheduling to more reliably honor the node order defined in the flowgraph.
+
+ * Tools:
+
+  * opensta: reimplemented task skipping logic for FPGA timing analysis.
+
+
 SiliconCompiler 0.35.0 (2025-10-08)
 =========================================
 

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: siliconcompiler
-Version: 0.35.0
+Version: 0.35.2
 Summary: A compiler framework that automates translation from source code to silicon.
 Author: Zero ASIC
 License: Apache License 2.0
@@ -24,7 +24,7 @@ Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp<3.13.0,>=3.10.11
+Requires-Dist: aiohttp<3.14.0,>=3.10.11
 Requires-Dist: distro<2.0.0,>=1.9.0
 Requires-Dist: docker<8.0.0,>=7.1.0
 Requires-Dist: fastjsonschema<2.22.0,>=2.20.0
@@ -37,7 +37,7 @@ Requires-Dist: PyYAML<7.0.0,>=6.0.0
 Requires-Dist: GitPython<3.2,>=3.1.44
 Requires-Dist: PyGithub<2.9.0,>=2.8.0
 Requires-Dist: urllib3>=1.26.0
-Requires-Dist: lambdapdk>=0.2.0
+Requires-Dist: lambdapdk>=0.2.1
 Requires-Dist: fasteners>=0.20
 Requires-Dist: pandas>=1.1.5
 Requires-Dist: psutil>=5.8.0
@@ -58,14 +58,13 @@ Requires-Dist: pytest-asyncio==1.2.0; extra == "test"
 Requires-Dist: pytest-cov==7.0.0; extra == "test"
 Requires-Dist: responses==0.25.8; extra == "test"
 Requires-Dist: PyVirtualDisplay==3.0; extra == "test"
-Requires-Dist: logiklib==0.1.0; extra == "test"
 Provides-Extra: lint
 Requires-Dist: flake8==7.3.0; extra == "lint"
 Requires-Dist: tclint==0.6.1; extra == "lint"
 Requires-Dist: codespell==2.4.1; extra == "lint"
 Provides-Extra: docs
-Requires-Dist: Sphinx==8.2.3; extra == "docs"
-Requires-Dist: pip-licenses==5.0.0; extra == "docs"
+Requires-Dist: Sphinx<8.3,>=7.4; extra == "docs"
+Requires-Dist: pip-licenses==5.5.0; extra == "docs"
 Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "docs"
 Requires-Dist: sc-leflib>=0.2.0; extra == "docs"
 Provides-Extra: optimizer

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
 ]
 requires-python = ">= 3.9"
 dependencies = [
-    "aiohttp >= 3.10.11, < 3.13.0",
+    "aiohttp >= 3.10.11, < 3.14.0",
     "distro >= 1.9.0, < 2.0.0",
     "docker >= 7.1.0, < 8.0.0",
     "fastjsonschema >= 2.20.0, < 2.22.0",
@@ -44,7 +44,7 @@ dependencies = [
     "PyGithub >= 2.8.0, < 2.9.0",
     "urllib3 >= 1.26.0", # Required for PyGithub
 
-    "lambdapdk >= 0.2.0",
+    "lambdapdk >= 0.2.1",
 
     "fasteners >= 0.20",
     "pandas >= 1.1.5",
@@ -87,9 +87,6 @@ smake = "siliconcompiler.apps.smake:main"
 [project.entry-points."siliconcompiler.showtask"]
 scsetup = "siliconcompiler.utils.showtools:showtasks"
 
-[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"
@@ -98,6 +95,10 @@ github = "siliconcompiler.package.github:get_resolver"
 [project.entry-points."siliconcompiler.docs"]
 linkcode = "siliconcompiler.schema.docs:get_codeurl"
 
+[project.entry-points."siliconcompiler.install"]
+groups = "siliconcompiler.apps.sc_install:get_install_groups"
+tools = "siliconcompiler.apps.sc_install:get_install_tools"
+
 [project.optional-dependencies]
 test = [
     "pytest == 8.4.2",
@@ -106,8 +107,7 @@ test = [
     "pytest-asyncio == 1.2.0",
     "pytest-cov == 7.0.0",
     "responses == 0.25.8",
-    "PyVirtualDisplay == 3.0",
-    "logiklib == 0.1.0"
+    "PyVirtualDisplay == 3.0"
 ]
 lint = [
     "flake8 == 7.3.0",
@@ -115,8 +115,8 @@ lint = [
     "codespell == 2.4.1"
 ]
 docs = [
-    "Sphinx == 8.2.3",
-    "pip-licenses == 5.0.0",
+    "Sphinx >= 7.4, <8.3",
+    "pip-licenses == 5.5.0",
     "pydata-sphinx-theme == 0.16.1",
     "sc-leflib >= 0.2.0"
 ]
@@ -148,7 +148,7 @@ pythonpath = [
 testpaths = [
     "tests"
 ]
-timeout = "240"
+timeout = "15"
 asyncio_default_fixture_loop_scope = "function"
 filterwarnings = [
     "ignore:pkg_resources is deprecated as an API:DeprecationWarning",

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/siliconcompiler/_metadata.py

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

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/siliconcompiler/apps/_common.py

@@ -90,7 +90,8 @@ def _get_manifests(cwd: str) -> Dict:
     return organized_manifest
 
 
-def pick_manifest_from_file(cliproject: Project, src_file: str, all_manifests: Dict):
+def pick_manifest_from_file(cliproject: Project, src_file: Optional[str], all_manifests: Dict) \
+        -> Optional[str]:
     """
     Tries to find a manifest located in the same directory as a given source file.
 
@@ -125,7 +126,7 @@ def pick_manifest_from_file(cliproject: Project, src_file: str, all_manifests: D
     return None
 
 
-def pick_manifest(cliproject: Project, src_file: Optional[str] = None):
+def pick_manifest(cliproject: Project, src_file: Optional[str] = None) -> Optional[str]:
     """
     Selects the most appropriate manifest based on the project's configuration.
 

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/siliconcompiler/apps/sc_dashboard.py

@@ -4,6 +4,8 @@ import shlex
 
 import os.path
 
+from typing import Union
+
 from siliconcompiler import Project
 from siliconcompiler.apps._common import pick_manifest
 from siliconcompiler.report.dashboard.web import WebDashboard
@@ -56,7 +58,7 @@ To include another project object to compare to:
             '-graph_cfg'],
         use_sources=False)
 
-    manifest = cli.get("cmdarg", "cfg")
+    manifest: Union[None, str] = cli.get("cmdarg", "cfg")
 
     # Attempt to load a manifest
     if not manifest:

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/siliconcompiler/apps/sc_install.py

@@ -8,12 +8,53 @@ import sys
 
 import os.path
 
+from typing import Dict, List, Optional, Set
+
 from collections.abc import Container
 from pathlib import Path
 
 import siliconcompiler
 
 from siliconcompiler.schema_support.record import RecordSchema
+from siliconcompiler.utils import get_plugins
+
+
+def get_install_groups() -> Dict[str, List[str]]:
+    """
+    Provide recommended install tool groups for common workflows.
+
+    Each mapping key is a high-level group name and each value is an ordered list of tool
+    identifiers suitable for that group.
+
+    Returns:
+        dict: Mapping from group name (str) to a list of tool identifiers (List[str]).
+    """
+    return {
+        "asic": ["sv2v", "yosys", "yosys-slang", "openroad", "klayout"],
+        "asic-hls": ["bambu", "yosys", "yosys-slang", "openroad", "klayout"],
+        "fpga": ["sv2v", "yosys", "yosys-slang", "wildebeest", "vpr", "opensta"],
+        "digital-simulation": ["verilator", "icarus", "surfer"],
+        "analog-simulation": ["xyce"]
+    }
+
+
+def get_install_tools(osname: str) -> Dict[str, str]:
+    tools_root = _get_tool_script_dir()
+
+    script_dir = None
+    if osname:
+        script_dir = tools_root / osname
+        if not script_dir.exists():
+            script_dir = None
+
+    tools = {}
+    if script_dir:
+        for script in glob.glob(str(script_dir / "install-*.sh")):
+            tool = re.match(r"install-(.*)\.sh", os.path.basename(script).lower())
+            if tool:
+                tools[tool.group(1)] = script
+
+    return tools
 
 
 class ChoiceOptional(Container):
@@ -29,18 +70,45 @@ class ChoiceOptional(Container):
         return item in self.__choices
 
     def __iter__(self):
+        """
+        Iterate over the stored choices.
+
+        Returns:
+            iterator: An iterator over the stored choice strings.
+        """
         return self.__choices.__iter__()
 
-    def get_items(self, choices):
+    def get_items(self, choices: List[str]) -> List[str]:
+        """
+        Return a sorted list of unique choice strings.
+
+        Parameters:
+            choices (List[str]): Iterable of choice strings which may contain duplicates.
+
+        Returns:
+            List[str]: Sorted list containing each unique choice from `choices`.
+        """
         items = set(choices)
         return sorted(items)
 
 
-def install_tool(tool, script, build_dir, prefix):
-    # Ensure build dir is available
-    build_dir = Path(build_dir) / tool
-    shutil.rmtree(str(build_dir), ignore_errors=True)
-    build_dir.mkdir(parents=True, exist_ok=True)
+def install_tool(tool: str, script: str, build_dir: str, prefix: str) -> bool:
+    """
+    Prepare a build directory, configure the environment, and execute an install script for a tool.
+
+    Parameters:
+        tool (str): Tool identifier used to create a per-tool build subdirectory under `build_dir`.
+        script (str): Path to the install script to execute.
+        build_dir (str): Base directory where a per-tool build directory will be created.
+        prefix (str): Installation prefix; added to PATH and used to determine whether
+                      sudo is required.
+
+    Returns:
+        bool: `True` if the install script exited with status 0, `False` otherwise.
+    """
+    build_path = Path(build_dir) / tool
+    shutil.rmtree(str(build_path), ignore_errors=True)
+    build_path.mkdir(parents=True, exist_ok=True)
 
     # setup environment
     env = os.environ.copy()
@@ -57,14 +125,22 @@ def install_tool(tool, script, build_dir, prefix):
         env["USE_SUDO_INSTALL"] = "yes"
 
     # run
-    ret = subprocess.call(script, env=env, cwd=build_dir)
+    ret = subprocess.call(script, env=env, cwd=build_path)
     if ret != 0:
         print(f"Error occurred while building/installing {tool}")
         return False
     return True
 
 
-def show_tool(tool, script):
+def show_tool(tool: str, script: str) -> None:
+    """
+    Print a bordered header, the contents of the given install script, and a
+    closing bordered footer.
+
+    Parameters:
+        tool (str): Tool identifier used in the printed header.
+        script (str): Path to the install script file whose contents will be displayed.
+    """
     def print_header(head):
         border_len = max(80, len(script) + 2)
         border = border_len*"#"
@@ -83,7 +159,19 @@ def show_tool(tool, script):
     print_header("end")
 
 
-def _get_os_name():
+def _get_os_name() -> Optional[str]:
+    """
+    Map recorded machine information to a short OS identifier used by the installer.
+
+    This inspects the machine information provided by RecordSchema and, for supported
+    Linux distributions, returns a compact identifier composed of the distro and
+    major version (for example, "ubuntu20" or "rhel8"). Returns None for
+    non-Linux systems or unrecognized distributions.
+
+    Returns:
+        os_name (Optional[str]): Mapped OS identifier (e.g., "ubuntu20", "rhel8") or
+        `None` if the OS cannot be mapped.
+    """
     machine_info = RecordSchema.get_machine_information()
     system = machine_info.get('system', "").lower()
     if system == 'linux':
@@ -103,7 +191,14 @@ def _get_os_name():
     return None
 
 
-def print_machine_info():
+def print_machine_info() -> None:
+    """
+    Prints detected machine and mapped OS information.
+
+    Prints the system name, distribution name, OS version, mapped OS identifier, and the path to
+    the install tools scripts directory as obtained from RecordSchema.get_machine_information()
+    and internal helpers.
+    """
     machine_info = RecordSchema.get_machine_information()
     mapped_os = _get_os_name()
 
@@ -114,7 +209,20 @@ def print_machine_info():
     print("Scripts:  ", _get_tool_script_dir())
 
 
-def __print_summary(successful, failed):
+def __print_summary(successful: Optional[Set[str]],
+                    failed: Optional[str],
+                    notstarted: Optional[Set[str]]) -> None:
+    """
+    Prints a fixed-width summary banner listing installed, failed, and pending tools.
+
+    Parameters:
+        successful (Optional[Set[str]]): Set of tool names that were installed; when provided,
+                                         they are shown under "Installed".
+        failed (Optional[str]): Name of a tool that failed to install; when provided, it is shown
+                                under "Failed to install".
+        notstarted (Optional[Set[str]]): Set of tool names that were not started or are pending;
+                                         when provided, they are shown under "Pending".
+    """
     max_len = 64
     print("#"*max_len)
     if successful:
@@ -124,40 +232,31 @@ def __print_summary(successful, failed):
     if failed:
         msg = f"Failed to install: {failed}"
         print(f"# {msg}")
-    print("#"*max_len)
 
+    if notstarted:
+        msg = f"Pending: {', '.join(sorted(notstarted))}"
+        print(f"# {msg}")
 
-def _get_tool_script_dir():
-    return Path(siliconcompiler.__file__).parent / "toolscripts"
+    print("#"*max_len)
 
 
-def _get_tools_list():
-    tools_root = _get_tool_script_dir()
+def _get_tool_script_dir() -> Path:
+    return Path(siliconcompiler.__file__).parent / "toolscripts"
 
-    script_dir = None
-    os_dir = _get_os_name()
-    if os_dir:
-        script_dir = tools_root / os_dir
-        if not script_dir.exists():
-            script_dir = None
 
+def _get_tools_list() -> Dict[str, str]:
     tools = {}
-    if script_dir:
-        for script in glob.glob(str(script_dir / "install-*.sh")):
-            tool = re.match(r"install-(.*)\.sh", os.path.basename(script).lower())
-            tools[tool.group(1)] = script
+    os = _get_os_name()
+    for plugin in get_plugins("install", name="tools"):
+        tools.update(plugin(os))
 
     return tools
 
 
-def _recommended_tool_groups(tools):
-    groups = {
-        "asic": {"sv2v", "yosys", "yosys-slang", "openroad", "klayout"},
-        "asic-hls": {"bambu", "yosys", "yosys-slang", "openroad", "klayout"},
-        "fpga": {"sv2v", "yosys", "yosys-slang", "vpr"},
-        "digital-simulation": {"verilator", "icarus", "surfer"},
-        "analog-simulation": {"xyce"}
-    }
+def _recommended_tool_groups(tools) -> Dict[str, List[str]]:
+    groups = {}
+    for plugin in get_plugins("install", name="groups"):
+        groups.update(plugin())
 
     filter_groups = {}
     for group, group_tools in groups.items():
@@ -174,7 +273,19 @@ class HelpFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescript
     pass
 
 
-def main():
+def main() -> int:
+    """
+    CLI entry point for installing tools, showing install scripts, or printing machine
+    debug information.
+
+    Parses command-line arguments, validates the host OS, expands tool groups, and either
+    displays install scripts (-show), prints machine info (-debug_machine), or runs install
+    scripts for the requested tools, then prints a summary and optional shell-path guidance.
+
+    Returns:
+        `0` on successful completion, `1` on failure (e.g., unsupported OS or
+        any tool installation failure).
+    """
     progname = "sc-install"
 
     tools = _get_tools_list()
@@ -286,13 +397,14 @@ Tool groups:
             show_tool(tool, tools[tool])
         else:
             if not install_tool(tool, tools[tool], args.build_dir, args.prefix):
-                __print_summary(tools_completed, tool)
+                notstarted = set(args.tool) - tools_completed - tools_handled
+                __print_summary(tools_completed, tool, notstarted)
                 return 1
             else:
                 tools_completed.add(tool)
 
     if not args.show:
-        __print_summary(tools_completed, None)
+        __print_summary(tools_completed, None, None)
 
         msgs = []
         for env, path in (

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/siliconcompiler/apps/sc_issue.py

@@ -5,6 +5,8 @@ import tarfile
 
 import os.path
 
+from typing import Optional
+
 from siliconcompiler import Project
 from siliconcompiler.scheduler import SchedulerNode
 from siliconcompiler.utils.issue import generate_testcase
@@ -42,18 +44,12 @@ To run a testcase, use:
                                            "generating the manifest")
             self._add_commandline_argument("file", "file",
                                            "filename for the generated testcase")
-            self._add_commandline_argument("add_pdk", "[str]",
-                                           "pdk to include in the testcase, if not provided all "
-                                           "libraries will be added according to the "
-                                           "-exclude_pdks flag")
             self._add_commandline_argument("add_library", "[str]",
                                            "library to include in the testcase, if not "
                                            "provided all libraries will be added according to "
                                            "the -exclude_libraries flag")
             self._add_commandline_argument("exclude_libraries", "bool",
                                            "flag to ensure libraries are excluded in the testcase")
-            self._add_commandline_argument("exclude_pdks", "bool",
-                                           "flag to ensure pdks are excluded in the testcase")
 
             # TODO port add dep func
             # self._add_commandline_argument("add_dep", "[str]",
@@ -65,10 +61,8 @@ To run a testcase, use:
                   '-run',
                   '-hash_files',
                   '-file',
-                  '-add_pdk',
                   '-add_library',
-                  '-exclude_libraries',
-                  '-exclude_pdks']
+                  '-exclude_libraries']
 
     issue = IssueProject.create_cmdline(
         progname,
@@ -76,15 +70,15 @@ To run a testcase, use:
         switchlist=switchlist)
 
     if not issue.get("cmdarg", "run"):
-        project = Project.from_manifest(filepath=issue.get("cmdarg", "cfg"))
+        project: Project = Project.from_manifest(filepath=issue.get("cmdarg", "cfg"))
 
         if issue.get("arg", "step"):
             project.set("arg", "step", issue.get("arg", "step"))
         if issue.get("arg", "index"):
             project.set("arg", "index", issue.get("arg", "index"))
 
-        step = project.get('arg', 'step')
-        index = project.get('arg', 'index')
+        step: Optional[str] = project.get('arg', 'step')
+        index: Optional[str] = project.get('arg', 'index')
         if not step:
             project.logger.error('Unable to determine step from manifest')
         if not index:
@@ -97,15 +91,13 @@ To run a testcase, use:
                           step,
                           index,
                           issue.get("cmdarg", "file"),
-                          include_pdks=not issue.get("cmdarg", "exclude_pdks"),
-                          include_specific_pdks=issue.get("cmdarg", "add_pdk"),
                           include_libraries=not issue.get("cmdarg", "exclude_libraries"),
                           include_specific_libraries=issue.get("cmdarg", "add_library"),
                           hash_files=issue.get("cmdarg", "hash_files"))
 
         return 0
     else:
-        file = issue.get("cmdarg", "file")
+        file: Optional[str] = issue.get("cmdarg", "file")
         if not file:
             raise ValueError('-file must be provided')
 
@@ -143,7 +135,7 @@ To run a testcase, use:
 
         project.set('arg', 'step', step)
         project.set('arg', 'index', index)
-        flow = project.get("option", 'flow')
+        flow = project.option.get_flow()
         tool = project.get("flowgraph", flow, step, index, "tool")
         task = project.get("flowgraph", flow, step, index, "task")
         taskmod = project.get("flowgraph", flow, step, index, "taskmodule")

{siliconcompiler-0.35.0 → siliconcompiler-0.35.2}/siliconcompiler/apps/smake.py

@@ -11,9 +11,15 @@ This allows for creating simple, self-documenting build or task scripts in
 Python without the need for complex boilerplate code.
 """
 import argparse
-import importlib
 import sys
+
+import importlib.util
 import os.path
+
+from typing import Union, Tuple, Optional, Dict
+
+from pathlib import Path
+
 from inspect import getmembers, isfunction, getfullargspec
 
 from siliconcompiler._metadata import version
@@ -23,7 +29,7 @@ from siliconcompiler.schema import utils
 __default_source_file = "make.py"
 
 
-def __process_file(path):
+def __process_file(path: Union[Path, str]) -> Tuple[Dict, Optional[str], Optional[str]]:
     """
     Dynamically loads a Python module and inspects it for runnable targets.
 
@@ -99,7 +105,7 @@ def __process_file(path):
     return args, default_arg, module_help
 
 
-def main(source_file=None):
+def main(source_file: Optional[Union[str, Path]] = None) -> int:
     """
     The main entry point for the smake command-line application.