pyedb 0.15.dev0__py3-none-any.whl → 0.17.0__py3-none-any.whl

pyedb/dotnet/edb.py

@@ -48,6 +48,7 @@ from pyedb.dotnet.edb_core.cell.terminal.padstack_instance_terminal import (
 from pyedb.dotnet.edb_core.cell.terminal.pingroup_terminal import PinGroupTerminal
 from pyedb.dotnet.edb_core.cell.terminal.point_terminal import PointTerminal
 from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+from pyedb.dotnet.edb_core.cell.voltage_regulator import VoltageRegulator
 from pyedb.dotnet.edb_core.components import Components
 from pyedb.dotnet.edb_core.dotnet.database import Database
 from pyedb.dotnet.edb_core.dotnet.layout import LayoutDotNet
@@ -57,9 +58,6 @@ from pyedb.dotnet.edb_core.edb_data.control_file import (
 )
 from pyedb.dotnet.edb_core.edb_data.design_options import EdbDesignOptions
 from pyedb.dotnet.edb_core.edb_data.edbvalue import EdbValue
-from pyedb.dotnet.edb_core.edb_data.hfss_pi_simulation_setup_data import (
-    HFSSPISimulationSetup,
-)
 from pyedb.dotnet.edb_core.edb_data.ports import (
     BundleWavePort,
     CircuitPort,
@@ -93,10 +91,13 @@ from pyedb.dotnet.edb_core.nets import EdbNets
 from pyedb.dotnet.edb_core.padstack import EdbPadstacks
 from pyedb.dotnet.edb_core.siwave import EdbSiwave
 from pyedb.dotnet.edb_core.stackup import Stackup
-from pyedb.dotnet.edb_core.utilities.simulation_setup import (
+from pyedb.dotnet.edb_core.utilities.hfss_simulation_setup import (
+    HFSSPISimulationSetup,
     HfssSimulationSetup,
+)
+from pyedb.dotnet.edb_core.utilities.siwave_simulation_setup import (
     SiwaveDCSimulationSetup,
-    SiwaveSYZSimulationSetup,
+    SiwaveSimulationSetup,
 )
 from pyedb.generic.constants import AEDT_UNITS, SolverType
 from pyedb.generic.general_methods import (
@@ -111,6 +112,7 @@ from pyedb.generic.process import SiwaveSolve
 from pyedb.generic.settings import settings
 from pyedb.ipc2581.ipc2581 import Ipc2581
 from pyedb.modeler.geometry_operators import GeometryOperators
+from pyedb.workflow import Workflow
 
 if is_linux and is_ironpython:
     import subprocessdotnet as subprocess
@@ -156,7 +158,7 @@ class Edb(Database):
     --------
     Create an ``Edb`` object and a new EDB cell.
 
-    >>> from pyedb.dotnet.edb import Edb
+    >>> from pyedb import Edb
     >>> app = Edb()
 
     Add a new variable named "s1" to the ``Edb`` instance.
@@ -510,6 +512,15 @@ class Edb(Database):
         terms = [term for term in self.layout.terminals if int(term.GetBoundaryType()) in [3, 4, 7]]
         return {ter.GetName(): ExcitationSources(self, ter) for ter in terms}
 
+    @property
+    def voltage_regulator_modules(self):
+        """Get all voltage regulator modules"""
+        vrms = [VoltageRegulator(self, edb_object) for edb_object in list(self.active_layout.VoltageRegulators)]
+        _vrms = {}
+        for vrm in vrms:
+            _vrms[vrm.name] = vrm
+        return _vrms
+
     @property
     def probes(self):
         """Get all layout probes."""
@@ -791,7 +802,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> comp = edbapp.components.get_component_by_name("J1")
         """
@@ -808,7 +819,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> comp = edbapp.components.get_component_by_name("J1")
         """
@@ -851,7 +862,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> edbapp.stackup.layers["TOP"].thickness = 4e-5
         >>> edbapp.stackup.layers["TOP"].thickness == 4e-05
@@ -869,7 +880,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb()
         >>> edbapp.materials.add_material("air", permittivity=1.0)
         >>> edbapp.materials.add_debye_material("debye_mat", 5, 3, 0.02, 0.05, 1e5, 1e9)
@@ -893,7 +904,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> p = edbapp.padstacks.create(padstackname="myVia_bullet", antipad_shape="Bullet")
         >>> edbapp.padstacks.get_pad_parameters(
@@ -915,7 +926,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> p = edbapp.padstacks.create(padstackname="myVia_bullet", antipad_shape="Bullet")
         >>> edbapp.padstacks.get_pad_parameters(
@@ -940,7 +951,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> p2 = edbapp.siwave.create_circuit_port_on_net("U2A5", "V3P3_S0", "U2A5", "GND", 50, "test")
         """
@@ -957,7 +968,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> p2 = edbapp.siwave.create_circuit_port_on_net("U2A5", "V3P3_S0", "U2A5", "GND", 50, "test")
         """
@@ -978,7 +989,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> edbapp.hfss.configure_hfss_analysis_setup(sim_config)
         """
@@ -999,7 +1010,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> sim_config = edbapp.new_simulation_configuration()
         >>> sim_config.mesh_freq = "10Ghz"
@@ -1022,7 +1033,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> edbapp.nets.find_or_create_net("GND")
         >>> edbapp.nets.find_and_fix_disjoint_nets("GND", keep_only_main_net=True)
@@ -1040,7 +1051,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb"myproject.aedb")
         >>> edbapp.nets.find_or_create_net("GND")
         >>> edbapp.nets.find_and_fix_disjoint_nets("GND", keep_only_main_net=True)
@@ -1061,7 +1072,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> edbapp.net_classes
         """
@@ -1079,7 +1090,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> edbapp.extended_nets
         """
@@ -1097,7 +1108,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> edbapp.differential_pairs
         """
@@ -1119,7 +1130,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> top_prims = edbapp.modeler.primitives_by_layer["TOP"]
         """
@@ -1136,7 +1147,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> top_prims = edbapp.modeler.primitives_by_layer["TOP"]
         """
@@ -1233,7 +1244,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb("myproject.aedb")
         >>> pin_net_name = edbapp.pins[424968329].netname
         """
@@ -1835,7 +1846,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb = Edb(r'C:\\test.aedb', edbversion="2022.2")
         >>> edb.logger.info_timer("Edb Opening")
         >>> edb.logger.reset_timer()
@@ -2451,7 +2462,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb = Edb(r'C:\\test.aedb', edbversion="2022.2")
         >>> edb.logger.info_timer("Edb Opening")
         >>> edb.logger.reset_timer()
@@ -2884,7 +2895,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb = Edb(edbpath=r"C:\temp\myproject.aedb", edbversion="2023.2")
 
         >>> options_config = {'UNITE_NETS' : 1, 'LAUNCH_Q3D' : 0}
@@ -2927,7 +2938,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb = Edb(edbpath=r"C:\temp\myproject.aedb", edbversion="2021.2")
         >>> options_config = {'UNITE_NETS' : 1, 'LAUNCH_Q3D' : 0}
         >>> edb.write_export3d_option_config_file(r"C:\temp", options_config)
@@ -2977,7 +2988,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
 
         >>> edb = Edb(edbpath=r"C:\temp\myproject.aedb", edbversion="2021.2")
 
@@ -3136,7 +3147,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb_app = Edb()
         >>> boolean_1, ant_length = edb_app.add_project_variable("my_local_variable", "1cm")
         >>> print(edb_app["$my_local_variable"])    #using getitem
@@ -3172,7 +3183,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb_app = Edb()
         >>> boolean_1, ant_length = edb_app.add_design_variable("my_local_variable", "1cm")
         >>> print(edb_app["my_local_variable"])    #using getitem
@@ -3210,7 +3221,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edb_app = Edb()
         >>> boolean, ant_length = edb_app.add_design_variable("ant_length", "1cm")
         >>> boolean, ant_length = edb_app.change_design_variable_value("ant_length", "1m")
@@ -3255,7 +3266,7 @@ class Edb(Database):
         Examples
         --------
 
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> from pyedb.dotnet.edb_core.edb_data.simulation_configuration import SimulationConfiguration
         >>> config_file = path_configuration_file
         >>> source_file = path_to_edb_folder
@@ -3455,7 +3466,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>>edb = Edb()
         >>> edb.hfss.create_edge_port_vertical(prim_1_id, ["-66mm", "-4mm"], "port_ver")
         >>> edb.hfss.create_edge_port_horizontal(
@@ -3556,7 +3567,7 @@ class Edb(Database):
             if i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kHFSS:
                 setups[i.GetName()] = HfssSimulationSetup(self, i)
             elif i.GetType() == self.edb_api.utility.utility.SimulationSetupType.kSIWave:
-                setups[i.GetName()] = SiwaveSYZSimulationSetup(self, i)
+                setups[i.GetName()] = SiwaveSimulationSetup(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:
@@ -3594,7 +3605,7 @@ class Edb(Database):
         -------
         Dict[str, :class:`legacy.edb_core.edb_data.siwave_simulation_setup_data.SiwaveSYZSimulationSetup`]
         """
-        return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSYZSimulationSetup)}
+        return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSimulationSetup)}
 
     def create_hfss_setup(self, name=None):
         """Create an HFSS simulation setup from a template.
@@ -3610,7 +3621,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb()
         >>> setup1 = edbapp.create_hfss_setup("setup1")
         >>> setup1.hfss_port_settings.max_delta_z0 = 0.5
@@ -3620,7 +3631,7 @@ class Edb(Database):
             return False
         elif not name:
             name = generate_unique_name("setup")
-        setup = HfssSimulationSetup(self).create(name)
+        setup = HfssSimulationSetup(self, name=name)
         setup.set_solution_single_frequency("1GΗz")
         return setup
 
@@ -3671,7 +3682,7 @@ class Edb(Database):
             return False
         return HFSSPISimulationSetup(self).create(name)
 
-    def create_siwave_syz_setup(self, name=None):
+    def create_siwave_syz_setup(self, name=None, **kwargs):
         """Create a setup from a template.
 
         Parameters
@@ -3685,7 +3696,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb()
         >>> setup1 = edbapp.create_siwave_syz_setup("setup1")
         >>> setup1.add_frequency_sweep(frequency_sweep=[
@@ -3698,10 +3709,12 @@ class Edb(Database):
             name = generate_unique_name("Siwave_SYZ")
         if name in self.setups:
             return False
-        SiwaveSYZSimulationSetup(self).create(name)
+        setup = SiwaveSimulationSetup(self, name=name)
+        for k, v in kwargs.items():
+            setattr(setup, k, v)
         return self.setups[name]
 
-    def create_siwave_dc_setup(self, name=None):
+    def create_siwave_dc_setup(self, name=None, **kwargs):
         """Create a setup from a template.
 
         Parameters
@@ -3715,7 +3728,7 @@ class Edb(Database):
 
         Examples
         --------
-        >>> from pyedb.dotnet.edb import Edb
+        >>> from pyedb import Edb
         >>> edbapp = Edb()
         >>> setup1 = edbapp.create_siwave_dc_setup("setup1")
         >>> setup1.mesh_bondwires = True
@@ -3725,7 +3738,9 @@ class Edb(Database):
             name = generate_unique_name("Siwave_DC")
         if name in self.setups:
             return False
-        setup = SiwaveDCSimulationSetup(self).create(name)
+        setup = SiwaveDCSimulationSetup(self, name=name)
+        for k, v in kwargs.items():
+            setattr(setup, k, v)
         return setup
 
     def calculate_initial_extent(self, expansion_factor):
@@ -4442,3 +4457,8 @@ class Edb(Database):
         from pyedb.dotnet.edb_core.definition.definitions import Definitions
 
         return Definitions(self)
+
+    @property
+    def workflow(self):
+        """Workflow class."""
+        return Workflow(self)

pyedb/dotnet/edb_core/cell/hierarchy/component.py

@@ -24,6 +24,7 @@ import logging
 import re
 import warnings
 
+from pyedb.dotnet.edb_core.cell.hierarchy.hierarchy_obj import Group
 from pyedb.dotnet.edb_core.cell.hierarchy.model import PinPairModel, SPICEModel
 from pyedb.dotnet.edb_core.cell.hierarchy.netlist_model import NetlistModel
 from pyedb.dotnet.edb_core.cell.hierarchy.pin_pair_model import PinPair
@@ -44,7 +45,7 @@ if not is_ironpython:
 from pyedb.generic.general_methods import get_filename_without_extension
 
 
-class EDBComponent(object):
+class EDBComponent(Group):
     """Manages EDB functionalities for components.
 
     Parameters
@@ -56,9 +57,9 @@ class EDBComponent(object):
 
     """
 
-    def __init__(self, pedb, cmp):
-        self._pedb = pedb
-        self.edbcomponent = cmp
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+        self.edbcomponent = edb_object
         self._layout_instance = None
         self._comp_instance = None
 
@@ -186,7 +187,10 @@ class EDBComponent(object):
     @property
     def enabled(self):
         """Get or Set the component to active mode."""
-        return self.component_property.IsEnabled()
+        if self.type.lower() in ["resistor", "capacitor", "inductor"]:
+            return self.component_property.IsEnabled()
+        else:
+            return
 
     @enabled.setter
     def enabled(self, value):
@@ -319,11 +323,11 @@ class EDBComponent(object):
         str
             Reference Designator Name.
         """
-        return self.edbcomponent.GetName()
+        return self.name
 
     @refdes.setter
     def refdes(self, name):
-        self.edbcomponent.SetName(name)
+        self.name = name
 
     @property
     def is_null(self):
@@ -395,12 +399,7 @@ class EDBComponent(object):
         """
         if self.model_type == "RLC":
             if not self._pin_pairs:
-                if self.type == "Inductor":
-                    return 1e-9
-                elif self.type == "Resistor":
-                    return 1e6
-                else:
-                    return 1
+                return
             else:
                 pin_pair = self._pin_pairs[0]
             if len([i for i in pin_pair.rlc_enable if i]) == 1:
@@ -731,10 +730,6 @@ class EDBComponent(object):
         """Set component part name."""
         self.edbcomponent.GetComponentDef().SetName(name)
 
-    @property
-    def _edb(self):
-        return self._pedb.edb_api
-
     @property
     def placement_layer(self):
         """Placement layer.

pyedb/dotnet/edb_core/cell/hierarchy/hierarchy_obj.py

@@ -0,0 +1,50 @@
+# 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,
+# FITNESS 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.
+
+import logging
+
+from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
+
+
+class HierarchyObj(Connectable):
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def component_def(self):
+        """Component definition."""
+        return self._edb_object.GetComponentDef().GetName()
+
+    @property
+    def location(self):
+        """XY Coordinates."""
+        flag, x, y = self._edb_object.GetLocation()
+        if flag:
+            return [x, y]
+        else:  # pragma no cover
+            logging.warning(f"Failed to get location of '{self.name}'.")
+            return
+
+
+class Group(HierarchyObj):
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)

pyedb/dotnet/edb_core/cell/layout.py

@@ -84,8 +84,6 @@ class Layout(EdbLayout):
 
         Parameters
         ----------
-        layout : :class:`Layout <ansys.edb.layout.Layout>`
-            Layout this bondwire will be in.
         bondwire_type : :class:`BondwireType`
             Type of bondwire: kAPDBondWire or kJDECBondWire types.
         definition_name : str
@@ -96,16 +94,12 @@ class Layout(EdbLayout):
             Bondwire width.
         material : str
             Bondwire material name.
-        start_context : :class:`CellInstance <ansys.edb.hierarchy.CellInstance>`
-            Start context: None means top level.
         start_layer_name : str
             Name of start layer.
         start_x : :class:`Value <ansys.edb.utility.Value>`
             X value of start point.
         start_y : :class:`Value <ansys.edb.utility.Value>`
             Y value of start point.
-        end_context : :class:`CellInstance <ansys.edb.hierarchy.CellInstance>`
-            End context: None means top level.
         end_layer_name : str
             Name of end layer.
         end_x : :class:`Value <ansys.edb.utility.Value>`