pyedb 0.8.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

pyedb/__init__.py

@@ -44,7 +44,7 @@ deprecation_warning()
 #
 
 pyedb_path = os.path.dirname(__file__)
-__version__ = "0.8.1"
+__version__ = "0.9.0"
 version = __version__
 
 #

pyedb/dotnet/edb.py

@@ -57,6 +57,9 @@ from pyedb.dotnet.edb_core.edb_data.ports import (
     GapPort,
     WavePort,
 )
+from pyedb.dotnet.edb_core.edb_data.raptor_x_simulation_setup_data import (
+    RaptorXSimulationSetup,
+)
 from pyedb.dotnet.edb_core.edb_data.simulation_configuration import (
     SimulationConfiguration,
 )
@@ -174,15 +177,16 @@ class Edb(Database):
 
     def __init__(
         self,
-        edbpath=None,
-        cellname=None,
-        isreadonly=False,
-        edbversion=None,
-        isaedtowned=False,
+        edbpath: str = None,
+        cellname: str = None,
+        isreadonly: bool = False,
+        edbversion: str = None,
+        isaedtowned: bool = False,
         oproject=None,
-        student_version=False,
-        use_ppe=False,
-        technology_file=None,
+        student_version: bool = False,
+        use_ppe: bool = False,
+        technology_file: str = None,
+        remove_existing_aedt: bool = False,
     ):
         edbversion = get_string_version(edbversion)
         self._clean_variables()
@@ -213,17 +217,8 @@ class Edb(Database):
                 os.path.dirname(edbpath),
                 "pyedb_" + os.path.splitext(os.path.split(edbpath)[-1])[0] + ".log",
             )
-            aedt_file = os.path.splitext(edbpath)[0] + ".aedt"
-            files = [aedt_file, aedt_file + ".lock"]
-            for file in files:
-                if os.path.isfile(file):
-                    try:
-                        shutil.rmtree(file)
-                        self.logger.info(f"Removing {file} to allow loading EDB file.")
-                    except:
-                        self.logger.info(
-                            f"Failed to delete {file} which is located at the same location as the EDB file."
-                        )
+            if not isreadonly:
+                self._check_remove_project_files(edbpath, remove_existing_aedt)
 
         if isaedtowned and (inside_desktop or settings.remote_rpc_session):
             self.open_edb_inside_aedt()
@@ -311,6 +306,22 @@ class Edb(Database):
         if description:  # Add the variable description if a two-item list is passed for variable_value.
             self.__getitem__(variable_name).description = description
 
+    def _check_remove_project_files(self, edbpath: str, remove_existing_aedt: bool) -> None:
+        aedt_file = os.path.splitext(edbpath)[0] + ".aedt"
+        files = [aedt_file, aedt_file + ".lock"]
+        for file in files:
+            if os.path.isfile(file):
+                if not remove_existing_aedt:
+                    self.logger.warning(
+                        f"AEDT project-related file {file} exists and may need to be deleted before opening the EDB in HFSS 3D Layout."  # noqa: E501
+                    )
+                else:
+                    try:
+                        os.unlink(file)
+                        self.logger.info(f"Deleted AEDT project-related file {file}.")
+                    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._materials = None
@@ -3584,6 +3595,8 @@ class Edb(Database):
                 setups[i.GetName()] = SiwaveSYZSimulationSetup(self, i)
             elif i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kSIWaveDCIR:
                 setups[i.GetName()] = SiwaveDCSimulationSetup(self, i)
+            elif i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kRaptorX:
+                setups[i.GetName()] = RaptorXSimulationSetup(self, i)
         return setups
 
     @property
@@ -3639,9 +3652,35 @@ class Edb(Database):
         if name in self.setups:
             self.logger.info("setup already exists")
             return False
+        elif not name:
+            name = generate_unique_name("setup")
         setup = HfssSimulationSetup(self).create(name)
         return setup
 
