siliconcompiler 0.35.2__py3-none-any.whl → 0.35.4__py3-none-any.whl

siliconcompiler/constraints/asic_pins.py

@@ -1,4 +1,4 @@
-from typing import Union, Tuple
+from typing import Union, Tuple, Optional
 
 from siliconcompiler.schema import BaseSchema, NamedSchema, EditableSchema, Parameter, \
     PerNode, Scope
@@ -13,7 +13,7 @@ class ASICPinConstraint(NamedSchema):
     metal layer, and its relative position on the chip's side.
     """
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: Optional[str] = None):
         super().__init__()
         self.set_name(name)
 
@@ -129,7 +129,8 @@ class ASICPinConstraint(NamedSchema):
                 same order number, the actual order is at the discretion of the
                 tool."""))
 
-    def set_width(self, width: float, step: str = None, index: Union[str, int] = None):
+    def set_width(self, width: float,
+                  step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the width constraint for the pin.
 
@@ -149,7 +150,8 @@ class ASICPinConstraint(NamedSchema):
             raise ValueError("width must be a positive value")
         return self.set("width", width, step=step, index=index)
 
-    def get_width(self, step: str = None, index: Union[str, int] = None) -> float:
+    def get_width(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> float:
         """
         Retrieves the current width constraint of the pin.
 
@@ -162,7 +164,8 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.get("width", step=step, index=index)
 
-    def set_length(self, length: float, step: str = None, index: Union[str, int] = None):
+    def set_length(self, length: float,
+                   step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the length constraint for the pin.
 
@@ -182,7 +185,8 @@ class ASICPinConstraint(NamedSchema):
             raise ValueError("length must be a positive value")
         return self.set("length", length, step=step, index=index)
 
-    def get_length(self, step: str = None, index: Union[str, int] = None) -> float:
+    def get_length(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> float:
         """
         Retrieves the current length constraint of the pin.
 
@@ -195,7 +199,8 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.get("length", step=step, index=index)
 
-    def set_placement(self, x: float, y: float, step: str = None, index: Union[str, int] = None):
+    def set_placement(self, x: float, y: float,
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the placement constraint for the pin.
 
@@ -216,7 +221,8 @@ class ASICPinConstraint(NamedSchema):
             raise TypeError("y must be a number")
         return self.set("placement", (x, y), step=step, index=index)
 
-    def get_placement(self, step: str = None, index: Union[str, int] = None) -> Tuple[float, float]:
+    def get_placement(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> Tuple[float, float]:
         """
         Retrieves the current placement constraint of the pin.
 
@@ -230,7 +236,8 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.get("placement", step=step, index=index)
 
-    def set_shape(self, shape: str, step: str = None, index: Union[str, int] = None):
+    def set_shape(self, shape: str,
+                  step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the shape constraint for the pin.
 
@@ -243,7 +250,7 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.set("shape", shape, step=step, index=index)
 
-    def get_shape(self, step: str = None, index: Union[str, int] = None) -> str:
+    def get_shape(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Retrieves the current shape constraint of the pin.
 
@@ -256,7 +263,8 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.get("shape", step=step, index=index)
 
-    def set_layer(self, layer: str, step: str = None, index: Union[str, int] = None):
+    def set_layer(self, layer: str,
+                  step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the metal layer constraint for the pin.
 
@@ -269,7 +277,7 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.set("layer", layer, step=step, index=index)
 
-    def get_layer(self, step: str = None, index: Union[str, int] = None) -> str:
+    def get_layer(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Retrieves the current metal layer constraint of the pin.
 
@@ -282,7 +290,8 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.get("layer", step=step, index=index)
 
-    def set_side(self, side: Union[int, str], step: str = None, index: Union[str, int] = None):
+    def set_side(self, side: Union[int, str],
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the side constraint for the pin, indicating where it should be placed.
 
@@ -318,7 +327,7 @@ class ASICPinConstraint(NamedSchema):
 
         return self.set("side", side, step=step, index=index)
 
-    def get_side(self, step: str = None, index: Union[str, int] = None) -> int:
+    def get_side(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> int:
         """
         Retrieves the current side constraint of the pin.
 
@@ -331,7 +340,8 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.get("side", step=step, index=index)
 
-    def set_order(self, order: int, step: str = None, index: Union[str, int] = None):
+    def set_order(self, order: int,
+                  step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the relative order constraint for the pin on its assigned side.
 
@@ -343,7 +353,7 @@ class ASICPinConstraint(NamedSchema):
         """
         return self.set("order", order, step=step, index=index)
 
-    def get_order(self, step: str = None, index: Union[str, int] = None) -> int:
+    def get_order(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> int:
         """
         Retrieves the current order constraint of the pin.
 
@@ -398,7 +408,7 @@ class ASICPinConstraints(BaseSchema):
 
         EditableSchema(self).insert(pin.name, pin, clobber=True)
 
-    def get_pinconstraint(self, pin: str = None):
+    def get_pinconstraint(self, pin: Optional[str] = None):
         """
         Retrieves one or all pin constraints from the configuration.
 
@@ -461,6 +471,34 @@ class ASICPinConstraints(BaseSchema):
         self.add_pinconstraint(constraint)
         return constraint
 
+    def copy_pinconstraint(self, pin: str, name: str, insert: bool = True) -> ASICPinConstraint:
+        """
+        Copies an existing pin constraint, renames it, and optionally adds it to the design.
+
+        This method retrieves the pin constraint identified by ``pin``, creates a
+        deep copy of it, and renames the copy to ``name``. If ``insert`` is True,
+        the new constraint is immediately added to the configuration.
+
+        Args:
+            pin (str): The name of the existing pin constraint to be copied.
+            name (str): The name to assign to the new copied constraint.
+            insert (bool, optional): Whether to add the newly created constraint
+                to the configuration. Defaults to True.
+
+        Returns:
+            ASICPinConstraint: The newly created copy of the pin constraint.
+
+        Raises:
+            LookupError: If the source pin constraint specified by ``pin`` does not exist.
+        """
+        constraint = EditableSchema(self.get_pinconstraint(pin)).copy()
+        EditableSchema(constraint).rename(name)
+        if insert:
+            if self.valid(name):
+                raise ValueError(f"{name} already exists")
+            self.add_pinconstraint(constraint)
+        return constraint
+
     def remove_pinconstraint(self, pin: str) -> bool:
         """
         Removes a pin constraint from the design configuration.

siliconcompiler/constraints/asic_timing.py

@@ -1,4 +1,4 @@
-from typing import Union, Set, List, Tuple
+from typing import Union, Set, List, Tuple, Optional
 
 from siliconcompiler.schema import BaseSchema, NamedSchema, EditableSchema, Parameter, \
     PerNode, Scope
@@ -14,7 +14,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     operating mode, SDC filesets, and timing checks to be performed.
     """
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: Optional[str] = None):
         super().__init__()
         self.set_name(name)
 
@@ -126,7 +126,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     def set_pin_voltage(self,
                         pin: str,
                         voltage: float,
-                        step: str = None, index: Union[str, int] = None):
+                        step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the voltage for a specified pin.
 
@@ -140,7 +140,8 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def get_pin_voltage(self,
                         pin: str,
-                        step: str = None, index: Union[str, int] = None) -> float:
+                        step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> float:
         """
         Gets the voltage of a specified pin.
 
@@ -162,7 +163,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     def add_libcorner(self,
                       libcorner: Union[List[str], str],
                       clobber: bool = False,
-                      step: str = None, index: Union[str, int] = None):
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Adds a library corner to the design.
 
@@ -179,8 +180,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         else:
             return self.add("libcorner", libcorner, step=step, index=index)
 
-    def get_libcorner(self,
-                      step: str = None, index: Union[str, int] = None) -> Set[str]:
+    def get_libcorner(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> Set[str]:
         """
         Gets the set of library corners.
 
@@ -195,7 +196,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_pexcorner(self,
                       pexcorner: str,
-                      step: str = None, index: Union[str, int] = None):
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the parasitic extraction (PEX) corner for the design.
 
@@ -207,7 +208,7 @@ class ASICTimingScenarioSchema(NamedSchema):
         return self.set("pexcorner", pexcorner, step=step, index=index)
 
     def get_pexcorner(self,
-                      step: str = None, index: Union[str, int] = None) -> str:
+                      step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the parasitic extraction (PEX) corner currently set for the design.
 
@@ -222,7 +223,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_mode(self,
                  mode: str,
-                 step: str = None, index: Union[str, int] = None):
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the operational mode for the design.
 
@@ -234,7 +235,7 @@ class ASICTimingScenarioSchema(NamedSchema):
         return self.set("mode", mode, step=step, index=index)
 
     def get_mode(self,
-                 step: str = None, index: Union[str, int] = None) -> str:
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the operational mode currently set for the design.
 
@@ -249,7 +250,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_opcond(self,
                    opcond: str,
-                   step: str = None, index: Union[str, int] = None):
+                   step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the operating condition for the design.
 
@@ -261,7 +262,7 @@ class ASICTimingScenarioSchema(NamedSchema):
         return self.set("opcond", opcond, step=step, index=index)
 
     def get_opcond(self,
-                   step: str = None, index: Union[str, int] = None) -> str:
+                   step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the operating condition currently set for the design.
 
@@ -276,7 +277,7 @@ class ASICTimingScenarioSchema(NamedSchema):
 
     def set_temperature(self,
                         temperature: float,
-                        step: str = None, index: Union[str, int] = None):
+                        step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the temperature for the design.
 
@@ -287,8 +288,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         """
         return self.set("temperature", temperature, step=step, index=index)
 
-    def get_temperature(self,
-                        step: str = None, index: Union[str, int] = None) -> float:
+    def get_temperature(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> float:
         """
         Gets the temperature currently set for the design.
 
@@ -305,7 +306,7 @@ class ASICTimingScenarioSchema(NamedSchema):
                        design: Union[Design, str],
                        fileset: str,
                        clobber: bool = False,
-                       step: str = None, index: Union[str, int] = None):
+                       step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Adds an SDC fileset for a given design.
 
@@ -337,8 +338,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         else:
             return self.add("sdcfileset", (design, fileset), step=step, index=index)
 
-    def get_sdcfileset(self,
-                       step: str = None, index: Union[str, int] = None) -> List[Tuple[str, str]]:
+    def get_sdcfileset(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> List[Tuple[str, str]]:
         """
         Gets the list of SDC filesets.
 
@@ -354,7 +355,7 @@ class ASICTimingScenarioSchema(NamedSchema):
     def add_check(self,
                   check: Union[List[str], str],
                   clobber: bool = False,
-                  step: str = None, index: Union[str, int] = None):
+                  step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Adds a check to the design process.
 
@@ -371,7 +372,8 @@ class ASICTimingScenarioSchema(NamedSchema):
         else:
             return self.add("check", check, step=step, index=index)
 
-    def get_check(self, step: str = None, index: Union[str, int] = None) -> Set[str]:
+    def get_check(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) \
+            -> Set[str]:
         """
         Gets the set of checks configured for the design process.
 
@@ -426,7 +428,7 @@ class ASICTimingConstraintSchema(BaseSchema):
 
         EditableSchema(self).insert(scenario.name, scenario, clobber=True)
 
-    def get_scenario(self, scenario: str = None):
+    def get_scenario(self, scenario: Optional[str] = None):
         """
         Retrieves one or all timing scenarios from the configuration.
 
@@ -490,6 +492,35 @@ class ASICTimingConstraintSchema(BaseSchema):
         self.add_scenario(scenarioobj)
         return scenarioobj
 
+    def copy_scenario(self, scenario: str, name: str, insert: bool = True) \
+            -> ASICTimingScenarioSchema:
+        """
+        Copies an existing timing scenario, renames it, and optionally adds it to the design.
+
+        This method retrieves the scenario identified by ``scenario``, creates a
+        deep copy of it, and renames the copy to ``name``. If ``insert`` is True,
+        the new scenario is immediately added to the configuration.
+
+        Args:
+            scenario (str): The name of the existing scenario to be copied.
+            name (str): The name to assign to the new copied scenario.
+            insert (bool, optional): Whether to add the newly created scenario
+                to the configuration. Defaults to True.
+
+        Returns:
+            ASICTimingScenarioSchema: The newly created copy of the scenario.
+
+        Raises:
+            LookupError: If the source scenario specified by ``scenario`` does not exist.
+        """
+        constraint = EditableSchema(self.get_scenario(scenario)).copy()
+        EditableSchema(constraint).rename(name)
+        if insert:
+            if self.valid(name):
+                raise ValueError(f"{name} already exists")
+            self.add_scenario(constraint)
+        return constraint
+
     def remove_scenario(self, scenario: str) -> bool:
         """
         Removes a timing scenario from the design configuration.

siliconcompiler/constraints/fpga_timing.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Optional
 
 from siliconcompiler.schema import BaseSchema, NamedSchema, EditableSchema, Parameter, \
     PerNode, Scope
@@ -12,7 +12,7 @@ class FPGATimingScenarioSchema(NamedSchema):
     scenario and operating mode.
     """
 
-    def __init__(self, name: str = None):
+    def __init__(self, name: Optional[str] = None):
         super().__init__()
         self.set_name(name)
 
@@ -31,7 +31,7 @@ class FPGATimingScenarioSchema(NamedSchema):
 
     def set_mode(self,
                  mode: str,
-                 step: str = None, index: Union[str, int] = None):
+                 step: Optional[str] = None, index: Optional[Union[str, int]] = None):
         """
         Sets the operational mode for the design.
 
@@ -42,8 +42,7 @@ class FPGATimingScenarioSchema(NamedSchema):
         """
         return self.set("mode", mode, step=step, index=index)
 
-    def get_mode(self,
-                 step: str = None, index: Union[str, int] = None) -> str:
+    def get_mode(self, step: Optional[str] = None, index: Optional[Union[str, int]] = None) -> str:
         """
         Gets the operational mode currently set for the design.
 
@@ -98,7 +97,7 @@ class FPGATimingConstraintSchema(BaseSchema):
 
         EditableSchema(self).insert(scenario.name, scenario, clobber=True)
 
-    def get_scenario(self, scenario: str = None):
+    def get_scenario(self, scenario: Optional[str] = None):
         """
         Retrieves one or all timing scenarios from the configuration.
 

siliconcompiler/data/templates/replay/replay.sh.j2

@@ -4,10 +4,27 @@ if [ "${BASH_SOURCE[0]}" != "$0" ]; then
     return
 fi
 
+__print_help() {
+    # Print help information for this file
+    echo "Usage: $0"
+    echo "  Options:"
+    echo "    --which           print which executable would be used"
+    echo "    --version         print the version of the executable, if supported"
+    echo "    --directory       print the execution directory"
+    echo "    --command         print the execution command"
+    echo "    --skipcd          do not change directory into replay directory"
+    echo "    --skipexports     do not export environmental variables"
+    echo "    --cmdprefix <cmd> prefix to add to the replay command, such as gdb"
+    echo "    --cmdarg <args>   prefix to add to the replay command, such as -gui"
+    echo "    --node            execute entire node"
+    echo "    -h,--help         print this help"
+}
+
 # Parse replay arguments
 CD_WORK="{{ work_dir }}"
 PRINT=""
 CMDPREFIX=""
+CMDARGS=""
 SKIPEXPORT=0
 DONODE={{ node_only }}
 while [[ $# -gt 0 ]]; do
@@ -41,27 +58,22 @@ while [[ $# -gt 0 ]]; do
             shift
             shift
             ;;
+        --cmdarg)
+            CMDARGS="$2"
+            shift
+            shift
+            ;;
         --node)
             DONODE=1
             shift
-            shift
             ;;
         -h|--help)
-            echo "Usage: $0"
-            echo "  Options:"
-            echo "    --which           print which executable would be used"
-            echo "    --version         print the version of the executable, if supported"
-            echo "    --directory       print the execution directory"
-            echo "    --command         print the execution command"
-            echo "    --skipcd          do not change directory into replay directory"
-            echo "    --skipexports     do not export environmental variables"
-            echo "    --cmdprefix <cmd> prefix to add to the replay command, such as dgb"
-            echo "    --node            execute entire node"
-            echo "    -h,--help         print this help"
+            __print_help
             exit 0
             ;;
         *)
             echo "Unknown option $1"
+            __print_help
             exit 1
             ;;
     esac
@@ -105,5 +117,6 @@ python3 -m siliconcompiler.scheduler.run_node \
 {% if cmds|length > 0 %}else
 # Command execution
 $CMDPREFIX \{% for cmd in cmds %}
-{% if not loop.first %}  {% endif %}{{ cmd }}{% if not loop.last %} \{% endif %}{% endfor %}
-{% endif %}fi
+{% if not loop.first %}  {% endif %}{{ cmd }} \{% endfor %}
+{% endif %}  ${CMDARGS}
+fi