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

pyedb/grpc/database/hfss.py

@@ -37,66 +37,136 @@ from pyedb.modeler.geometry_operators import GeometryOperators
 
 
 class Hfss(object):
-    """Manages EDB method to configure Hfss setup accessible from `Edb.hfss` property."""
+    """Manages EDB methods for HFSS setup configuration.
+
+    Provides access to HFSS-specific operations including:
+    - Excitation and port creation
+    - Source and probe management
+    - Simulation setup configuration
+    - Boundary condition creation
+    - Layout manipulation for simulation
+
+    Accessed via `Edb.hfss` property.
+    """
 
     def __init__(self, p_edb):
         self._pedb = p_edb
 
     @property
     def hfss_extent_info(self) -> HfssExtentInfo:
-        """HFSS extent information."""
+        """HFSS extent information.
+
+        Returns
+        -------
+        HfssExtentInfo
+            Object containing HFSS extent configuration data.
+        """
         return HfssExtentInfo(self._pedb)
 
     @property
     def _logger(self):
+        """Logger instance for message handling.
+
+        Returns
+        -------
+        logging.Logger
+            Current logger instance.
+        """
         return self._pedb.logger
 
     @property
     def _edb(self):
-        """EDB object.
+        """EDB API object.
 
         Returns
         -------
         Ansys.Ansoft.Edb
+            EDB API instance.
         """
         return self._pedb
 
     @property
     def _active_layout(self):
+        """Active layout object.
+
+        Returns
+        -------
+        Edb.Cell.Layout
+            Current active layout.
+        """
         return self._pedb.active_layout
 
     @property
     def _layout(self):
+        """Current layout object.
+
+        Returns
+        -------
+        Edb.Cell.Layout
+            Current layout.
+        """
         return self._pedb.layout
 
     @property
     def _cell(self):
+        """Current cell object.
+
+        Returns
+        -------
+        Edb.Cell
+            Current cell.
+        """
         return self._pedb.cell
 
     @property
     def _db(self):
+        """Active database object.
+
+        Returns
+        -------
+        Edb.Database
+            Active database.
+        """
         return self._pedb.active_db
 
     @property
     def excitations(self):
-        """Get all excitations."""
+        """All excitation definitions in the layout.
+
+        Returns
+        -------
+        list
+            List of excitation objects.
+        """
         return self._pedb.excitations
 
     @property
     def sources(self):
-        """Get all sources."""
+        """All source definitions in the layout.
+
+        Returns
+        -------
+        list
+            List of source objects.
+        """
         return self._pedb.sources
 
     @property
     def probes(self):
-        """Get all probes."""
+        """All probe definitions in the layout.
+
+        Returns
+        -------
+        list
+            List of probe objects.
+        """
         return self._pedb.probes
 
     def _create_edge_terminal(self, prim_id, point_on_edge, terminal_name=None, is_ref=False):
-        """Create an edge terminal.
+        """Create an edge terminal (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`_create_edge_terminal` is move to pyedb.grpc.database.excitations._create_edge_terminal instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations._create_edge_terminal` instead.
 
         Parameters
         ----------
@@ -104,17 +174,15 @@ class Hfss(object):
             Primitive ID.
         point_on_edge : list
             Coordinate of the point to define the edge terminal.
-            The point must be on the target edge but not on the two
-            ends of the edge.
         terminal_name : str, optional
-            Name of the terminal. The default is ``None``, in which case the
-            default name is assigned.
+            Name of the terminal.
         is_ref : bool, optional
-            Whether it is a reference terminal. The default is ``False``.
+            Whether it is a reference terminal.
 
         Returns
         -------
         Edb.Cell.Terminal.EdgeTerminal
+            Created edge terminal.
         """
         warnings.warn(
             "`_create_edge_terminal` is deprecated and is now located here "
@@ -126,12 +194,12 @@ class Hfss(object):
         )
 
     def get_trace_width_for_traces_with_ports(self):
-        """Retrieve the trace width for traces with ports.
+        """Retrieve trace widths for traces with ports.
 
         Returns
-        -------<
+        -------
         dict
-            Dictionary of trace width data.
+            Dictionary mapping net names to smallest trace widths.
         """
         nets = {}
         for net in self._pedb.excitations_nets:
@@ -139,27 +207,26 @@ class Hfss(object):
         return nets
 
     def create_circuit_port_on_pin(self, pos_pin, neg_pin, impedance=50, port_name=None):
-        """Create Circuit Port on Pin.
+        """Create circuit port between two pins (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_circuit_port_on_pin` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_circuit_port_on_pin` instead.
 
         Parameters
         ----------
-        pos_pin : Object
-            Edb Pin
-        neg_pin : Object
-            Edb Pin
-        impedance : float
-            Port Impedance
+        pos_pin : Edb.Cell.Primitive.PadstackInstance
+            Positive pin.
+        neg_pin : Edb.Cell.Primitive.PadstackInstance
+            Negative pin.
+        impedance : float, optional
+            Port impedance.
         port_name : str, optional
-            Port Name
+            Port name.
 
         Returns
         -------
         str
-            Port Name.
-
+            Port name.
         """
         warnings.warn(
             "`create_circuit_port_on_pin` is deprecated and is now located here "
@@ -169,36 +236,28 @@ class Hfss(object):
         return self._pedb.excitations.create_circuit_port_on_pin(pos_pin, neg_pin, impedance, port_name)
 
     def create_voltage_source_on_pin(self, pos_pin, neg_pin, voltage_value=3.3, phase_value=0, source_name=""):
-        """Create a voltage source.
+        """Create voltage source between two pins (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_voltage_source_on_pin` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_voltage_source_on_pin` instead.
 
         Parameters
         ----------
-        pos_pin : Object
-            Positive Pin.
-        neg_pin : Object
-            Negative Pin.
+        pos_pin : Edb.Cell.Primitive.PadstackInstance
+            Positive pin.
+        neg_pin : Edb.Cell.Primitive.PadstackInstance
+            Negative pin.
         voltage_value : float, optional
-            Value for the voltage. The default is ``3.3``.
-        phase_value : optional
-            Value for the phase. The default is ``0``.
+            Voltage value.
+        phase_value : float, optional
+            Phase value.
         source_name : str, optional
-            Name of the source. The default is ``""``.
+            Source name.
 
         Returns
         -------
         str
-            Source Name.
-
-        Examples
-        --------
-
-        >>> from pyedb import Edb
-        >>> edbapp = Edb("myaedbfolder", "project name", "release version")
-        >>> pins =edbapp.components.get_pin_from_component("U2A5")
-        >>> edbapp.hfss.create_voltage_source_on_pin(pins[0], pins[1],50,"source_name")
+            Source name.
         """
         warnings.warn(
             "`create_voltage_source_on_pin` is deprecated and is now located here "
@@ -210,36 +269,28 @@ class Hfss(object):
         )
 
     def create_current_source_on_pin(self, pos_pin, neg_pin, current_value=0.1, phase_value=0, source_name=""):
-        """Create a current source.
+        """Create current source between two pins (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_current_source_on_pin` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_current_source_on_pin` instead.
 
         Parameters
         ----------
-        pos_pin : Object
-            Positive Pin.
-        neg_pin : Object
-            Negative Pin.
+        pos_pin : Edb.Cell.Primitive.PadstackInstance
+            Positive pin.
+        neg_pin : Edb.Cell.Primitive.PadstackInstance
+            Negative pin.
         current_value : float, optional
-            Value for the current. The default is ``0.1``.
-        phase_value : optional
-            Value for the phase. The default is ``0``.
+            Current value.
+        phase_value : float, optional
+            Phase value.
         source_name : str, optional
-            Name of the source. The default is ``""``.
+            Source name.
 
         Returns
         -------
         str
-            Source Name.
-
-        Examples
-        --------
-
-        >>> from pyedb import Edb
-        >>> edbapp = Edb("myaedbfolder", "project name", "release version")
-        >>> pins =edbapp.components.get_pin_from_component("U2A5")
-        >>> edbapp.hfss.create_current_source_on_pin(pins[0], pins[1],50,"source_name")
+            Source name.
         """
         warnings.warn(
             "`create_current_source_on_pin` is deprecated and is now located here "
@@ -251,34 +302,26 @@ class Hfss(object):
         )
 
     def create_resistor_on_pin(self, pos_pin, neg_pin, rvalue=1, resistor_name=""):
-        """Create a Resistor boundary between two given pins.
+        """Create resistor between two pins (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_resistor_on_pin` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_resistor_on_pin` instead.
 
         Parameters
         ----------
-        pos_pin : Object
-            Positive Pin.
-        neg_pin : Object
-            Negative Pin.
+        pos_pin : Edb.Cell.Primitive.PadstackInstance
+            Positive pin.
+        neg_pin : Edb.Cell.Primitive.PadstackInstance
+            Negative pin.
         rvalue : float, optional
-            Resistance value. The default is ``1``.
+            Resistance value.
         resistor_name : str, optional
-            Name of the resistor. The default is ``""``.
+            Resistor name.
 
         Returns
         -------
         str
-            Name of the Resistor.
-
-        Examples
-        --------
-
-        >>> from pyedb import Edb
-        >>> edbapp = Edb("myaedbfolder", "project name", "release version")
-        >>> pins =edbapp.components.get_pin_from_component("U2A5")
-        >>> edbapp.hfss.create_resistor_on_pin(pins[0], pins[1],50,"res_name")
+            Resistor name.
         """
         warnings.warn(
             "`create_resistor_on_pin` is deprecated and is now located here "
@@ -296,35 +339,31 @@ class Hfss(object):
         impedance_value=50,
         port_name="",
     ):
-        """Create a circuit port on a NET.
-
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_circuit_port_on_net` instead.
+        """Create circuit port on net (deprecated).
 
-        It groups all pins belonging to the specified net and then applies the port on PinGroups.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_circuit_port_on_net` instead.
 
         Parameters
         ----------
         positive_component_name : str
-            Name of the positive component.
+            Positive component name.
         positive_net_name : str
-            Name of the positive net.
+            Positive net name.
         negative_component_name : str, optional
-            Name of the negative component. The default is ``None``, in which case the name of
-            the positive net is assigned.
+            Negative component name.
         negative_net_name : str, optional
-            Name of the negative net name. The default is ``"GND"``.
+            Negative net name.
         impedance_value : float, optional
-            Port impedance value. The default is ``50``.
+            Port impedance.
         port_name : str, optional
-            Name of the port. The default is ``""``.
+            Port name.
 
         Returns
         -------
         str
-            The name of the port.
+            Port name.
         """
-
         warnings.warn(
             "`create_circuit_port_on_net` is deprecated and is now located here "
             "`pyedb.grpc.core.excitations.create_circuit_port_on_net` instead.",
@@ -349,35 +388,33 @@ class Hfss(object):
         phase_value=0,
         source_name="",
     ):
-        """Create a voltage source.
+        """Create voltage source on net (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_voltage_source_on_net` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_voltage_source_on_net` instead.
 
         Parameters
         ----------
         positive_component_name : str
-            Name of the positive component.
+            Positive component name.
         positive_net_name : str
-            Name of the positive net.
+            Positive net name.
         negative_component_name : str, optional
-            Name of the negative component. The default is ``None``, in which case the name of
-            the positive net is assigned.
+            Negative component name.
         negative_net_name : str, optional
-            Name of the negative net. The default is ``"GND"``.
+            Negative net name.
         voltage_value : float, optional
-            Value for the voltage. The default is ``3.3``.
-        phase_value : optional
-            Value for the phase. The default is ``0``.
+            Voltage value.
+        phase_value : float, optional
+            Phase value.
         source_name : str, optional
-            Name of the source. The default is ``""``.
+            Source name.
 
         Returns
         -------
         str
-            Source Name.
+            Source name.
         """
-
         warnings.warn(
             "`create_voltage_source_on_net` is deprecated and is now located here "
             "`pyedb.grpc.core.excitations.create_voltage_source_on_net` instead.",
@@ -403,35 +440,33 @@ class Hfss(object):
         phase_value=0,
         source_name="",
     ):
-        """Create a current source.
+        """Create current source on net (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_current_source_on_net` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_current_source_on_net` instead.
 
         Parameters
         ----------
         positive_component_name : str
-            Name of the positive component.
+            Positive component name.
         positive_net_name : str
-            Name of the positive net.
+            Positive net name.
         negative_component_name : str, optional
-            Name of the negative component. The default is ``None``, in which case the name of
-            the positive net is assigned.
+            Negative component name.
         negative_net_name : str, optional
-            Name of the negative net. The default is ``"GND"``.
+            Negative net name.
         current_value : float, optional
-            Value for the current. The default is ``0.1``.
-        phase_value : optional
-            Value for the phase. The default is ``0``.
+            Current value.
+        phase_value : float, optional
+            Phase value.
         source_name : str, optional
-            Name of the source. The default is ``""``.
+            Source name.
 
         Returns
         -------
         str
-            Source Name.
+            Source name.
         """
-
         warnings.warn(
             "`create_current_source_on_net` is deprecated and is now located here "
             "`pyedb.grpc.core.excitations.create_current_source_on_net` instead.",
@@ -448,25 +483,24 @@ class Hfss(object):
         )
 
     def create_coax_port_on_component(self, ref_des_list, net_list, delete_existing_terminal=False):
-        """Create a coaxial port on a component or component list on a net or net list.
-           The name of the new coaxial port is automatically assigned.
+        """Create coaxial port on component (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_coax_port_on_component` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_coax_port_on_component` instead.
 
         Parameters
         ----------
         ref_des_list : list, str
-            List of one or more reference designators.
-
+            Reference designator(s).
         net_list : list, str
-            List of one or more nets.
+            Net name(s).
+        delete_existing_terminal : bool, optional
+            Delete existing terminals.
 
         Returns
         -------
         bool
-            ``True`` when successful, ``False`` when failed.
-
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`create_coax_port_on_component` is deprecated and is now located here "
@@ -488,39 +522,34 @@ class Hfss(object):
         vertical_extent_factor=3,
         pec_launch_width="0.01mm",
     ):
-        """Create a differential wave port.
+        """Create differential wave port (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_differential_wave_port` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_differential_wave_port` instead.
 
         Parameters
         ----------
         positive_primitive_id : int, EDBPrimitives
-            Primitive ID of the positive terminal.
+            Positive primitive ID.
         positive_points_on_edge : list
-            Coordinate of the point to define the edge terminal.
-            The point must be close to the target edge but not on the two
-            ends of the edge.
+            Point coordinates on positive edge.
         negative_primitive_id : int, EDBPrimitives
-            Primitive ID of the negative terminal.
+            Negative primitive ID.
         negative_points_on_edge : list
-            Coordinate of the point to define the edge terminal.
-            The point must be close to the target edge but not on the two
-            ends of the edge.
+            Point coordinates on negative edge.
         port_name : str, optional
-            Name of the port. The default is ``None``.
+            Port name.
         horizontal_extent_factor : int, float, optional
-            Horizontal extent factor. The default value is ``5``.
+            Horizontal extent factor.
         vertical_extent_factor : int, float, optional
-            Vertical extent factor. The default value is ``3``.
+            Vertical extent factor.
         pec_launch_width : str, optional
-            Launch Width of PEC. The default value is ``"0.01mm"``.
+            PEC launch width.
 
         Returns
         -------
         tuple
-            The tuple contains: (port_name, pyedb.dotnet.database.edb_data.sources.ExcitationDifferential).
-
+            (Port name, ExcitationDifferential) tuple.
         """
         warnings.warn(
             "`create_differential_wave_port` is deprecated and is now located here "
@@ -547,32 +576,30 @@ class Hfss(object):
         vertical_extent_factor=3,
         pec_launch_width="0.01mm",
     ):
-        """Create a bundle wave port.
+        """Create bundle wave port (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_bundle_wave_port` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_bundle_wave_port` instead.
 
         Parameters
         ----------
         primitives_id : list
-            Primitive ID of the positive terminal.
+            Primitive IDs.
         points_on_edge : list
-            Coordinate of the point to define the edge terminal.
-            The point must be close to the target edge but not on the two
-            ends of the edge.
+            Point coordinates on edges.
         port_name : str, optional
-            Name of the port. The default is ``None``.
+            Port name.
         horizontal_extent_factor : int, float, optional
-            Horizontal extent factor. The default value is ``5``.
+            Horizontal extent factor.
         vertical_extent_factor : int, float, optional
-            Vertical extent factor. The default value is ``3``.
+            Vertical extent factor.
         pec_launch_width : str, optional
-            Launch Width of PEC. The default value is ``"0.01mm"``.
+            PEC launch width.
 
         Returns
         -------
         tuple
-            The tuple contains: (port_name, pyedb.egacy.database.edb_data.sources.ExcitationDifferential).
+            (Port name, ExcitationDifferential) tuple.
         """
         warnings.warn(
             "`create_bundle_wave_port` is deprecated and is now located here "
@@ -584,23 +611,22 @@ class Hfss(object):
         )
 
     def create_hfss_ports_on_padstack(self, pinpos, portname=None):
-        """Create an HFSS port on a padstack.
+        """Create HFSS port on padstack (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_hfss_ports_on_padstack` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_hfss_ports_on_padstack` instead.
 
         Parameters
         ----------
         pinpos :
-            Position of the pin.
-
+            Pin position.
         portname : str, optional
-             Name of the port. The default is ``None``.
+            Port name.
 
         Returns
         -------
         bool
-            ``True`` when successful, ``False`` when failed.
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`create_hfss_ports_on_padstack` is deprecated and is now located here "
@@ -620,45 +646,35 @@ class Hfss(object):
         port_impedance=50.0,
         force_circuit_port=False,
     ):
-        """Create lumped port between two edges from two different polygons. Can also create a vertical port when
-        the reference layer name is only provided. When a port is created between two edge from two polygons which don't
-        belong to the same layer, a circuit port will be automatically created instead of lumped. To enforce the circuit
-        port instead of lumped,use the boolean force_circuit_port.
-
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_edge_port_on_polygon` instead.
+        """Create edge port on polygon (deprecated).
 
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_edge_port_on_polygon` instead.
 
         Parameters
         ----------
-        polygon : The EDB polygon object used to assign the port.
-            Edb.Cell.Primitive.Polygon object.
-
-        reference_polygon : The EDB polygon object used to define the port reference.
-            Edb.Cell.Primitive.Polygon object.
-
-        terminal_point : The coordinate of the point to define the edge terminal of the port. This point must be
-        located on the edge of the polygon where the port has to be placed. For instance taking the middle point
-        of an edge is a good practice but any point of the edge should be valid. Taking a corner might cause unwanted
-        port location.
-            list[float, float] with values provided in meter.
-
-        reference_point : same as terminal_point but used for defining the reference location on the edge.
-            list[float, float] with values provided in meter.
-
-        reference_layer : Name used to define port reference for vertical ports.
-            str the layer name.
-
-        port_name : Name of the port.
-            str.
-
-        port_impedance : port impedance value. Default value is 50 Ohms.
-            float, impedance value.
+        polygon : Edb.Cell.Primitive.Polygon, optional
+            Port polygon.
+        reference_polygon : Edb.Cell.Primitive.Polygon, optional
+            Reference polygon.
+        terminal_point : list, optional
+            Terminal point coordinates.
+        reference_point : list, optional
+            Reference point coordinates.
+        reference_layer : str, optional
+            Reference layer name.
+        port_name : str, optional
+            Port name.
+        port_impedance : float, optional
+            Port impedance.
+        force_circuit_port : bool, optional
+            Force circuit port creation.
 
-        force_circuit_port ; used to force circuit port creation instead of lumped. Works for vertical and coplanar
-        ports.
+        Returns
+        -------
+        bool
+            True if successful, False otherwise.
         """
-
         warnings.warn(
             "`create_edge_port_on_polygon` is deprecated and is now located here "
             "`pyedb.grpc.core.excitations.create_edge_port_on_polygon` instead.",
@@ -685,39 +701,36 @@ class Hfss(object):
         vertical_extent_factor=3,
         pec_launch_width="0.01mm",
     ):
-        """Create a wave port.
+        """Create wave port (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_wave_port` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_wave_port` instead.
 
         Parameters
         ----------
         prim_id : int, Primitive
             Primitive ID.
         point_on_edge : list
-            Coordinate of the point to define the edge terminal.
-            The point must be on the target edge but not on the two
-            ends of the edge.
+            Point coordinates on edge.
         port_name : str, optional
-            Name of the port. The default is ``None``.
+            Port name.
         impedance : int, float, optional
-            Impedance of the port. The default value is ``50``.
+            Port impedance.
         horizontal_extent_factor : int, float, optional
-            Horizontal extent factor. The default value is ``5``.
+            Horizontal extent factor.
         vertical_extent_factor : int, float, optional
-            Vertical extent factor. The default value is ``3``.
+            Vertical extent factor.
         pec_launch_width : str, optional
-            Launch Width of PEC. The default value is ``"0.01mm"``.
+            PEC launch width.
 
         Returns
         -------
         tuple
-            The tuple contains: (Port name, pyedb.dotnet.database.edb_data.sources.Excitation).
-
+            (Port name, Excitation) tuple.
         """
         warnings.warn(
-            "`create_source_on_component` is deprecated and is now located here "
-            "`pyedb.grpc.core.excitations.create_source_on_component` instead.",
+            "`create_wave_port` is deprecated and is now located here "
+            "`pyedb.grpc.core.excitations.create_wave_port` instead.",
             DeprecationWarning,
         )
         return self._pedb.source_excitation.create_wave_port(
@@ -742,35 +755,31 @@ class Hfss(object):
         vertical_extent_factor=3,
         pec_launch_width="0.01mm",
     ):
-        """Create a vertical edge port.
+        """Create vertical edge port (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_edge_port_vertical` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_edge_port_vertical` instead.
 
         Parameters
         ----------
         prim_id : int
             Primitive ID.
         point_on_edge : list
-            Coordinate of the point to define the edge terminal.
-            The point must be on the target edge but not on the two
-            ends of the edge.
+            Point coordinates on edge.
         port_name : str, optional
-            Name of the port. The default is ``None``.
+            Port name.
         impedance : int, float, optional
-            Impedance of the port. The default value is ``50``.
+            Port impedance.
         reference_layer : str, optional
-            Reference layer of the port. The default is ``None``.
+            Reference layer name.
         hfss_type : str, optional
-            Type of the port. The default value is ``"Gap"``. Options are ``"Gap"``, ``"Wave"``.
+            Port type ("Gap" or "Wave").
         horizontal_extent_factor : int, float, optional
-            Horizontal extent factor. The default value is ``5``.
+            Horizontal extent factor.
         vertical_extent_factor : int, float, optional
-            Vertical extent factor. The default value is ``3``.
-        radial_extent_factor : int, float, optional
-            Radial extent factor. The default value is ``0``.
+            Vertical extent factor.
         pec_launch_width : str, optional
-            Launch Width of PEC. The default value is ``"0.01mm"``.
+            PEC launch width.
 
         Returns
         -------
@@ -804,36 +813,32 @@ class Hfss(object):
         impedance=50,
         layer_alignment="Upper",
     ):
-        """Create a horizontal edge port.
+        """Create horizontal edge port (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_edge_port_horizontal` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_edge_port_horizontal` instead.
 
         Parameters
         ----------
         prim_id : int
             Primitive ID.
         point_on_edge : list
-            Coordinate of the point to define the edge terminal.
-            The point must be on the target edge but not on the two
-            ends of the edge.
+            Point coordinates on edge.
         ref_prim_id : int, optional
-            Reference primitive ID. The default is ``None``.
+            Reference primitive ID.
         point_on_ref_edge : list, optional
-            Coordinate of the point to define the reference edge
-            terminal. The point must be on the target edge but not
-            on the two ends of the edge. The default is ``None``.
+            Point coordinates on reference edge.
         port_name : str, optional
-            Name of the port. The default is ``None``.
+            Port name.
         impedance : int, float, optional
-            Impedance of the port. The default value is ``50``.
+            Port impedance.
         layer_alignment : str, optional
-            Layer alignment. The default value is ``Upper``. Options are ``"Upper"``, ``"Lower"``.
+            Layer alignment ("Upper" or "Lower").
 
         Returns
         -------
         str
-            Name of the port.
+            Port name.
         """
         warnings.warn(
             "`create_edge_port_horizontal` is deprecated and is now located here "
@@ -845,36 +850,28 @@ class Hfss(object):
         )
 
     def create_lumped_port_on_net(self, nets, reference_layer, return_points_only, digit_resolution, at_bounding_box):
-        """Create an edge port on nets. This command looks for traces and polygons on the
-        nets and tries to assign vertical lumped port.
+        """Create lumped port on net (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_lumped_port_on_net` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_lumped_port_on_net` instead.
 
         Parameters
         ----------
-        nets : list, optional
-            List of nets, str or Edb net.
-
-        reference_layer : str, Edb layer.
-             Name or Edb layer object.
-
-        return_points_only : bool, optional
-            Use this boolean when you want to return only the points from the edges and not creating ports. Default
-            value is ``False``.
-
-        digit_resolution : int, optional
-            The number of digits carried for the edge location accuracy. The default value is ``6``.
-
+        nets : list
+            Net names or objects.
+        reference_layer : str, Edb.Layer
+            Reference layer name or object.
+        return_points_only : bool
+            Return points only without creating ports.
+        digit_resolution : int
+            Coordinate digit resolution.
         at_bounding_box : bool
-            When ``True`` will keep the edges from traces at the layout bounding box location. This is recommended when
-             a cutout has been performed before and lumped ports have to be created on ending traces. Default value is
-             ``True``.
+            Use layout bounding box.
 
         Returns
         -------
         bool
-            ``True`` when successful, ``False`` when failed.
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`create_lumped_port_on_net` is deprecated and is now located here "
@@ -886,31 +883,28 @@ class Hfss(object):
         )
 
     def create_vertical_circuit_port_on_clipped_traces(self, nets=None, reference_net=None, user_defined_extent=None):
-        """Create an edge port on clipped signal traces.
+        """Create vertical circuit port on clipped traces (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_vertical_circuit_port_on_clipped_traces` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_vertical_circuit_port_on_clipped_traces` instead.
 
         Parameters
         ----------
         nets : list, optional
-            String of one net or EDB net or a list of multiple nets or EDB nets.
-
-        reference_net : str, Edb net.
-             Name or EDB reference net.
-
-        user_defined_extent : [x, y], EDB PolygonData
-            Use this point list or PolygonData object to check if ports are at this polygon border.
+            Net names or objects.
+        reference_net : str, Edb.Net, optional
+            Reference net name or object.
+        user_defined_extent : list, PolygonData, optional
+            User-defined extent polygon.
 
         Returns
         -------
-        [[str]]
-            Nested list of str, with net name as first value, X value for point at border, Y value for point at border,
-            and terminal name.
+        list
+            List of port data [net_name, x, y, terminal_name].
         """
         warnings.warn(
-            "`create_source_on_component` is deprecated and is now located here "
-            "`pyedb.grpc.core.excitations.create_source_on_component` instead.",
+            "`create_vertical_circuit_port_on_clipped_traces` is deprecated and is now located here "
+            "`pyedb.grpc.core.excitations.create_vertical_circuit_port_on_clipped_traces` instead.",
             DeprecationWarning,
         )
         return self._pedb.source_excitation.create_vertical_circuit_port_on_clipped_traces(
@@ -918,20 +912,19 @@ class Hfss(object):
         )
 
     def get_layout_bounding_box(self, layout=None, digit_resolution=6):
-        """Evaluate the layout bounding box.
+        """Calculate layout bounding box.
 
         Parameters
         ----------
-        layout :
-            Edb layout.
-
+        layout : Edb.Cell.Layout, optional
+            Layout object (uses active layout if None).
         digit_resolution : int, optional
-            Digit Resolution. The default value is ``6``.
+            Coordinate rounding precision.
 
         Returns
         -------
         list
-            [lower left corner X, lower left corner, upper right corner X, upper right corner Y].
+            [min_x, min_y, max_x, max_y] coordinates.
         """
         if not layout:
             layout = self._active_layout
@@ -950,21 +943,22 @@ class Hfss(object):
         return layout_bbox
 
     def configure_hfss_extents(self, simulation_setup=None):
-        """Configure the HFSS extent box.
+        """Configure HFSS extent box (deprecated).
 
-                . deprecated:: pyedb 0.28.0
-        Use :func:`self._pedb.utility.simulation_configuration.ProcessSimulationConfiguration.configure_hfss_extents`
-        instead.
+        .. deprecated:: 0.28.0
+            Use :func:
+            `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.configure_hfss_extents`
+            instead.
 
         Parameters
         ----------
-        simulation_setup :
-            Edb_DATA.SimulationConfiguration object
+        simulation_setup : HfssSimulationSetup, optional
+            Simulation setup object.
 
         Returns
         -------
         bool
-            True when succeeded, False when failed.
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`configure_hfss_extents` is deprecated and is now located here "
@@ -977,24 +971,22 @@ class Hfss(object):
         )
 
     def configure_hfss_analysis_setup(self, simulation_setup=None):
-        """
-        Configure HFSS analysis setup.
-
-        . deprecated:: pyedb 0.28.0
-        Use :func:
-        `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.configure_hfss_analysis_setup`
-        instead.
+        """Configure HFSS analysis setup (deprecated).
 
+        .. deprecated:: 0.28.0
+            Use :func:
+            `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.configure_hfss_analysis_setup`
+            instead.
 
         Parameters
         ----------
-        simulation_setup :
-            Edb_DATA.SimulationConfiguration object
+        simulation_setup : HfssSimulationSetup, optional
+            Simulation setup object.
 
         Returns
         -------
         bool
-            True when succeeded, False when failed.
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`configure_hfss_analysis_setup` is deprecated and is now located here "
@@ -1007,6 +999,19 @@ class Hfss(object):
         )
 
     def _setup_decade_count_sweep(self, sweep, start_freq="1", stop_freq="1MHz", decade_count="10"):
+        """Configure decade count sweep (internal).
+
+        Parameters
+        ----------
+        sweep : SweepData
+            Sweep data object.
+        start_freq : str, float, optional
+            Start frequency.
+        stop_freq : str, float, optional
+            Stop frequency.
+        decade_count : str, float, optional
+            Points per decade.
+        """
         start_f = GeometryOperators.parse_dim_arg(start_freq)
         if start_f == 0.0:
             start_f = 10
@@ -1022,30 +1027,20 @@ class Hfss(object):
             sweep.Frequencies.Add(str(freq))
 
     def trim_component_reference_size(self, simulation_setup=None, trim_to_terminals=False):
-        """Trim the common component reference to the minimally acceptable size.
+        """Trim component reference size (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:
-        `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.trim_component_reference_size`
-        instead.
+        .. deprecated:: 0.28.0
+            Use :func:
+            `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.trim_component_reference_size`
+            instead.
 
         Parameters
         ----------
-        simulation_setup :
-            Edb_DATA.SimulationConfiguration object
-
-        trim_to_terminals :
-            bool.
-                True, reduce the reference to a box covering only the active terminals (i.e. those with
-        ports).
-                False, reduce the reference to the minimal size needed to cover all pins
-
-        Returns
-        -------
-        bool
-            True when succeeded, False when failed.
+        simulation_setup : HfssSimulationSetup, optional
+            Simulation setup object.
+        trim_to_terminals : bool, optional
+            Trim to active terminals only.
         """
-
         warnings.warn(
             "`trim_component_reference_size` is deprecated and is now located here "
             "`pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration."
@@ -1057,22 +1052,17 @@ class Hfss(object):
         )
 
     def set_coax_port_attributes(self, simulation_setup=None):
-        """Set coaxial port attribute with forcing default impedance to 50 Ohms and adjusting the coaxial extent radius.
+        """Set coaxial port attributes (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:
-        `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.set_coax_port_attributes`
-        instead.
+        .. deprecated:: 0.28.0
+            Use :func:
+            `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.set_coax_port_attributes`
+            instead.
 
         Parameters
         ----------
-        simulation_setup :
-            Edb_DATA.SimulationConfiguration object.
-
-        Returns
-        -------
-        bool
-            True when succeeded, False when failed.
+        simulation_setup : HfssSimulationSetup, optional
+            Simulation setup object.
         """
         warnings.warn(
             "`set_coax_port_attributes` is deprecated and is now located here "
@@ -1085,6 +1075,22 @@ class Hfss(object):
         )
 
     def _get_terminals_bbox(self, comp, l_inst, terminals_only):
+        """Get component terminals bounding box (internal).
+
+        Parameters
+        ----------
+        comp : Component
+            Component object.
+        l_inst : LayoutObjInstance
+            Layout object instance.
+        terminals_only : bool
+            Consider only terminals.
+
+        Returns
+        -------
+        PolygonData
+            Bounding box polygon.
+        """
         terms_loi = []
         if terminals_only:
             term_list = []
@@ -1108,28 +1114,23 @@ class Hfss(object):
 
         terms_bbox = []
         for loi in terms_loi:
-            # Need to account for the coax port dimension
             bb = loi.GetBBox()
             ll = [bb[0].x.value, bb[0].y.value]
             ur = [bb[1].x.value, bb[1].y.value]
-            # dim = 0.26 * max(abs(UR[0]-LL[0]), abs(UR[1]-LL[1]))  # 0.25 corresponds to the default 0.5
-            # Radial Extent Factor, so set slightly larger to avoid validation errors
-            dim = 0.30 * max(abs(ur[0] - ll[0]), abs(ur[1] - ll[1]))  # 0.25 corresponds to the default 0.5
+            dim = 0.30 * max(abs(ur[0] - ll[0]), abs(ur[1] - ll[1]))
             terms_bbox.append(GrpcPolygonData([ll[0] - dim, ll[1] - dim, ur[0] + dim, ur[1] + dim]))
         return GrpcPolygonData.bbox_of_polygons(terms_bbox)
 
     def get_ports_number(self):
-        """Return the total number of excitation ports in a layout.
+        """Get number of excitation ports.
 
-        Parameters
-        ----------
-        None
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitation.get_ports_number` instead.
 
         Returns
         -------
         int
-           Number of ports.
-
+            Number of ports.
         """
         warnings.warn(
             "`get_ports_number` is deprecated and is now located here "
@@ -1139,22 +1140,22 @@ class Hfss(object):
         self._pedb.excitations.get_ports_number()
 
     def layout_defeaturing(self, simulation_setup=None):
-        """Defeature the layout by reducing the number of points for polygons based on surface deviation criteria.
+        """Defeature layout polygons (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:
-        `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.layout_defeaturing`
-        instead.
+        .. deprecated:: 0.28.0
+            Use :func:
+            `pyedb.grpc.core.utility.simulation_configuration.ProcessSimulationConfiguration.layout_defeaturing`
+            instead.
 
         Parameters
         ----------
-        simulation_setup : Edb_DATA.SimulationConfiguration object
+        simulation_setup : HfssSimulationSetup, optional
+            Simulation setup object.
 
         Returns
         -------
         bool
-            ``True`` when successful, ``False`` when failed.
-
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`layout_defeaturing` is deprecated and is now located here "
@@ -1165,34 +1166,32 @@ class Hfss(object):
         self._pedb.utility.simulation_configuration.ProcessSimulationConfiguration.layout_defeaturing(simulation_setup)
 
     def create_rlc_boundary_on_pins(self, positive_pin=None, negative_pin=None, rvalue=0.0, lvalue=0.0, cvalue=0.0):
-        """Create hfss rlc boundary on pins.
+        """Create RLC boundary on pins (deprecated).
 
-        . deprecated:: pyedb 0.28.0
-        Use :func:`pyedb.grpc.core.excitations.create_rlc_boundary_on_pins` instead.
+        .. deprecated:: 0.28.0
+            Use :func:`pyedb.grpc.core.excitations.create_rlc_boundary_on_pins` instead.
 
         Parameters
         ----------
-        positive_pin : Positive pin.
-            Edb.Cell.Primitive.PadstackInstance
-
-        negative_pin : Negative pin.
-            Edb.Cell.Primitive.PadstackInstance
-
-        rvalue : Resistance value
-
-        lvalue : Inductance value
-
-        cvalue . Capacitance value.
+        positive_pin : Edb.Cell.Primitive.PadstackInstance, optional
+            Positive pin.
+        negative_pin : Edb.Cell.Primitive.PadstackInstance, optional
+            Negative pin.
+        rvalue : float, optional
+            Resistance value.
+        lvalue : float, optional
+            Inductance value.
+        cvalue : float, optional
+            Capacitance value.
 
         Returns
         -------
         bool
-            ``True`` when successful, ``False`` when failed.
-
+            True if successful, False otherwise.
         """
         warnings.warn(
             "`create_rlc_boundary_on_pins` is deprecated and is now located here "
-            "`pyedb.grpc.core.create_rlc_boundary_on_pins.get_ports_number` instead.",
+            "`pyedb.grpc.core.excitations.create_rlc_boundary_on_pins` instead.",
             DeprecationWarning,
         )
         return self._pedb.source_excitation.create_rlc_boundary_on_pins(
@@ -1208,34 +1207,37 @@ class Hfss(object):
         step_freq=1e6,
         discrete_sweep=False,
     ) -> HfssSimulationSetup:
-        """Add a HFSS analysis to EDB.
+        """Add HFSS analysis setup.
 
         Parameters
         ----------
         name : str, optional
-            Setup name.
-        Sweep type. `"interpolating"` or `"discrete"`.
+            Setup name (auto-generated if None).
         distribution : str, optional
-            Type of the sweep. The default is `"linear"`. Options are:
-            - `"linear"`
-            - `"linear_count"`
-            - `"decade_count"`
-            - `"octave_count"`
-            - `"exponential"`
-        start_freq : str, float, optional
-            Starting frequency. The default is ``0``.
-        stop_freq : str, float, optional
-            Stopping frequency. The default is ``20e9``.
-        step_freq : str, float, int, optional
-            Frequency step. The default is ``1e6``. or used for `"decade_count"`, "linear_count"`, "octave_count"`
-            distribution. Must be integer in that case.
+            Sweep distribution type ("linear", "linear_count", "decade_count", "octave_count", "exponential").
+        start_freq : float, str, optional
+            Starting frequency (Hz).
+        stop_freq : float, str, optional
+            Stopping frequency (Hz).
+        step_freq : float, str, int, optional
+            Frequency step (Hz) or count depending on distribution.
         discrete_sweep : bool, optional
-            Whether the sweep is discrete. The default is ``False``.
+            Use discrete sweep.
 
         Returns
         -------
-        :class:`HfssSimulationSetup`
-            Setup object class.
+        HfssSimulationSetup
+            Created setup object.
+
+        Examples
+        --------
+        >>> hfss_setup = edb.hfss.add_setup(
+        ...     name="MySetup",
+        ...     distribution="linear_count",
+        ...     start_freq=1e9,
+        ...     stop_freq=10e9,
+        ...     step_freq=100,
+        ... )
         """
         from ansys.edb.core.simulation_setup.hfss_simulation_setup import (
             HfssSimulationSetup as GrpcHfssSimulationSetup,