+    def create_raptorx_setup(self, name=None):
+        """Create an RaptorX simulation setup from a template.
+
+        Parameters
+        ----------
+        name : str, optional
+            Setup name.
+
+        Returns
+        -------
+        :class:`legacy.edb_core.edb_data.raptor_x_simulation_setup_data.RaptorXSimulationSetup`
+
+        """
+        if name in self.setups:
+            self.logger.error("Setup name already used in the layout")
+            return False
+        version = self.edbversion.split(".")
+        if int(version[0]) >= 2024 and int(version[-1]) >= 2 or int(version[0]) > 2024:
+            setup = RaptorXSimulationSetup(self).create(name)
+            return setup
+        else:
+            self.logger.error("RaptorX simulation only supported with Ansys release 2024R2 and higher")
+            return False
+
     @pyedb_function_handler()
     def create_siwave_syz_setup(self, name=None):
         """Create a setup from a template.

pyedb/dotnet/edb_core/edb_data/raptor_x_simulation_setup_data.py

@@ -0,0 +1,520 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNE SS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.edb_data.edbvalue import EdbValue
+from pyedb.dotnet.edb_core.general import convert_py_list_to_net_list
+from pyedb.dotnet.edb_core.utilities.simulation_setup import (
+    BaseSimulationSetup,
+    EdbFrequencySweep,
+)
+from pyedb.generic.data_handlers import pyedb_function_handler
+from pyedb.generic.general_methods import generate_unique_name
+
+
+class RaptorXSimulationSetup(BaseSimulationSetup):
+    """Manages EDB methods for RaptorX simulation setup."""
+
+    def __init__(self, pedb, edb_object=None):
+        super().__init__(pedb, edb_object)
+        self._pedb = pedb
+        self._setup_type = "kRaptorX"
+        self._edb_setup_info = None
+        self.logger = self._pedb.logger
+
+    @pyedb_function_handler
+    def create(self, name=None):
+        """Create an HFSS setup."""
+        self._name = name
+        self._create(name)
+        return self
+
+    @property
+    def setup_type(self):
+        return self._setup_type
+
+    @property
+    def settings(self):
+        return RaptorXSimulationSettings(self._edb_setup_info, self._pedb)
+
+    @property
+    def enabled(self):
+        return self.settings.enabled
+
+    @enabled.setter
+    def enabled(self, value):
+        self.settings.enabled = value
+
+    @property
+    def position(self):
+        return self._edb_setup_info.Position
+
+    @position.setter
+    def position(self, value):
+        if isinstance(value, int):
+            self._edb_setup_info.Position = value
+        else:
+            self.logger.error(f"RaptorX setup position input setter must be an integer. Provided value {value}")
+
+    @property
+    def frequency_sweeps(self):
+        return list(self._edb_setup_info.SweepDataList)
+
+    @pyedb_function_handler()
+    def add_frequency_sweep(self, name=None, frequency_sweep=None):
+        """Add frequency sweep.
+
+        Parameters
+        ----------
+        name : str, optional
+            Name of the frequency sweep.
+        frequency_sweep : list, optional
+            List of frequency points.
+
+        Returns
+        -------
+        :class:`pyedb.dotnet.edb_core.edb_data.hfss_simulation_setup_data.EdbFrequencySweep`
+
+        Examples
+        --------
+        >>> setup1 = edbapp.create_hfss_setup("setup1")
+        >>> setup1.add_frequency_sweep(frequency_sweep=[
+        ...                           ["linear count", "0", "1kHz", 1],
+        ...                           ["log scale", "1kHz", "0.1GHz", 10],
+        ...                           ["linear scale", "0.1GHz", "10GHz", "0.1GHz"],
+        ...                           ])
+        """
+        if name in self.frequency_sweeps:
+            return False
+        if not name:
+            name = generate_unique_name("sweep")
+        return EdbFrequencySweep(self, frequency_sweep, name)
+
+
+class RaptorXSimulationSettings(object):
+    def __init__(self, edb_setup_info, pedb):
+        self._pedb = pedb
+        self.logger = self._pedb.logger
+        self._edb_setup_info = edb_setup_info
+        self._simulation_settings = edb_setup_info.SimulationSettings
+        self._general_settings = RaptorXGeneralSettings(self._edb_setup_info, self._pedb)
+        self._advanced_settings = RaptorXSimulationAdvancedSettings(self._edb_setup_info, self._pedb)
+        self._simulation_settings = self._edb_setup_info.SimulationSettings
+
+    @property
+    def general_settings(self):
+        return self._general_settings
+
+    @property
+    def advanced_settings(self):
+        return self._advanced_settings
+
+    @property
+    def enabled(self):
+        return self._simulation_settings.Enabled
+
+    @enabled.setter
+    def enabled(self, value):
+        if isinstance(value, bool):
+            self._simulation_settings.Enabled = value
+        else:
+            self.logger.error(f"RaptorX setup enabled setter input must be a boolean. Provided value {value}")
+
+
+class RaptorXGeneralSettings(object):
+    def __init__(self, edb_setup_info, pedb):
+        self._general_settings = edb_setup_info.SimulationSettings.GeneralSettings
+        self._pedb = pedb
+        self.logger = self._pedb.logger
+
+    @property
+    def global_temperature(self):
+        """The simulation temperature. Units: C"""
+        return self._general_settings.GlobalTemperature
+
+    @global_temperature.setter
+    def global_temperature(self, value):
+        self._general_settings.GlobalTemperature = EdbValue(value).tofloat
+
+    @property
+    def max_frequency(self):
+        return self._general_settings.MaxFrequency
+
+    @max_frequency.setter
+    def max_frequency(self, value):
+        """This allows user to specify the maximum simulation frequency, a parameter which controls how tight the model
+        mesh will be. User can override the default meshing frequency as defined by Max Frequency using the Advanced
+        settings > MeshFrequency. Example: "10GHz".
+        """
+        self._general_settings.MaxFrequency = EdbValue(value).tostring
+
+
+class RaptorXSimulationAdvancedSettings(object):
+    def __init__(self, edb_setup_info, pedb):
+        self._edb_setup_info = edb_setup_info
+        self._advanced_settings = edb_setup_info.SimulationSettings.AdvancedSettings
+        self._pedb = pedb
+        self.logger = self._pedb.logger
+
+    @property
+    def auto_removal_sliver_poly(self):
+        return self._advanced_settings.AutoRemovalSliverPoly
+
+    @auto_removal_sliver_poly.setter
+    def auto_removal_sliver_poly(self, value):
+        self._advanced_settings.AutoRemovalSliverPoly = EdbValue(value).tofloat
+
+    @property
+    def cell_per_wave_length(self):
+        """This setting describes the number of cells that fit under each wavelength. The wavelength is
+        calculated according to the Max Frequency or the Mesh Frequency, unless specified by user through
+        this setting. E.g. Setting Cells/Wavelength to 20 means that an object will be divided into 10 cells
+        if its width or length is 1/2 wavelengths.
+        Units: unitless.
+        """
+        return self._advanced_settings.CellsPerWavelength
+
+    @cell_per_wave_length.setter
+    def cell_per_wave_length(self, value):
+        if isinstance(value, int):
+            self._advanced_settings.CellsPerWavelength = value
+        else:
+            self.logger.error(f"RaptorX cell_per_wave_length setter input must be an integer, value provided {value}")
+
+    @property
+    def edge_mesh(self):
+        """This option controls both, the thickness and the width of the exterior conductor filament.
+        When specified, it prevails over the Mesh Frequency or Max Frequency during mesh calculation.
+        Example: "0.8um".
+        """
+        return self._advanced_settings.EdgeMesh
+
+    @edge_mesh.setter
+    def edge_mesh(self, value):
+        self._advanced_settings.EdgeMesh = EdbValue(value).tostring
+
+    @property
+    def eliminate_slit_per_hole(self):
+        """This is a setting that internally simplifies layouts with strain relief or thermal relief slits and
+        holes. It will examine each hole separately against the whole polygon it belongs to.
+        If the area of the hole is below the threshold defined in this setting, then the hole will be filled.
+        Units: unitless.
+        """
+        return self._advanced_settings.EliminateSlitPerHoles
+
+    @eliminate_slit_per_hole.setter
+    def eliminate_slit_per_hole(self, value):
+        self._advanced_settings.EliminateSlitPerHoles = EdbValue(value).tofloat
+
+    @property
+    def mesh_frequency(self):
+        """User can override the default meshing applied by setting a custom frequency for mesh generation.
+        Example: "1GHz".
+        """
+        return self._advanced_settings.MeshFrequency
+
+    @mesh_frequency.setter
+    def mesh_frequency(self, value):
+        self._advanced_settings.MeshFrequency = EdbValue(value).tostring
+
+    @property
+    def net_settings_options(self):
+        """A list of Name, Value pairs that stores advanced option."""
+        return [val for val in list(self._advanced_settings.NetSettingsOptions)]
+
+    @net_settings_options.setter
+    def net_settings_options(self, value):
+        if isinstance(value, list):
+            self._advanced_settings.NetSettingsOptions = convert_py_list_to_net_list(value)
+        else:
+            self.logger.error(
+                f"RaptorX setup net_settings_options input setter must be a list. " f"Provided value {value}"
+            )
+
+    @property
+    def override_shrink_fac(self):
+        """Set the shrink factor explicitly, that is, review what-if scenarios of migrating to half-node
+        technologies.
+        Units: unitless.
+        """
+        return self._advanced_settings.OverrideShrinkFac
+
+    @override_shrink_fac.setter
+    def override_shrink_fac(self, value):
+        self._advanced_settings.OverrideShrinkFac = EdbValue(value).tofloat
+
+    @property
+    def plane_projection_factor(self):
+        """To eliminate unnecessary mesh complexity of "large" metal planes and improve overall extraction time,
+        user can define the mesh of certain planes using a combination of the Plane Projection Factor and
+        settings of the Nets Advanced Options.
+        Units: unitless.
+        """
+        return self._advanced_settings.PlaneProjectionFactor
+
+    @plane_projection_factor.setter
+    def plane_projection_factor(self, value):
+        self._advanced_settings.PlaneProjectionFactor = EdbValue(value).tofloat
+
+    @property
+    def use_accelerate_via_extraction(self):
+        """Setting this option will simplify/merge neighboring vias before sending the layout for processing
+        to the mesh engine and to the EM engine.
+        """
+        return self._advanced_settings.UseAccelerateViaExtraction
+
+    @use_accelerate_via_extraction.setter
+    def use_accelerate_via_extraction(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseAccelerateViaExtraction = value
+        else:
+            self.logger.error(
+                "RaptorX setup use_accelerate_via_extraction setter input must be boolean." f"Provided value {value}"
+            )
+
+    @property
+    def use_auto_removal_sliver_poly(self):
+        """Setting this option simplifies layouts by aligning slightly misaligned overlapping polygons."""
+        return self._advanced_settings.UseAutoRemovalSliverPoly
+
+    @use_auto_removal_sliver_poly.setter
+    def use_auto_removal_sliver_poly(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseAutoRemovalSliverPoly = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_auto_removal_sliver_poly setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_cells_per_wavelength(self):
+        """This setting describes the number of cells that fit under each wavelength. The wavelength is calculated
+        according to the Max Frequency or the Mesh Frequency, unless specified by user through this setting.
+        """
+        return self._advanced_settings.UseCellsPerWavelength
+
+    @use_cells_per_wavelength.setter
+    def use_cells_per_wavelength(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseCellsPerWavelength = value
+        else:
+            self.logger.error(f"RaptorX setup use_cells_per_wavelength setter must be boolean. Provided value {value}")
+
+    @property
+    def use_edge_mesh(self):
+        """This option controls both, the thickness and the width of the exterior conductor filament.
+        When checked, it prevails over the Mesh Frequency or Max Frequency during mesh calculation.
+        """
+        return self._advanced_settings.UseEdgeMesh
+
+    @use_edge_mesh.setter
+    def use_edge_mesh(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseEdgeMesh = value
+        else:
+            self.logger.error(f"RaptorX setup use_edge_mesh setter must be a boolean. Provided value {value}")
+
+    @property
+    def use_eliminate_slit_per_holes(self):
+        """This is a setting that internally simplifies layouts with strain relief or thermal relief slits and
+        holes.
+        """
+        return self._advanced_settings.UseEliminateSlitPerHoles
+
+    @use_eliminate_slit_per_holes.setter
+    def use_eliminate_slit_per_holes(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseEliminateSlitPerHoles = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_eliminate_slit_per_holes setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_enable_advanced_cap_effects(self):
+        """Applies all the capacitance related effects such as Conformal Dielectrics, Loading Effect,
+        Dielectric Damage.
+        """
+        return self._advanced_settings.UseEnableAdvancedCapEffects
+
+    @use_enable_advanced_cap_effects.setter
+    def use_enable_advanced_cap_effects(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseEnableAdvancedCapEffects = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_enable_advanced_cap_effects setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_enable_etch_transform(self):
+        """Pre-distorts the layout based on the foundry rules, applying the conductor's bias (positive/negative –
+        deflation/inflation) at the conductor edges due to unavoidable optical effects in the manufacturing process.
+        """
+        return self._advanced_settings.UseEnableEtchTransform
+
+    @use_enable_etch_transform.setter
+    def use_enable_etch_transform(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseEnableEtchTransform = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_enable_etch_transform setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_enable_hybrid_extraction(self):
+        """This setting allows the modelling engine to separate the layout into two parts in an attempt to
+        decrease the complexity of EM modelling.
+        """
+        return self._edb_setup_info.UseEnableHybridExtraction
+
+    @use_enable_hybrid_extraction.setter
+    def use_enable_hybrid_extraction(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseEnableHybridExtraction = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_enable_hybrid_extraction setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_enable_substrate_network_extraction(self):
+        """This setting models substrate coupling effects using an equivalent distributed RC network."""
+        return self._advanced_settings.UseEnableSubstrateNetworkExtraction
+
+    @use_enable_substrate_network_extraction.setter
+    def use_enable_substrate_network_extraction(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseEnableSubstrateNetworkExtraction = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_enable_substrate_network_extraction setter must be a boolean. "
+                f"Provided value {value}"
+            )
+
+    @property
+    def use_extract_floating_metals_dummy(self):
+        """Enables modeling of floating metals as dummy fills. Captures the effect of dummy fill by extracting
+        the effective capacitance between any pairs of metal segments in the design, in the presence of each
+        individual dummy metal islands. This setting cannot be used with UseExtractFloatingMetalsFloating.
+        """
+        return self._advanced_settings.UseExtractFloatingMetalsDummy
+
+    @use_extract_floating_metals_dummy.setter
+    def use_extract_floating_metals_dummy(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseExtractFloatingMetalsDummy = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_extract_floating_metals_dummy setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_extract_floating_metals_floating(self):
+        """Enables modeling of floating metals as floating nets. Floating metal are grouped into a single entity
+        and treated as an independent net. This setting cannot be used with UseExtractFloatingMetalsDummy.
+        """
+        return self._advanced_settings.UseExtractFloatingMetalsFloating
+
+    @use_extract_floating_metals_floating.setter
+    def use_extract_floating_metals_floating(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseExtractFloatingMetalsFloating = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_extract_floating_metals_floating setter must be a boolean. "
+                f"Provided value {value}"
+            )
+
+    @property
+    def use_lde(self):
+        """
+        Takes into account the variation of resistivity as a function of a conductor’s drawn width and spacing to
+        its neighbors or as a function of its local density, due to dishing, slotting, cladding thickness, and so
+        on.
+        """
+        return self._advanced_settings.UseLDE
+
+    @use_lde.setter
+    def use_lde(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseLDE = value
+        else:
+            self.logger.error(f"RaptorX setup use_lde setter must be a boolean. Provided value {value}")
+
+    @property
+    def use_mesh_frequency(self):
+        """
+        User can override the default meshing applied by the mesh engine by checking this option and setting a
+        custom frequency for mesh generation.
+        """
+        return self._advanced_settings.UseMeshFrequency
+
+    @use_mesh_frequency.setter
+    def use_mesh_frequency(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseMeshFrequency = value
+        else:
+            self.logger.error(f"RaptorX setup use_mesh_frequency setter must be a boolean. Provided value {value}")
+
+    @property
+    def use_override_shrink_fac(self):
+        """Set the shrink factor explicitly, that is, review what-if scenarios of migrating to half-node
+        technologies.
+        """
+        return self._advanced_settings.UseOverrideShrinkFac
+
+    @use_override_shrink_fac.setter
+    def use_override_shrink_fac(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseOverrideShrinkFac = value
+        else:
+            self.logger.error(f"RaptorX setup use_override_shrink_fac setter must be a boolean. Provided value {value}")
+
+    @property
+    def use_plane_projection_factor(self):
+        """To eliminate unnecessary mesh complexity of "large" metal planes and improve overall
+        extraction time, user can define the mesh of certain planes using a combination of the Plane Projection
+        Factor and settings of the Nets Advanced Options.
+        """
+        return self._advanced_settings.UsePlaneProjectionFactor
+
+    @use_plane_projection_factor.setter
+    def use_plane_projection_factor(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UsePlaneProjectionFactor = value
+        else:
+            self.logger.error(
+                f"RaptorX setup use_plane_projection_factor setter must be a boolean. " f"Provided value {value}"
+            )
+
+    @property
+    def use_relaxed_z_axis(self):
+        """Enabling this option provides a simplified mesh along the z-axis."""
+        return self._advanced_settings.UseRelaxedZAxis
+
+    @use_relaxed_z_axis.setter
+    def use_relaxed_z_axis(self, value):
+        if isinstance(value, bool):
+            self._advanced_settings.UseRelaxedZAxis = value
+        else:
+            self.logger.error(f"RaptorX setup use_relaxed_z_axis setter must be a boolean. " f"Provided value {value}")

pyedb/dotnet/edb_core/padstack.py

@@ -26,6 +26,8 @@ This module contains the `EdbPadstacks` class.
 import math
 import warnings
 
+import rtree
+
 from pyedb.dotnet.clr_module import Array
 from pyedb.dotnet.edb_core.edb_data.padstacks_data import (
     EDBPadstack,
@@ -1460,3 +1462,54 @@ class EdbPadstacks(object):
             pin_dict = {GeometryOperators.points_distance(positive_pin.position, p.position): p for p in pinlist}
             pinlist = [pin[1] for pin in sorted(pin_dict.items())[:max_limit]]
         return pinlist
+
+    @pyedb_function_handler()
+    def get_padstack_instances_rtree_index(self, nets=None):
+        """Returns padstack instances Rtree index.
+
+        Parameters
+        ----------
+        nets : str or list, optional
+            net name of list of nets name applying filtering on padstack instances selection. If ``None`` is provided
+            all instances are included in the index. Default value is ``None``.
+
+        Returns
+        -------
+        Rtree index object.
+
+        """
+        if isinstance(nets, str):
+            nets = [nets]
+        padstack_instances_index = rtree.index.Index()
+        if nets:
+            instances = [inst for inst in list(self.instances.values()) if inst.net_name in nets]
+        else:
+            instances = list(self.instances.values())
+        for inst in instances:
+            padstack_instances_index.insert(inst.id, inst.position)
+        return padstack_instances_index
+
+    @pyedb_function_handler()
+    def get_padstack_instances_intersecting_bounding_box(self, bounding_box, nets=None):
+        """Returns the list of padstack instances ID intersecting a given bounding box and nets.
+
+        Parameters
+        ----------
+        bounding_box : tuple or list.
+            bounding box, [x1, y1, x2, y2]
+        nets : str or list, optional
+            net name of list of nets name applying filtering on padstack instances selection. If ``None`` is provided
+            all instances are included in the index. Default value is ``None``.
+
+        Returns
+        -------
+        List of padstack instances ID intersecting the bounding box.
+        """
+        if not bounding_box:
+            raise Exception("No bounding box was provided")
+        index = self.get_padstack_instances_rtree_index(nets=nets)
+        if not len(bounding_box) == 4:
+            raise Exception("The bounding box length must be equal to 4")
+        if isinstance(bounding_box, list):
+            bounding_box = tuple(bounding_box)
+        return list(index.intersection(bounding_box))

pyedb/dotnet/edb_core/utilities/simulation_setup.py

@@ -56,6 +56,7 @@ class BaseSimulationSetup(object):
             "kDDRwizard": None,
             "kQ3D": None,
             "kNumSetupTypes": None,
+            "kRaptorX": self._pedb.simsetupdata.RaptorX.RaptorXSimulationSettings,
         }
         if self._edb_object:
             self._name = self._edb_object.GetName()
@@ -72,6 +73,8 @@ class BaseSimulationSetup(object):
         setup_type = self._setup_type_mapping[self._setup_type]
         edb_setup_info = self._pedb.simsetupdata.SimSetupInfo[setup_type]()
         edb_setup_info.Name = name
+        if edb_setup_info.get_SimSetupType().ToString() == "kRaptorX":
+            self._edb_setup_info = edb_setup_info
         self._edb_object = self._set_edb_setup_info(edb_setup_info)
         self._update_setup()
 
@@ -96,6 +99,9 @@ class BaseSimulationSetup(object):
             "kQ3D": None,
             "kNumSetupTypes": None,
         }
+        version = self._pedb.edbversion.split(".")
+        if int(version[0]) == 2024 and int(version[1]) == 2 or int(version[0]) > 2024:
+            setup_type_mapping["kRaptorX"] = utility.RaptorXSimulationSetup
         setup_utility = setup_type_mapping[self._setup_type]
         return setup_utility(edb_setup_info)
 
@@ -122,9 +128,8 @@ class BaseSimulationSetup(object):
 
     @enabled.setter
     def enabled(self, value):
-        edb_setup_info = self.get_sim_setup_info
-        edb_setup_info.SimulationSettings.Enabled = value
-        self._edb_object = self._set_edb_setup_info(edb_setup_info)
+        self.get_sim_setup_info.SimulationSettings.Enabled = value
+        self._edb_object = self._set_edb_setup_info(self.get_sim_setup_info)
         self._update_setup()
 
     @property
@@ -175,9 +180,12 @@ class BaseSimulationSetup(object):
         sweep_data: EdbFrequencySweep
         """
         self._sweep_list[sweep_data.name] = sweep_data
-        edb_setup_info = self.get_sim_setup_info
+        if self.setup_type == "kRaptorX":
+            edb_setup_info = self._edb_setup_info
+        else:
+            edb_setup_info = self.get_sim_setup_info
 
-        if self._setup_type in ["kSIwave", "kHFSS"]:
+        if self._setup_type in ["kSIwave", "kHFSS", "kRaptorX"]:
             for _, v in self._sweep_list.items():
                 edb_setup_info.SweepDataList.Add(v._edb_object)
 
@@ -197,14 +205,13 @@ class BaseSimulationSetup(object):
             self._sweep_list.pop(name)
 
         fsweep = []
-        for k, val in self.frequency_sweeps.items():
-            if not k == name:
-                fsweep.append(val)
-        self.get_sim_setup_info.SweepDataList.Clear()
-        for i in fsweep:
-            self.get_sim_setup_info.SweepDataList.Add(i._edb_object)
-        self._update_setup()
-        return True if name in self.frequency_sweeps else False
+        if self.frequency_sweeps:
+            fsweep = [val for key, val in self.frequency_sweeps.items() if not key == name]
+            self.get_sim_setup_info.SweepDataList.Clear()
+            for i in fsweep:
+                self.get_sim_setup_info.SweepDataList.Add(i._edb_object)
+            self._update_setup()
+            return True if name in self.frequency_sweeps else False
 
     @pyedb_function_handler()
     def add_frequency_sweep(self, name=None, frequency_sweep=None):
