siliconcompiler 0.29.4__py3-none-any.whl → 0.31.0__py3-none-any.whl

siliconcompiler/_metadata.py

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

siliconcompiler/apps/sc.py

@@ -95,7 +95,7 @@ def main():
 
     try:
         # Run flow
-        chip.run()
+        chip.run(raise_exception=True)
 
         # Print Job Summary
         chip.summary()

siliconcompiler/apps/sc_install.py

@@ -17,7 +17,7 @@ class ChoiceOptional(Container):
     def __init__(self, choices):
         super().__init__()
 
-        self.__choices = set(choices)
+        self.__choices = sorted(set(choices))
 
     def __contains__(self, item):
         if not item:
@@ -30,7 +30,7 @@ class ChoiceOptional(Container):
 
     def get_items(self, choices):
         items = set(choices)
-        return sorted(list(items))
+        return sorted(items)
 
 
 def install_tool(tool, script, build_dir, prefix):
@@ -143,6 +143,10 @@ def _recommended_tool_groups(tools):
     return filter_groups
 
 
+class HelpFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter):
+    pass
+
+
 def main():
     progname = "sc-install"
     description = """
@@ -174,7 +178,7 @@ To system debugging information (this should only be used to debug):
     parser = argparse.ArgumentParser(
         prog=progname,
         description=description,
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+        formatter_class=HelpFormatter)
 
     tools = _get_tools_list()
 
@@ -248,6 +252,34 @@ To system debugging information (this should only be used to debug):
             if not install_tool(tool, tools[tool], args.build_dir, args.prefix):
                 return 1
 
+    if not args.show:
+        msgs = []
+        for env, path in (
+                ("PATH", "bin"),
+                ("LD_LIBRARY_PATH", "lib")):
+            check_path = os.path.join(args.prefix, path)
+            envs = [
+                os.path.expandvars(os.path.expanduser(p))
+                for p in os.getenv(env, "").split(":")
+            ]
+            print(envs)
+            if check_path not in envs:
+                msgs.extend([
+                    "",
+                    f"{check_path} not found in {env}",
+                    "you may need to add it the following your shell",
+                    "initialization script:",
+                    f'export {env}="{check_path}:${env}"'
+                ])
+        if msgs:
+            center_len = max(len(msg) for msg in msgs)
+            max_len = center_len + 4
+            print("#"*max_len)
+            for msg in msgs:
+                print(f"# {msg:<{center_len}} #")
+            print(f"# {' '*center_len} #")
+            print("#"*max_len)
+
     return 0
 
 

siliconcompiler/apps/sc_remote.py

@@ -1,5 +1,4 @@
 # Copyright 2023 Silicon Compiler Authors. All Rights Reserved.
-import copy
 import os
 import sys
 
@@ -157,7 +156,6 @@ To delete a job, use:
     # in its "check_progress/ until job is done" loop.
     elif args['reconnect']:
         # Start from successors of entry nodes, so entry nodes are not fetched from remote.
-        environment = copy.deepcopy(os.environ)
         flow = chip.get('option', 'flow')
         entry_nodes = _get_flowgraph_entry_nodes(chip, flow)
         for entry_node in entry_nodes:
@@ -177,7 +175,7 @@ To delete a job, use:
                                     f'{chip.design}.pkg.json')
             if os.path.exists(manifest):
                 chip.schema.read_journal(manifest)
-        _finalize_run(chip, environment)
+        _finalize_run(chip)
 
         # Summarize the run.
         chip.summary()

siliconcompiler/core.py

@@ -67,7 +67,7 @@ class Chip:
         except FileNotFoundError:
             raise SiliconCompilerError(
                 "SiliconCompiler must be run from a directory that exists. "
-                "If you are sure that your working directory is valid, try running `cd $(pwd)`.""")
+                "If you are sure that your working directory is valid, try running `cd $(pwd)`.")
 
         # Initialize custom error handling for codecs. This has to be called
         # by each spawned (as opposed to forked) subprocess
@@ -392,7 +392,7 @@ class Chip:
                 for vals, step, index in self.schema._getvals(*key):
                     if not vals:
                         continue
-                    if self.get(*key, field='pernode') != 'never':
+                    if not self.get(*key, field='pernode').is_never():
                         if step is None:
                             step = Schema.GLOBAL_KEY
                         if index is None:
@@ -852,7 +852,7 @@ class Chip:
             strict = self.schema.get('option', 'strict')
             if field == 'value' and strict:
                 pernode = self.schema.get(*keypath, field='pernode')
-                if pernode == 'optional' and \
+                if pernode == schema_utils.PerNode.OPTIONAL and \
                    (step is None or index is None) and \
                    (Schema.GLOBAL_KEY not in (step, index)):  # allow explicit access to global
                     self.error(
@@ -1111,7 +1111,7 @@ class Chip:
         package_dir = os.path.dirname(os.path.abspath(filename))
 
         def __make_path(rel, path):
-            path = utils._resolve_env_vars(self, path)
+            path = utils._resolve_env_vars(self, path, None, None)
             if os.path.isabs(path):
                 if path.startswith(rel):
                     return os.path.relpath(path, rel), package_name
@@ -1282,7 +1282,7 @@ class Chip:
         """
         strict = self.get('option', 'strict')
         pernode = self.get(*keypath, field='pernode')
-        if strict and pernode == 'optional' and (step is None or index is None):
+        if strict and pernode == schema_utils.PerNode.OPTIONAL and (step is None or index is None):
             self.error(
                 f"Invalid args to find_files() of keypath {keypath}: step and "
                 "index are required for reading from this parameter while "
@@ -1394,7 +1394,9 @@ class Chip:
             result.append(utils.find_sc_file(self,
                                              path,
                                              missing_ok=missing_ok,
-                                             search_paths=search_paths))
+                                             search_paths=search_paths,
+                                             step=step,
+                                             index=index))
 
         if self._relative_path and not abs_path_only:
             rel_result = []
@@ -2828,10 +2830,10 @@ class Chip:
             set_step = None
             set_index = None
             pernode = self.get(*keypath, field='pernode')
-            if pernode == 'required':
+            if pernode == schema_utils.PerNode.REQUIRED:
                 set_step = step
                 set_index = index
-            elif pernode == 'optional':
+            elif pernode == schema_utils.PerNode.OPTIONAL:
                 for vals, key_step, key_index in self.schema._getvals(*keypath):
                     if key_step == step and key_index == index and vals:
                         set_step = step
@@ -2887,7 +2889,7 @@ class Chip:
         return self._dash
 
     ###########################################################################
-    def summary(self, show_all_indices=False, generate_image=True, generate_html=True):
+    def summary(self, show_all_indices=False, generate_image=True, generate_html=False):
         '''
         Prints a summary of the compilation manifest.
 
@@ -2927,6 +2929,10 @@ class Chip:
             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)
 
@@ -3092,6 +3098,13 @@ class Chip:
             step (str): Step name
             index (int): Step index
         '''
+
+        if flow not in self.getkeys('flowgraph'):
+            raise ValueError(f'{flow} is not in the manifest')
+
+        if step not in self.getkeys('flowgraph', flow):
+            raise ValueError(f'{step} is not a valid step in {flow}')
+
         if index is None:
             # Iterate over all indexes
             for index in self.getkeys('flowgraph', flow, step):
@@ -3099,6 +3112,8 @@ class Chip:
             return
 
         index = str(index)
+        if index not in self.getkeys('flowgraph', flow, step):
+            raise ValueError(f'{index} is not a valid index for {step} in {flow}')
 
         # Save input edges
         node = (step, index)
@@ -3153,7 +3168,7 @@ class Chip:
                     self.add('flowgraph', flow, newstep, index, 'input', (newin, in_index))
 
     ###########################################################################
-    def run(self):
+    def run(self, raise_exception=False):
         '''
         Executes tasks in a flowgraph.
 
@@ -3177,12 +3192,23 @@ class Chip:
         processes to exit before start, returning control to the the main
         program which can then exit.
 
+        Args:
+            raise_exception (bool): if True, will rethrow errors that the flow raises,
+                otherwise will report the error and return False
+
         Examples:
             >>> run()
             Runs the execution flow defined by the flowgraph dictionary.
         '''
 
-        sc_runner(self)
+        try:
+            sc_runner(self)
+        except Exception as e:
+            if raise_exception:
+                raise e
+            self.logger.error(str(e))
+            return False
+        return True
 
     ###########################################################################
     def show(self, filename=None, screenshot=False, extension=None):
@@ -3320,7 +3346,7 @@ class Chip:
 
         # run show flow
         try:
-            self.run()
+            self.run(raise_exception=True)
             if screenshot:
                 step, index = _get_flowgraph_exit_nodes(self, flow='showflow')[0]
                 success = self.find_result('png', step=step, index=index)

siliconcompiler/flowgraph.py

@@ -4,23 +4,6 @@ from siliconcompiler import SiliconCompilerError, NodeStatus
 from siliconcompiler.tools._common import input_file_node_name, get_tool_task
 
 
-def _check_execution_nodes_inputs(chip, flow):
-    for node in nodes_to_execute(chip, flow):
-        if node in _get_execution_entry_nodes(chip, flow):
-            continue
-        pruned_node_inputs = set(_get_pruned_node_inputs(chip, flow, node))
-        node_inputs = set(_get_flowgraph_node_inputs(chip, flow, node))
-        tool, task = get_tool_task(chip, node[0], node[1], flow=flow)
-        if tool == 'builtin' and not pruned_node_inputs or \
-           tool != 'builtin' and pruned_node_inputs != node_inputs:
-            chip.logger.warning(
-                f'Flowgraph connection from {node_inputs.difference(pruned_node_inputs)} '
-                f'to {node} is missing. '
-                f'Double check your flowgraph and from/to/prune options.')
-            return False
-    return True
-
-
 def _nodes_to_execute(chip, flow, from_nodes, to_nodes, prune_nodes):
     '''
     Assumes a flowgraph with valid edges for the inputs
@@ -283,12 +266,12 @@ def nodes_to_execute(chip, flow=None):
     if flow is None:
         flow = chip.get('option', 'flow')
 
-    from_nodes = _get_execution_entry_nodes(chip, flow)
-    to_nodes = _get_execution_exit_nodes(chip, flow)
-    prune_nodes = chip.get('option', 'prune')
+    from_nodes = set(_get_execution_entry_nodes(chip, flow))
+    to_nodes = set(_get_execution_exit_nodes(chip, flow))
+    prune_nodes = set(chip.get('option', 'prune'))
     if from_nodes == to_nodes:
         return list(filter(lambda node: node not in prune_nodes, from_nodes))
-    return _nodes_to_execute(chip, flow, set(from_nodes), set(to_nodes), set(prune_nodes))
+    return _nodes_to_execute(chip, flow, from_nodes, to_nodes, prune_nodes)
 
 
 ###########################################################################
@@ -345,8 +328,13 @@ def _check_flowgraph(chip, flow=None):
             chip.logger.error(f'{step} is not defined in the {flow} flowgraph')
             error = True
 
-    if not _check_execution_nodes_inputs(chip, flow):
-        error = True
+    for step, index in chip.get('option', 'prune'):
+        if step not in chip.getkeys('flowgraph', flow):
+            chip.logger.error(f'{step} is not defined in the {flow} flowgraph')
+            error = True
+        elif str(index) not in chip.getkeys('flowgraph', flow, step):
+            chip.logger.error(f'{step}{index} is not defined in the {flow} flowgraph')
+            error = True
 
     unreachable_steps = _unreachable_steps_to_execute(chip, flow)
     if unreachable_steps:

siliconcompiler/package.py

@@ -46,7 +46,7 @@ def _path(chip, package, download_handler):
             f'Could not find package source for {package} in schema. '
             'You can use register_source() to add it.', chip=chip)
 
-    data['path'] = _resolve_env_vars(chip, data['path'])
+    data['path'] = _resolve_env_vars(chip, data['path'], None, None)
 
     url = urlparse(data['path'])
 

siliconcompiler/remote/schema.py

@@ -1,5 +1,6 @@
 from siliconcompiler.schema.schema_cfg import scparam
 from siliconcompiler.schema import Schema
+from siliconcompiler.schema.utils import PerNode, Scope
 
 
 SCHEMA_VERSION = '0.0.2'
@@ -11,7 +12,7 @@ def schema_cfg():
 
     scparam(cfg, ['schemaversion'],
             sctype='str',
-            scope='global',
+            scope=Scope.GLOBAL,
             defvalue=SCHEMA_VERSION,
             require='all',
             shorthelp="Schema version number",
@@ -22,7 +23,7 @@ def schema_cfg():
 
     scparam(cfg, ['option', 'port'],
             sctype='int',
-            scope='global',
+            scope=Scope.GLOBAL,
             defvalue=8080,
             require='all',
             shorthelp="Port number to run the server on.",
@@ -34,7 +35,7 @@ def schema_cfg():
     scparam(cfg, ['option', 'cluster'],
             sctype='enum',
             enum=['local', 'slurm'],
-            scope='global',
+            scope=Scope.GLOBAL,
             defvalue='local',
             require='all',
             shorthelp="Type of compute cluster to use.",
@@ -45,7 +46,7 @@ def schema_cfg():
 
     scparam(cfg, ['option', 'nfsmount'],
             sctype='dir',
-            scope='global',
+            scope=Scope.GLOBAL,
             defvalue='/nfs/sc_compute',
             require='all',
             shorthelp="Directory of mounted shared NFS storage.",
@@ -56,7 +57,7 @@ def schema_cfg():
 
     scparam(cfg, ['option', 'auth'],
             sctype='bool',
-            scope='global',
+            scope=Scope.GLOBAL,
             defvalue=False,
             require='all',
             shorthelp="Flag determining whether to enable authenticated and encrypted jobs.",
@@ -67,7 +68,7 @@ def schema_cfg():
 
     scparam(cfg, ['option', 'cfg'],
             sctype='[file]',
-            scope='job',
+            scope=Scope.JOB,
             shorthelp="Configuration manifest",
             switch="-cfg <file>",
             example=["cli: -cfg mypdk.json",
@@ -82,8 +83,8 @@ def schema_cfg():
     scparam(cfg, ['option', 'loglevel'],
             sctype='enum',
             enum=["info", "warning", "error", "critical", "debug"],
-            pernode='optional',
-            scope='job',
+            pernode=PerNode.OPTIONAL,
+            scope=Scope.JOB,
             defvalue='info',
             shorthelp="Logging level",
             switch="-loglevel <str>",

siliconcompiler/report/report.py

@@ -2,6 +2,7 @@ import fnmatch
 import pandas
 import os
 from siliconcompiler import Schema
+from siliconcompiler.schema.utils import PerNode
 from siliconcompiler.report import utils
 from siliconcompiler.flowgraph import nodes_to_execute
 from siliconcompiler.tools._common import get_tool_task
@@ -53,7 +54,7 @@ def get_flowgraph_nodes(chip, step, index):
     if task is not None:
         nodes['task'] = task
     for key in chip.getkeys('record'):
-        if chip.get('record', key, field='pernode') == 'never':
+        if chip.get('record', key, field='pernode').is_never():
             value = chip.get('record', key)
         else:
             value = chip.get('record', key, step=step, index=index)
@@ -106,7 +107,7 @@ def make_manifest_helper(manifest_subsect, modified_manifest_subsect):
     '''
 
     def build_leaf(manifest_subsect):
-        if manifest_subsect['pernode'] == 'never':
+        if PerNode(manifest_subsect['pernode']) == PerNode.NEVER:
             if Schema.GLOBAL_KEY in manifest_subsect['node'] and \
                     Schema.GLOBAL_KEY in manifest_subsect['node'][Schema.GLOBAL_KEY]:
                 value = manifest_subsect['node'][Schema.GLOBAL_KEY][Schema.GLOBAL_KEY]['value']
@@ -132,7 +133,7 @@ def make_manifest_helper(manifest_subsect, modified_manifest_subsect):
             return node_values
 
     if Schema._is_leaf(manifest_subsect):
-        if manifest_subsect['pernode'] == 'never':
+        if PerNode(manifest_subsect['pernode']) == PerNode.NEVER:
             if Schema.GLOBAL_KEY in manifest_subsect['node']:
                 value = manifest_subsect['node'][Schema.GLOBAL_KEY][Schema.GLOBAL_KEY]['value']
             else: