pyedb 0.50.1__py3-none-any.whl → 0.51.2__py3-none-any.whl

pyedb/grpc/database/stackup.py

@@ -94,7 +94,14 @@ class LayerCollection(GrpcLayerCollection):
         self._pedb = pedb
 
     def update_layout(self):
-        """Update the layout with the current layer collection."""
+        """Update the layout with the current layer collection.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> edb.stackup.update_layout()
+        """
         self._pedb.layout.layer_collection = self
 
     def add_layer_top(self, name, layer_type="signal", **kwargs):
@@ -115,6 +122,13 @@ class LayerCollection(GrpcLayerCollection):
         -------
         :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`
             Layer object created.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> top_layer = edb.stackup.add_layer_top("NewTopLayer", layer_type="signal", thickness="0.1mm",
+        ... material="copper")
         """
         thickness = GrpcValue(0.0)
         if "thickness" in kwargs:
@@ -147,6 +161,13 @@ class LayerCollection(GrpcLayerCollection):
         -------
         :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`
             Layer object created.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> bot_layer = edb.stackup.add_layer_bottom("NewBottomLayer", layer_type="signal", thickness="0.1mm",
+        ... material="copper")
         """
         thickness = GrpcValue(0.0)
         layer_type_map = {"dielectric": GrpcLayerType.DIELECTRIC_LAYER, "signal": GrpcLayerType.SIGNAL_LAYER}
@@ -188,6 +209,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`
             Layer object created.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> new_layer = edb.stackup.add_layer_below("NewLayer", "TopLayer", layer_type="dielectric", thickness="0.05mm")
         """
         thickness = GrpcValue(0.0)
         if "thickness" in kwargs:
@@ -229,6 +256,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`
             Layer object created.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> new_layer = edb.stackup.add_layer_above("NewLayer", "BottomLayer", layer_type="signal", thickness="0.05mm")
         """
         thickness = GrpcValue(0.0)
         if "thickness" in kwargs:
@@ -258,6 +291,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         :class:`pyedb.grpc.database.layers.layer.Layer`
             Layer object created.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> outline_layer = edb.stackup.add_document_layer("Outline", layer_type="outline")
         """
         added_layer = self.add_layer_top(name)
         added_layer.type = GrpcLayerType.USER_LAYER
@@ -286,6 +325,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         dict[str, :class:`pyedb.grpc.database.layers.layer.Layer`]
             Dictionary of non-stackup layers.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> non_stackup = edb.stackup.non_stackup_layers
         """
         return {
             layer.name: Layer(self._pedb, layer) for layer in self.get_layers(GrpcLayerTypeSet.NON_STACKUP_LAYER_SET)
@@ -299,6 +344,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         dict[str, :class:`pyedb.grpc.database.layers.layer.Layer`]
             Dictionary of all layers.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> all_layers = edb.stackup.all_layers
         """
         return {layer.name: Layer(self._pedb, layer) for layer in self.get_layers(GrpcLayerTypeSet.ALL_LAYER_SET)}
 
@@ -310,6 +361,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         dict[str, :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`]
             Dictionary of signal layers.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> signal_layers = edb.stackup.signal_layers
         """
         return {
             layer.name: StackupLayer(self._pedb, layer) for layer in self.get_layers(GrpcLayerTypeSet.SIGNAL_LAYER_SET)
@@ -323,6 +380,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         dict[str, :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`]
             Dictionary of dielectric layers.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> dielectric_layers = edb.stackup.dielectric_layers
         """
         return {
             layer.name: StackupLayer(self._pedb, layer)
@@ -337,6 +400,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         list[list[int, str]]
             List of layers with their IDs and names.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> layers_by_id = edb.stackup.layers_by_id
         """
         return [[obj.id, name] for name, obj in self.all_layers.items()]
 
@@ -348,6 +417,12 @@ class LayerCollection(GrpcLayerCollection):
         -------
         dict[str, :class:`pyedb.grpc.database.layers.stackup_layer.StackupLayer`]
             Dictionary of stackup layers.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> layers = edb.stackup.layers
         """
         return {obj.name: StackupLayer(self._pedb, obj) for obj in self.get_layers(GrpcLayerTypeSet.STACKUP_LAYER_SET)}
 
@@ -418,6 +493,12 @@ class Stackup(LayerCollection):
         -------
         float
             Stackup thickness.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> thickness = edb.stackup.thickness
         """
         return self.get_layout_thickness()
 
@@ -429,6 +510,12 @@ class Stackup(LayerCollection):
         -------
         int
             Number of layers.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> num_layers = edb.stackup.num_layers
         """
         return len(list(self.layers.keys()))
 
@@ -441,7 +528,7 @@ class Stackup(LayerCollection):
         dielectric_material="FR4_epoxy",
         soldermask=True,
         soldermask_thickness="20um",
-    ):  # pragma: no cover
+    ) -> bool:  # pragma: no cover
         """Create a symmetric stackup.
 
         Parameters
@@ -465,6 +552,12 @@ class Stackup(LayerCollection):
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> edb.stackup.create_symmetric_stackup(layer_count=4)
         """
         if not np:
             self._pedb.logger.error("Numpy is needed. Please, install it first.")
@@ -566,6 +659,12 @@ class Stackup(LayerCollection):
             - ``"laminate"``
             - ``"overlapping"``
             - ``"multizone"``
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> mode = edb.stackup.mode
         """
         return super().mode.name.lower()
 
@@ -699,6 +798,12 @@ class Stackup(LayerCollection):
         -------
         bool
             ``True`` when successful.
+
+        Examples
+        --------
+        >>> from pyedb import Edb
+        >>> edb = Edb()
+        >>> edb.stackup.add_outline_layer()
         """
         return self.add_document_layer(name="Outline", layer_type="outline")
 

pyedb/grpc/database/terminal/point_terminal.py

@@ -69,7 +69,7 @@ class PointTerminal(GrpcPointTerminal):
             super(PointTerminal, self.__class__).layer.__set__(self, value)
 
     @property
-    def ref_terminal(self) -> PointTerminal:
+    def ref_terminal(self) -> any:
         """Reference terminal.
 
         Returns
@@ -84,7 +84,7 @@ class PointTerminal(GrpcPointTerminal):
         super().reference_terminal = value
 
     @property
-    def reference_terminal(self) -> PointTerminal:
+    def reference_terminal(self) -> any:
         """Reference terminal.
 
         Returns

pyedb/grpc/database/terminal/terminal.py

@@ -441,7 +441,7 @@ class Terminal(GrpcTerminal):
             return PadstackInstance(self._pedb.pin_obj)
 
     @property
-    def magnitude(self) -> FLOAT:
+    def magnitude(self) -> float:
         """Get the magnitude of the source.
 
         Returns

pyedb/grpc/edb.py

@@ -378,23 +378,6 @@ class Edb(EdbInit):
                     except:
                         self.logger.info(f"Failed to delete AEDT project-related file {file}.")
 
-    def _clean_variables(self):
-        """Initialize internal variables and perform garbage collection."""
-        self.grpc = True
-        self._materials = None
-        self._components = None
-        self._core_primitives = None
-        self._stackup = None
-        self._padstack = None
-        self._siwave = None
-        self._hfss = None
-        self._nets = None
-        self._layout_instance = None
-        self._variables = None
-        self._active_cell = None
-        self._layout = None
-        self._configuration = None
-
     def _init_objects(self):
         self._components = Components(self)
         self._stackup = Stackup(self, self.layout.layer_collection)
@@ -579,19 +562,24 @@ class Edb(EdbInit):
         terms = [term for term in self.layout.terminals if term.boundary_type.value == 8]
         return {ter.name: ter for ter in terms}
 
-    def open_edb(self, restart_rpc_server=False) -> bool:
+    def open(self, restart_rpc_server=False) -> bool:
         """Open EDB database.
 
         Returns
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        Open an existing EDB database:
+        >>> edb = Edb("myproject.aedb")
         """
         self.standalone = self.standalone
         n_try = 10
         while not self.db and n_try:
             try:
-                self.open(
+                self._open(
                     self.edbpath,
                     self.isreadonly,
                     restart_rpc_server=restart_rpc_server,
@@ -621,7 +609,21 @@ class Edb(EdbInit):
                 self.logger.error("Builder was not initialized.")
             return True
 
-    def create_edb(self, restart_rpc_server=False) -> bool:
+    def open_edb(self, restart_rpc_server=False) -> bool:
+        """Open EDB database.
+
+        .. deprecated:: 0.50.1
+            Use :func:`open` instead.
+
+        Returns
+        -------
+        bool
+            True if successful, False otherwise.
+        """
+        warnings.warn("`open_edb` is deprecated use `open` instead.", DeprecationWarning)
+        return self.open(restart_rpc_server)
+
+    def create(self, restart_rpc_server=False) -> any:
         """Create new EDB database.
 
         Returns
