pyedb 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

pyedb/grpc/database/siwave.py

@@ -25,6 +25,7 @@ This module contains these classes: ``CircuitPort``, ``CurrentSource``, ``EdbSiw
 ``PinGroup``, ``ResistorSource``, ``Source``, ``SourceType``, and ``VoltageSource``.
 """
 import os
+from typing import Any, Dict, Optional, Union
 import warnings
 
 from ansys.edb.core.database import ProductIdType as GrpcProductIdType
@@ -57,41 +58,41 @@ class Siwave(object):
     >>> edb_siwave = edbapp.siwave
     """
 
-    def __init__(self, p_edb):
+    def __init__(self, p_edb) -> None:
         self._pedb = p_edb
 
     @property
-    def _edb(self):
+    def _edb(self) -> Any:
         """EDB object."""
         return self._pedb
 
     @property
-    def _logger(self):
+    def _logger(self) -> Any:
         """Logger object."""
         return self._pedb.logger
 
     @property
-    def _active_layout(self):
+    def _active_layout(self) -> Any:
         """Active layout."""
         return self._pedb.active_layout
 
     @property
-    def _layout(self):
+    def _layout(self) -> Any:
         """Active layout."""
         return self._pedb.layout
 
     @property
-    def _cell(self):
+    def _cell(self) -> Any:
         """Active cell."""
         return self._pedb.active_cell
 
     @property
-    def _db(self):
+    def _db(self) -> Any:
         """Active database."""
         return self._pedb.active_db
 
     @property
-    def excitations(self):
+    def excitations(self) -> Dict[str, Any]:
         """Excitation sources in the layout.
 
         Examples
@@ -103,7 +104,7 @@ class Siwave(object):
         return self._pedb.excitations
 
     @property
-    def sources(self):
+    def sources(self) -> Dict[str, Any]:
         """All sources in the layout.
 
         Examples
@@ -115,7 +116,7 @@ class Siwave(object):
         return self._pedb.sources
 
     @property
-    def probes(self):
+    def probes(self) -> Dict[str, Any]:
         """All probes in the layout.
 
         Examples
@@ -127,7 +128,7 @@ class Siwave(object):
         return self._pedb.probes
 
     @property
-    def pin_groups(self):
+    def pin_groups(self) -> Dict[str, Any]:
         """All layout pin groups.
 
         Returns
@@ -526,8 +527,13 @@ class Siwave(object):
         return self._pedb.source_excitation.create_dc_terminal(component_name, net_name, source_name)
 
     def create_exec_file(
-        self, add_dc=False, add_ac=False, add_syz=False, export_touchstone=False, touchstone_file_path=""
-    ):
+        self,
+        add_dc: bool = False,
+        add_ac: bool = False,
+        add_syz: bool = False,
+        export_touchstone: bool = False,
+        touchstone_file_path: str = "",
+    ) -> bool:
         """Create an executable file.
 
         Parameters
@@ -598,13 +604,13 @@ class Siwave(object):
 
     def add_siwave_syz_analysis(
         self,
-        accuracy_level=1,
-        distribution="linear",
-        start_freq=1,
-        stop_freq=1e9,
-        step_freq=1e6,
-        discrete_sweep=False,
-    ):
+        accuracy_level: int = 1,
+        distribution: str = "linear",
+        start_freq: Union[str, float] = 1,
+        stop_freq: Union[str, float] = 1e9,
+        step_freq: Union[str, float, int] = 1e6,
+        discrete_sweep: bool = False,
+    ) -> Any:
         """Add a SIwave AC analysis to EDB.
 
         Parameters
@@ -684,7 +690,7 @@ class Siwave(object):
         self.create_exec_file(add_ac=True)
         return setup
 
-    def add_siwave_dc_analysis(self, name=None):
+    def add_siwave_dc_analysis(self, name: Optional[str] = None) -> Any:
         """Add a Siwave DC analysis in EDB.
 
         .. note::
@@ -1015,7 +1021,7 @@ class Siwave(object):
             negative_layer,
         )
 
-    def create_impedance_crosstalk_scan(self, scan_type="impedance"):
+    def create_impedance_crosstalk_scan(self, scan_type: str = "impedance") -> "SiwaveScanConfig":
         """Create Siwave crosstalk scan object.
 
         Parameters
@@ -1035,7 +1041,7 @@ class Siwave(object):
         return SiwaveScanConfig(self._pedb, scan_type)
 
     @property
-    def icepak_use_minimal_comp_defaults(self):
+    def icepak_use_minimal_comp_defaults(self) -> bool:
         """Icepak default setting.
 
         If ``True``, only resistors are active in Icepak simulation and power dissipation
@@ -1049,7 +1055,7 @@ class Siwave(object):
         self._pedb.active_cell.set_product_property(GrpcProductIdType.SIWAVE, 422, value)
 
     @property
-    def icepak_component_file(self):
+    def icepak_component_file(self) -> str:
         """Icepak component file path."""
         return self._pedb.active_cell.get_product_property(GrpcProductIdType.SIWAVE, 420).value