@@ -722,6 +729,8 @@ class EdbFrequencySweep(object):
                 ["linear scale", "0.1GHz", "10GHz", "0.1GHz"],
             ]
         temp = []
+        if isinstance(frequency_list, list) and not isinstance(frequency_list[0], list):
+            frequency_list = [frequency_list]
         for i in frequency_list:
             if i[0] == "linear count":
                 temp.extend(list(self._edb_sweep_data.SetFrequencies(i[1], i[2], i[3])))

{pyedb-0.8.1.dist-info → pyedb-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyedb
-Version: 0.8.1
+Version: 0.9.0
 Summary: Higher-Level Pythonic Ansys Electronics Data Base
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: PyEDB developers <simon.vandenbrouck@ansys.com>
@@ -21,6 +21,7 @@ Requires-Dist: ansys-pythonnet >= 3.1.0rc3
 Requires-Dist: dotnetcore2 ==3.1.23;platform_system=='Linux'
 Requires-Dist: pydantic>=2.6.4,<2.8
 Requires-Dist: toml == 0.10.2
+Requires-Dist: Rtree >= 1.2.0
 Requires-Dist: ansys-sphinx-theme>=0.10.0,<0.16 ; extra == "doc"
 Requires-Dist: imageio>=2.30.0,<2.35 ; extra == "doc"
 Requires-Dist: ipython>=8.13.0,<8.24 ; extra == "doc"

{pyedb-0.8.1.dist-info → pyedb-0.9.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-pyedb/__init__.py,sha256=E32CaYS36_mPebFR8emGgxai-TPaWHCWwE9WpMwLBIs,1520
+pyedb/__init__.py,sha256=-PeC-ezpiaDf1K0QUwu4B6kfQtg_3GxtEASzpnqsK2c,1520
 pyedb/edb_logger.py,sha256=yNkXnoL2me7ubLT6O6r6ElVnkZ1g8fmfFYC_2XJZ1Sw,14950
 pyedb/exceptions.py,sha256=n94xluzUks6BA24vd_L6HkrvoP_H_l6__hQmqzdCyPo,111
 pyedb/siwave.py,sha256=ilUsA74QKy7VpRfmfvRrcVZhPAsyfgXHZm0SDDHiGBE,11576
 pyedb/dotnet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyedb/dotnet/clr_module.py,sha256=Mo13Of3DVSA5HR-5xZEXOiHApIKy52CUxtJ2gPkEu1A,3406
-pyedb/dotnet/edb.py,sha256=wbzl9083scWVoWkYG5lQshBPuTnQlIiBq0P8x9zblik,169971
+pyedb/dotnet/edb.py,sha256=OqZ7-tBRkzvgZLxELBW6b9BIJ8l2Eil6BIPA_1pj274,171632
 pyedb/dotnet/application/Variables.py,sha256=nov1kIyJO25iz8pvbU3MK1meMpRLwtISmzYqJhc7Ouo,79042
 pyedb/dotnet/application/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyedb/dotnet/edb_core/__init__.py,sha256=nIRLJ8VZLcMAp12zmGsnZ5x2BEEl7q_Kj_KAOXxVjpQ,52
@@ -18,7 +18,7 @@ pyedb/dotnet/edb_core/materials.py,sha256=xYfud7EWDmK6O_hvANRqzFjp8ZqJdM0AJ8KYhU
 pyedb/dotnet/edb_core/net_class.py,sha256=lr-7Z0Q1A2fshxwjrIOmQSZnEBYe0NoxuUuJT6vYdyA,11857
 pyedb/dotnet/edb_core/nets.py,sha256=EK-jjRFvRX_NtqMQ46ebJbv9HOvP1uYK_EZ3jPnmxB0,43882
 pyedb/dotnet/edb_core/obj_base.py,sha256=lufR0sZj0QfZ2wlNvLL6aM1KVqCNY2A7taPPdWcK20w,3312
-pyedb/dotnet/edb_core/padstack.py,sha256=XT7S_RgOtYAr4G67EKXbbxsDeb6wMHC6Y_YMDljuMR4,54540
+pyedb/dotnet/edb_core/padstack.py,sha256=h9NYecM5_Z00KeMkli-Sm97btbvnJsz2COSmyWfoVHA,56581
 pyedb/dotnet/edb_core/siwave.py,sha256=wdLAKiz0Qhiktz3OPekBQtw_y2Kb8Vyk19QdF-FcUVU,62356
 pyedb/dotnet/edb_core/stackup.py,sha256=vFHc9uroqdb193uHHNVRa1rxy-9Oe76eQZ98X2Kfx54,115372
 pyedb/dotnet/edb_core/cell/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -47,6 +47,7 @@ pyedb/dotnet/edb_core/edb_data/nets_data.py,sha256=iULEOUsn3sfLT5FVY_4lMWTm0KzC-
 pyedb/dotnet/edb_core/edb_data/padstacks_data.py,sha256=T7m7s5KAZB-gZ9wrPw6k2Yoon6uwCfJSOeg2hvyX1LI,78754
 pyedb/dotnet/edb_core/edb_data/ports.py,sha256=FYxB2rDUtN_OsYAbodXbc5mA_d0BUebmin_B5kkUw3U,9223
 pyedb/dotnet/edb_core/edb_data/primitives_data.py,sha256=veMDPCb6T84KZ_xgo52g7vHxObsx-Y2ysWXBS2CqZpQ,48155
+pyedb/dotnet/edb_core/edb_data/raptor_x_simulation_setup_data.py,sha256=FPQ1myUhmBAyyAsqPQZnr0Y-_k-tvq-JhQtESp3ea0g,21065
 pyedb/dotnet/edb_core/edb_data/simulation_configuration.py,sha256=0U5sHLn8rvQFOveRQE3Y84TGk0-DUfOnbvEO6Iffya4,99967
 pyedb/dotnet/edb_core/edb_data/siwave_simulation_setup_data.py,sha256=fPmdhh6t6HM2pE_mQCT0ZQYO-PkqhwumwiuRUNEn00Q,42354
 pyedb/dotnet/edb_core/edb_data/sources.py,sha256=XmdpOdlpBa3QiYFY0cRtVIolt4nvUR9Ptk5YnRVvU4c,15342
@@ -58,7 +59,7 @@ pyedb/dotnet/edb_core/geometry/point_data.py,sha256=hC9cRuSnX4cwg09Jr0ZK7ZTjFf_4
 pyedb/dotnet/edb_core/geometry/polygon_data.py,sha256=K1jwj6gXm4KFqrPGJmtc49bSDZl1ytmrLdJ81VEJtco,2990
 pyedb/dotnet/edb_core/utilities/__init__.py,sha256=8jByHkoaowAYQTCww-zRrTQmN061fLz_OHjTLSrzQQY,58
 pyedb/dotnet/edb_core/utilities/heatsink.py,sha256=7G7Yx9TxbL5EAiR51MnhdRiAQBVf-d0hKsXDw5OYX2Q,2220
-pyedb/dotnet/edb_core/utilities/simulation_setup.py,sha256=uQMKL4cwWQkPD53BENHF9uyt1NxtPW0dMVAOPdI8gUM,23967
+pyedb/dotnet/edb_core/utilities/simulation_setup.py,sha256=WuAY_eC3gISpp6aVcF_rgezQQqifvPdEQZGyyRUFpTY,24639
 pyedb/dotnet/sim_setup_data/data/siw_dc_ir_settings.py,sha256=urJvgBJOgF3Td527z98vdqAtBBKC3yomcAL3fOTt7xs,1931
 pyedb/generic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyedb/generic/constants.py,sha256=prWLZH0-SeBIVK6LHZ4SGZFQCofuym2TuQYfdqwhuSQ,28956
@@ -131,7 +132,7 @@ pyedb/misc/siw_feature_config/emc/net_tags.py,sha256=HVYOQacmaLr6Mvf7FqZhqbhtqJL
 pyedb/misc/siw_feature_config/emc/tag_library.py,sha256=yUK4w3hequU017E2DbkA4KE2MWIh1R6bfJBrevlDx6g,1557
 pyedb/misc/siw_feature_config/emc/xml_generic.py,sha256=55X-V0OxWq-v7FTiDVjaZif8V_2xxsvJlJ8bs9Bf61I,2521
 pyedb/modeler/geometry_operators.py,sha256=LDqEaeerw9H8Yva-SJhX3Afdni08OciO9t5G0c_tdqs,66820
-pyedb-0.8.1.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
-pyedb-0.8.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-pyedb-0.8.1.dist-info/METADATA,sha256=msQ9v6ZCjdGNLCwZmjC71Meue38wfQiFsgJhZTJIh3M,8320
-pyedb-0.8.1.dist-info/RECORD,,
+pyedb-0.9.0.dist-info/LICENSE,sha256=qQWivZ12ETN5l3QxvTARY-QI5eoRRlyHdwLlAj0Bg5I,1089
+pyedb-0.9.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+pyedb-0.9.0.dist-info/METADATA,sha256=agt4Ryp5D6tkoEv2hdVvEvo15DvymqpK-71wsXOrTps,8350
+pyedb-0.9.0.dist-info/RECORD,,