@@ -636,7 +638,7 @@ class Edb(EdbInit):
         n_try = 10
         while not self.db and n_try:
             try:
-                self.create(self.edbpath, restart_rpc_server=restart_rpc_server)
+                self._create(self.edbpath, restart_rpc_server=restart_rpc_server)
                 n_try -= 1
             except Exception as e:
                 self.logger.error(e.args[0])
@@ -651,9 +653,22 @@ class Edb(EdbInit):
             )
         if self._active_cell:
             self._init_objects()
-            return True
+            return self
         return None
 
+    def create_edb(self, restart_rpc_server=False) -> bool:
+        """
+        .. deprecated:: 0.50.1
+            Use :func:`create` instead.
+
+        Returns
+        -------
+        bool
+            True if successful, False otherwise.
+        """
+        warnings.warn("`create_edb` is deprecated use `create` instead.", DeprecationWarning)
+        return self.create(restart_rpc_server)
+
     def import_layout_pcb(
         self,
         input_file,
@@ -746,6 +761,13 @@ class Edb(EdbInit):
         -------
         Full path to the AEDB file : str
 
+        Examples
+        --------
+        Import a BRD file:
+        >>> edb.import_layout_file("my_board.brd", r"C:/project")
+
+        Import a GDS file with control file:
+        >>> edb.import_layout_file("layout.gds", control_file="control.xml")
         """
         self._components = None
         self._core_primitives = None
@@ -806,6 +828,11 @@ class Edb(EdbInit):
         -------
         str or bool
             Output file path if successful, False otherwise.
+
+        Examples
+        --------
+        Export to IPC2581 format:
+        >>> edb.export_to_ipc2581("output.xml")
         """
         if units.lower() not in ["millimeter", "inch", "micron"]:  # pragma no cover
             self.logger.warning("The wrong unit is entered. Setting to the default, millimeter.")
@@ -1182,18 +1209,6 @@ class Edb(EdbInit):
         else:
             return PointData(x, y)
 
-    @staticmethod
-    def _is_file_existing_and_released(filename) -> bool:
-        if os.path.exists(filename):
-            try:
-                os.rename(filename, filename + "_")
-                os.rename(filename + "_", filename)
-                return True
-            except OSError as e:
-                return False
-        else:
-            return False
-
     @staticmethod
     def _is_file_existing(filename) -> bool:
         if os.path.exists(filename):
@@ -1201,18 +1216,6 @@ class Edb(EdbInit):
         else:
             return False
 
-    def _wait_for_file_release(self, timeout=30, file_to_release=None) -> bool:
-        if not file_to_release:
-            file_to_release = os.path.join(self.edbpath)
-        tstart = time.time()
-        while True:
-            if self._is_file_existing_and_released(file_to_release):
-                return True
-            elif time.time() - tstart > timeout:
-                return False
-            else:
-                time.sleep(0.250)
-
     def _wait_for_file_exists(self, timeout=30, file_to_release=None, wait_count=4):
         if not file_to_release:
             file_to_release = os.path.join(self.edbpath)
@@ -1234,37 +1237,47 @@ class Edb(EdbInit):
     def close_edb(self) -> bool:
         """Close EDB and clean up resources.
 
+        ..deprecated:: 0.51.0
+           Use: func:`close` instead.
+
         Returns
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        Close the EDB session:
+        >>> edb.close_edb()
         """
-        self.close()
-        start_time = time.time()
-        self._wait_for_file_release()
-        elapsed_time = time.time() - start_time
-        self.logger.info("EDB file release time: {0:.2f}ms".format(elapsed_time * 1000.0))
-        self._clean_variables()
-        return True
+        warnings.warn("Use method close instead.", DeprecationWarning)
+        return self.close()
 
     def save_edb(self) -> bool:
         """Save current EDB database.
 
+        ..deprecated:: 0.51.0
+           Use: func:`save` instead.
+
         Returns
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        Save the current EDB:
+        >>> edb.save_edb()
         """
-        self.save()
-        start_time = time.time()
-        self._wait_for_file_release()
-        elapsed_time = time.time() - start_time
-        self.logger.info("EDB file save time: {0:.2f}ms".format(elapsed_time * 1000.0))
-        return True
+        warnings.warn("Use method save instead.", DeprecationWarning)
+        return self.save()
 
     def save_edb_as(self, fname) -> bool:
         """Save EDB database to new location.
 
+        ..deprecated:: 0.51.0
+           Use: func:`save_as` instead.
+
         Parameters
         ----------
         fname : str
@@ -1274,17 +1287,14 @@ class Edb(EdbInit):
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        Save EDB to new location:
+        >>> edb.save_edb_as("new_location.aedb")
         """
-        self.save_as(fname)
-        start_time = time.time()
-        self._wait_for_file_release()
-        elapsed_time = time.time() - start_time
-        self.logger.info("EDB file save time: {0:.2f}ms".format(elapsed_time * 1000.0))
-        self.edbpath = self.directory
-        self.log_name = os.path.join(
-            os.path.dirname(fname), "pyedb_" + os.path.splitext(os.path.split(fname)[-1])[0] + ".log"
-        )
-        return True
+        warnings.warn("Use method save_as instead.", DeprecationWarning)
+        return self.save_as(fname)
 
     def execute(self, func):
         """Execute EDB utility command (Not implemented in gRPC).
@@ -1694,6 +1704,15 @@ class Edb(EdbInit):
         -------
         list or bool
             Cutout boundary points if successful, False otherwise.
+
+        Examples
+        --------
+        Create a basic cutout:
+        >>> edb.cutout(signal_list=["Net1"], reference_list=["GND"])
+
+        Create cutout with custom polygon:
+        >>> custom_poly = [[0,0], [10e-3,0], [10e-3,10e-3], [0,10e-3]]
+        >>> edb.cutout(custom_extent=custom_poly)
         """
         if expansion_factor > 0:
             expansion_size = self.calculate_initial_extent(expansion_factor)
@@ -1770,7 +1789,7 @@ class Edb(EdbInit):
                         break
                     self.close_edb()
                     self.edbpath = legacy_path
-                    self.open_edb()
+                    self.open()
                     i += 1
                     expansion = expansion_size * i
                 if working_cutout:
@@ -1856,15 +1875,15 @@ class Edb(EdbInit):
         # _cutout.simulation_setups = self.active_cell.simulation_setups see bug #433 status.
         _dbCells = [_cutout]
         if output_aedb_path:
-            db2 = self.create(output_aedb_path)
-            _success = db2.save()
-            _dbCells = _dbCells
+            from ansys.edb.core.database import Database as GrpcDatabase
+
+            db2 = GrpcDatabase.create(output_aedb_path)
             db2.copy_cells(_dbCells)  # Copies cutout cell/design to db2 project
-            if len(list(db2.circuit_cells)) > 0:
-                for net in db2.circuit_cells[0].layout.nets:
+            if len(list(db2.top_circuit_cells)) > 0:
+                for net in db2.top_circuit_cells[0].layout.nets:
                     if not net.name in included_nets_list:
                         net.delete()
-                _success = db2.save()
+                db2.save()
             for c in self.active_db.top_circuit_cells:
                 if c.name == _cutout.name:
                     c.delete()
@@ -1890,7 +1909,7 @@ class Edb(EdbInit):
                         for _cmp in _cmps:
                             _cmp.delete()
                     except:
-                        self._logger.error("Failed to remove single pin components.")
+                        self.logger.error("Failed to remove single pin components.")
                 db2.close()
                 source = os.path.join(output_aedb_path, "edb.def.tmp")
                 target = os.path.join(output_aedb_path, "edb.def")
@@ -2342,7 +2361,9 @@ class Edb(EdbInit):
 
         _dbCells = [_cutout]
         if output_aedb_path:
-            db2 = self.create(output_aedb_path)
+            from ansys.edb.core.database import Database as GrpcDatabase
+
+            db2 = GrpcDatabase.create(output_aedb_path)
             db2.save()
             cell_copied = db2.copy_cells(_dbCells)  # Copies cutout cell/design to db2 project
             cell = cell_copied[0]
@@ -2352,7 +2373,7 @@ class Edb(EdbInit):
                 if c.name == _cutout.name:
                     c.delete()
             if open_cutout_at_end:  # pragma: no cover
-                _success = db2.save()
+                db2.save()
                 self._db = db2
                 self.edbpath = output_aedb_path
                 self._active_cell = cell
@@ -2436,6 +2457,11 @@ class Edb(EdbInit):
         -------
         str
             Path to generated AEDT file.
+
+        Examples
+        --------
+        Export to HFSS project:
+        >>> edb.export_hfss(r"C:/output", net_list=["SignalNet"])
         """
         siwave_s = SiwaveSolve(self.edbpath, aedt_installer_path=self.base_path)
         return siwave_s.export_3d_cad("HFSS", path_to_output, net_list, num_cores, aedt_file_name, hidden=hidden)
@@ -2467,6 +2493,11 @@ class Edb(EdbInit):
         -------
         str
             Path to generated AEDT file.
+
+        Examples
+        --------
+        Export to Q3D project:
+        >>> edb.export_q3d(r"C:/output")
         """
         siwave_s = SiwaveSolve(self.edbpath, aedt_installer_path=self.base_path)
         return siwave_s.export_3d_cad(
@@ -2505,6 +2536,11 @@ class Edb(EdbInit):
         -------
         str
             Path to generated AEDT file.
+
+        Examples
+        --------
+        Export to Maxwell project:
+        >>> edb.export_maxwell(r"C:/output")
         """
         siwave_s = SiwaveSolve(self.edbpath, aedt_installer_path=self.base_path)
         return siwave_s.export_3d_cad(
@@ -2523,6 +2559,11 @@ class Edb(EdbInit):
         -------
         str
             Path to SIwave project.
+
+        Examples
+        --------
+        Solve with SIwave:
+        >>> edb.solve_siwave()
         """
         process = SiwaveSolve(self.edbpath, aedt_version=self.edbversion)
         try:
@@ -2761,7 +2802,10 @@ class Edb(EdbInit):
             return True
         self.logger.reset_timer()
         if not common_reference:
-            common_reference = list(set([i.reference_net.name for i in all_sources if i.reference_net.name]))
+            ref_terminals = [term for term in all_sources if term.is_reference_terminal]
+            common_reference = list(
+                set([i.reference_terminal.net.name for i in all_sources if i.is_reference_terminal])
+            )
             if len(common_reference) > 1:
                 self.logger.error("More than 1 reference found.")
                 return False
@@ -3036,7 +3080,7 @@ class Edb(EdbInit):
         for port in self.excitations.values():
             nets.append(port.net.name)
         for port in self.sources.values():
-            nets.append(port.net_name)
+            nets.append(port.net.name)
         nets = list(set(nets))
         max_width = 0
         for net in nets:
@@ -3438,6 +3482,15 @@ class Edb(EdbInit):
         -------
         list[str]
             Created parameter names.
+
+        Examples
+        --------
+        Parametrize design elements:
+        >>> params = edb.auto_parametrize_design(
+        ...     layers=True,
+        ...     materials=True,
+        ...     trace_net_filter=["Clock"]
+        ... )
         """
         edb_original_path = self.edbpath
         if output_aedb_path: