ansys-edb-core 0.2.dev1__tar.gz → 0.2.0.dev3__tar.gz

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-edb-core
-Version: 0.2.dev1
+Version: 0.2.0.dev3
 Summary: A python wrapper for Ansys Edb service
 Author-email: "ANSYS, Inc." <pyansys.support@ansys.com>
 Maintainer-email: PyAnsys developers <pyansys.maintainers@ansys.com>
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 License-File: LICENSE
-Requires-Dist: ansys-api-edb==0.2.dev1
+Requires-Dist: ansys-api-edb==0.2.dev4
 Requires-Dist: protobuf>=3.19.3,<5
 Requires-Dist: grpcio>=1.44.0
 Requires-Dist: Django>=4.2.16

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-edb-core"
-version = "0.2.dev1"
+version = "0.2.0.dev3"
 description = "A python wrapper for Ansys Edb service"
 readme = "README.rst"
 requires-python = ">=3.8"
@@ -25,7 +25,7 @@ classifiers = [
 
 
 dependencies = [
-    "ansys-api-edb==0.2.dev1",
+    "ansys-api-edb==0.2.dev4",
     "protobuf>=3.19.3,<5",
     "grpcio>=1.44.0",
     "Django>=4.2.16"

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/definition/material_def.py

@@ -5,6 +5,9 @@ from enum import Enum
 import ansys.api.edb.v1.material_def_pb2 as pb
 
 from ansys.edb.core.definition.dielectric_material_model import DielectricMaterialModel
+from ansys.edb.core.definition.material_property_thermal_modifier import (
+    MaterialPropertyThermalModifier,
+)
 from ansys.edb.core.edb_defs import DefinitionObjType
 from ansys.edb.core.inner import ObjBase, messages
 from ansys.edb.core.session import MaterialDefServiceStub, StubAccessor, StubType
@@ -28,10 +31,6 @@ class MaterialProperty(Enum):
     INVALID_PROPERTY = pb.INVALID_PROPERTY
 
 
-class ThermalModifier(ObjBase):
-    """Represents a thermal modifier model."""
-
-
 class MaterialDef(ObjBase):
     """Represents a material definition."""
 
@@ -236,10 +235,10 @@ class MaterialDef(ObjBase):
 
         Returns
         -------
-        ThermalModifier
+        MaterialPropertyThermalModifier
             Thermal modifier of the material definition.
         """
-        return ThermalModifier(
+        return MaterialPropertyThermalModifier(
             self.__stub.GetThermalModifier(
                 MaterialDef._property_message(self, material_property_id)
             )
@@ -253,7 +252,7 @@ class MaterialDef(ObjBase):
         material_property_id : \
         :class:`MaterialProperty`
             Property ID.
-        thermal_modifier : ThermalModifier
+        thermal_modifier : MaterialPropertyThermalModifier
             Thermal modifier to set to the material definition.
         """
         self.__stub.SetThermalModifier(
@@ -277,10 +276,10 @@ class MaterialDef(ObjBase):
 
         Returns
         -------
-        :class:`.ThermalModifier`
+        :class:`.MaterialPropertyThermalModifier`
             Anisotropic thermal modifier of the material definition.
         """
-        return ThermalModifier(
+        return MaterialPropertyThermalModifier(
             self.__stub.GetAnisotropicThermalModifier(
                 pb.MaterialDefPropertyComponentMessage(
                     materialDef=messages.edb_obj_message(self),
@@ -302,7 +301,7 @@ class MaterialDef(ObjBase):
             Property ID.
         component_id : int
             Component ID.
-        thermal_modifier : :class:`.ThermalModifier`
+        thermal_modifier : :class:`.MaterialPropertyThermalModifier`
             Anisotropic thermal modifier to set to the material definition.
         """
         self.__stub.SetAnisotropicThermalModifier(

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/definition/padstack_def_data.py

@@ -118,7 +118,7 @@ class PadstackDefData(ObjBase):
         This property is read-only.
         """
         layer_names_msg = self.__stub.GetLayerNames(self.msg).names
-        return layer_names_msg
+        return list(layer_names_msg)
 
     @property
     def layer_ids(self):
@@ -127,7 +127,7 @@ class PadstackDefData(ObjBase):
         This property is read-only.
         """
         layer_ids_msg = self.__stub.GetLayerIds(self.msg)
-        return layer_ids_msg.ids
+        return list(layer_ids_msg.ids)
 
     def add_layers(self, names):
         """

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/geometry/polygon_data.py

@@ -9,6 +9,7 @@ from ansys.api.edb.v1 import edb_defs_pb2, point_data_pb2, polygon_data_pb2, pol
 from ansys.edb.core import session
 from ansys.edb.core.geometry.arc_data import ArcData
 from ansys.edb.core.inner import messages, parser
+from ansys.edb.core.inner.utils import client_stream_iterator
 from ansys.edb.core.utility import conversions
 
 
@@ -40,6 +41,17 @@ class IntersectionType(Enum):
 class PolygonData:
     """Represents a polygon data object."""
 
+    @staticmethod
+    def _polygon_data_request_iterator(polys):
+        chunk_entry_creator = lambda poly: messages.polygon_data_message(poly)
+        chunk_entries_getter = lambda chunk: chunk.polygons
+        return client_stream_iterator(
+            polys,
+            polygon_data_pb2.PolygonDataListMessage,
+            chunk_entry_creator,
+            chunk_entries_getter,
+        )
+
     __stub: polygon_data_pb2_grpc.PolygonDataServiceStub = session.StubAccessor(
         session.StubType.polygon_data
     )
@@ -355,7 +367,7 @@ class PolygonData:
         -------
         tuple[.PointData, .PointData]
         """
-        return cls.__stub.GetBBox(messages.polygon_data_list_message(polygons))
+        return cls.__stub.GetStreamedBBox(PolygonData._polygon_data_request_iterator(polygons))
 
     @parser.to_circle
     def bounding_circle(self):

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/hierarchy/cell_instance.py

@@ -98,7 +98,7 @@ class CellInstance(hierarchy_obj.HierarchyObj):
 
         This property is read-only.
         """
-        from ansys.edb.core.terminal.terminals import TerminalInstance
+        from ansys.edb.core.terminal.terminal_instance import TerminalInstance
 
         terms = self.__stub.GetTermInsts(self.msg).items
         return [TerminalInstance(ti) for ti in terms]

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/hierarchy/pin_group.py

@@ -3,9 +3,9 @@
 from ansys.edb.core.edb_defs import LayoutObjType
 from ansys.edb.core.inner import messages
 from ansys.edb.core.inner.conn_obj import ConnObj
-from ansys.edb.core.primitive.primitive import PadstackInstance
+from ansys.edb.core.primitive.padstack_instance import PadstackInstance
 from ansys.edb.core.session import PinGroupServiceStub, StubAccessor, StubType
-from ansys.edb.core.terminal.terminals import PinGroupTerminal
+from ansys.edb.core.terminal.pin_group_terminal import PinGroupTerminal
 
 
 class PinGroup(ConnObj):

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/hierarchy/spice_model.py

@@ -1,6 +1,6 @@
 """SPICE Model."""
 from ansys.edb.core.hierarchy.model import Model
-from ansys.edb.core.inner import messages
+from ansys.edb.core.inner import messages, parser
 from ansys.edb.core.session import SpiceModelServiceStub, StubAccessor, StubType
 
 
@@ -78,3 +78,10 @@ class SPICEModel(Model):
             Terminal name.
         """
         self.__stub.RemoveTerminalPinPair(messages.string_property_message(self, terminal))
+
+    @property
+    @parser.to_string_dict
+    def terminal_pin_pairs(self):
+        """:obj:`dict` of {:obj:`str` : :obj:`str`}: A dictionary showing the mapping of terminals in the layout to \
+        pins in the spice model by name."""
+        return self.__stub.GetTerminalPinPairs(self.msg)

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/hierarchy/structure3d.py

@@ -2,8 +2,8 @@
 
 from enum import Enum
 
-import ansys.api.edb.v1.structure3d_pb2 as structure3d_pb2
-from ansys.api.edb.v1.structure3d_pb2_grpc import Structure3DServiceStub
+import ansys.api.edb.v1.structure_3d_pb2 as structure3d_pb2
+from ansys.api.edb.v1.structure_3d_pb2_grpc import Structure3DServiceStub
 
 from ansys.edb.core.hierarchy.group import Group
 from ansys.edb.core.inner import messages

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/inner/base.py

@@ -23,6 +23,8 @@ class ObjBase:
 
         This property is read-only.
         """
+        if (buffer := get_buffer()) is not None:
+            buffer.flush()
         return self.id == 0
 
     @property
@@ -46,7 +48,7 @@ class ObjBase:
         if io_mgr.is_enabled:
             if self._is_future:
                 msg.is_future = True
-            get_io_manager().active_request_edb_obj_msg_mgr.add_active_request_edb_obj_msg(msg)
+            io_mgr.active_request_edb_obj_msg_mgr.add_active_request_edb_obj_msg(msg)
         return msg
 
     @msg.setter

ansys_edb_core-0.2.0.dev3/src/ansys/edb/core/inner/factory.py

@@ -0,0 +1,161 @@
+"""This module allows for the creating of objects while avoid circular imports."""
+
+from ansys.edb.core.edb_defs import LayoutObjType
+
+_type_creator_params_dict = None
+_primitive_type_creator_params_dict = None
+_terminal_type_creator_params_dict = None
+
+
+class _CreatorParams:
+    def __init__(self, obj_type, do_cast=False):
+        self.obj_type = obj_type
+        self.do_cast = do_cast
+
+
+def _initialize_type_creator_params_dict():
+    global _type_creator_params_dict
+
+    from ansys.edb.core.hierarchy.cell_instance import CellInstance
+    from ansys.edb.core.hierarchy.group import Group
+    from ansys.edb.core.hierarchy.pin_group import PinGroup
+    from ansys.edb.core.inner.conn_obj import ConnObj
+    from ansys.edb.core.layout.voltage_regulator import VoltageRegulator
+    from ansys.edb.core.net.differential_pair import DifferentialPair
+    from ansys.edb.core.net.extended_net import ExtendedNet
+    from ansys.edb.core.net.net import Net
+    from ansys.edb.core.net.net_class import NetClass
+    from ansys.edb.core.primitive.padstack_instance import PadstackInstance
+    from ansys.edb.core.primitive.primitive import Primitive
+    from ansys.edb.core.terminal.terminal import Terminal
+    from ansys.edb.core.terminal.terminal_instance import TerminalInstance
+
+    _type_creator_params_dict = {
+        LayoutObjType.PRIMITIVE: _CreatorParams(Primitive, True),
+        LayoutObjType.PADSTACK_INSTANCE: _CreatorParams(PadstackInstance),
+        LayoutObjType.TERMINAL: _CreatorParams(Terminal, True),
+        LayoutObjType.TERMINAL_INSTANCE: _CreatorParams(TerminalInstance),
+        LayoutObjType.CELL_INSTANCE: _CreatorParams(CellInstance),
+        LayoutObjType.GROUP: _CreatorParams(Group, True),
+        LayoutObjType.PIN_GROUP: _CreatorParams(PinGroup),
+        LayoutObjType.VOLTAGE_REGULATOR: _CreatorParams(VoltageRegulator),
+        LayoutObjType.NET_CLASS: _CreatorParams(NetClass),
+        LayoutObjType.EXTENDED_NET: _CreatorParams(ExtendedNet),
+        LayoutObjType.DIFFERENTIAL_PAIR: _CreatorParams(DifferentialPair),
+        LayoutObjType.NET: _CreatorParams(Net),
+        LayoutObjType.INVALID_LAYOUT_OBJ: _CreatorParams(ConnObj),
+    }
+    return _type_creator_params_dict
+
+
+def _initialize_primitive_type_creator_params_dict():
+    global _primitive_type_creator_params_dict
+
+    from ansys.edb.core.primitive.board_bend_def import BoardBendDef
+    from ansys.edb.core.primitive.bondwire import Bondwire
+    from ansys.edb.core.primitive.circle import Circle
+    from ansys.edb.core.primitive.path import Path
+    from ansys.edb.core.primitive.polygon import Polygon
+    from ansys.edb.core.primitive.primitive import PrimitiveType
+    from ansys.edb.core.primitive.primitive_instance_collection import PrimitiveInstanceCollection
+    from ansys.edb.core.primitive.rectangle import Rectangle
+    from ansys.edb.core.primitive.text import Text
+
+    _primitive_type_creator_params_dict = {
+        PrimitiveType.BOARD_BEND: _CreatorParams(BoardBendDef),
+        PrimitiveType.BONDWIRE: _CreatorParams(Bondwire),
+        PrimitiveType.CIRCLE: _CreatorParams(Circle),
+        PrimitiveType.PATH: _CreatorParams(Path),
+        PrimitiveType.POLYGON: _CreatorParams(Polygon),
+        PrimitiveType.RECTANGLE: _CreatorParams(Rectangle),
+        PrimitiveType.TEXT: _CreatorParams(Text),
+        PrimitiveType.PRIM_INST_COLLECTION: _CreatorParams(PrimitiveInstanceCollection),
+    }
+    return _primitive_type_creator_params_dict
+
+
+def _initialize_terminal_type_creator_params_dict():
+    global _terminal_type_creator_params_dict
+
+    from ansys.edb.core.terminal.bundle_terminal import BundleTerminal
+    from ansys.edb.core.terminal.edge_terminal import EdgeTerminal
+    from ansys.edb.core.terminal.padstack_instance_terminal import PadstackInstanceTerminal
+    from ansys.edb.core.terminal.pin_group_terminal import PinGroupTerminal
+    from ansys.edb.core.terminal.point_terminal import PointTerminal
+    from ansys.edb.core.terminal.terminal import TerminalType
+    from ansys.edb.core.terminal.terminal_instance_terminal import TerminalInstanceTerminal
+
+    _terminal_type_creator_params_dict = {
+        TerminalType.BUNDLE: _CreatorParams(BundleTerminal),
+        TerminalType.EDGE: _CreatorParams(EdgeTerminal),
+        TerminalType.PADSTACK_INST: _CreatorParams(PadstackInstanceTerminal),
+        TerminalType.PIN_GROUP: _CreatorParams(PinGroupTerminal),
+        TerminalType.POINT: _CreatorParams(PointTerminal),
+        TerminalType.TERM_INST: _CreatorParams(TerminalInstanceTerminal),
+    }
+    return _terminal_type_creator_params_dict
+
+
+def _initialize_and_get_creator_dict(initializer, creator_dict):
+    return initializer() if creator_dict is None else creator_dict
+
+
+def _get_type_creator_dict():
+    return _initialize_and_get_creator_dict(
+        _initialize_type_creator_params_dict, _type_creator_params_dict
+    )
+
+
+def _get_primitive_type_creator_dict():
+    return _initialize_and_get_creator_dict(
+        _initialize_primitive_type_creator_params_dict, _primitive_type_creator_params_dict
+    )
+
+
+def _get_terminal_type_creator_dict():
+    return _initialize_and_get_creator_dict(
+        _initialize_terminal_type_creator_params_dict, _terminal_type_creator_params_dict
+    )
+
+
+def create_obj(msg, obj_type, do_cast):
+    """Create an object from the provided message of the provided type."""
+    obj = obj_type(msg)
+    if do_cast:
+        obj = obj.cast()
+    return obj
+
+
+def create_obj_from_creator_dict(creator_dict, msg, obj_type):
+    """Create an object from the provided message of the type corresponding to the provided object type."""
+    params = creator_dict[obj_type]
+    return create_obj(msg, params.obj_type, params.do_cast)
+
+
+def create_lyt_obj(msg, lyt_obj_type):
+    """Create a layout object from the provided message of the type corresponding to the provided layout object type."""
+    return create_obj_from_creator_dict(_get_type_creator_dict(), msg, lyt_obj_type)
+
+
+def create_primitive(msg, prim_type):
+    """Create a primitive from the provided message of the type corresponding to the provided primitive type."""
+    return create_obj_from_creator_dict(_get_primitive_type_creator_dict(), msg, prim_type)
+
+
+def create_terminal(msg, term_type):
+    """Create a terminal from the provided message of the type corresponding to the provided terminal type."""
+    return create_obj_from_creator_dict(_get_terminal_type_creator_dict(), msg, term_type)
+
+
+def create_conn_obj(msg):
+    """Create a connection object of its derived type based on its layout object type.
+
+    Parameters
+    ----------
+    msg : ansys.api.edb.v1.edb_messages_pb2.EDBObjMessage
+
+    Returns
+    -------
+    ansys.edb.core.inner.ConnObj
+    """
+    return create_lyt_obj(msg, create_lyt_obj(msg, LayoutObjType.INVALID_LAYOUT_OBJ).obj_type)

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/inner/messages.py

@@ -120,10 +120,10 @@ from ansys.api.edb.v1.refs_pb2 import (
     NetRefMessage,
 )
 from ansys.api.edb.v1.rlc_pb2 import RlcMessage
+from ansys.api.edb.v1.s_parameter_model_pb2 import SParameterModelMessage
 from ansys.api.edb.v1.simulation_setup_pb2 import MatrixConvergenceEntryMessage
-from ansys.api.edb.v1.sparameter_model_pb2 import SParameterModelMessage
 from ansys.api.edb.v1.spice_model_pb2 import SpiceModelMessage, SpiceModelNewTerminalPinMessage
-from ansys.api.edb.v1.structure3d_pb2 import ClosureMessage, SetClosureMessage
+from ansys.api.edb.v1.structure_3d_pb2 import ClosureMessage, SetClosureMessage
 from ansys.api.edb.v1.term_inst_pb2 import TermInstCreationMessage
 from ansys.api.edb.v1.term_inst_term_pb2 import (
     TermInstTermCreationMessage,

{ansys_edb_core-0.2.dev1 → ansys_edb_core-0.2.0.dev3}/src/ansys/edb/core/inner/parser.py

@@ -17,7 +17,7 @@ from ansys.edb.core.simulation_setup.mesh_operation import (
 
 def to_point_data(fn):
     """Decorate a function that returns a message to return it as a ``PointData`` object."""
-    return _wraps(fn, _to_point_data)
+    return _wraps(fn, msg_to_point_data)
 
 
 def to_point_data_list(fn):
@@ -42,7 +42,7 @@ def to_3_point3d_data(fn):
 
 def to_polygon_data(fn):
     """Decorate a function that returns a message to return it as a ``PolygonData`` object."""
-    return _wraps(fn, _to_polygon_data)
+    return _wraps(fn, msg_to_polygon_data)
 
 
 def to_polygon_data_list(fn):
@@ -95,6 +95,11 @@ def to_mesh_op(fn):
     return _wraps(fn, _to_mesh_op)
 
 
+def to_string_dict(fn):
+    """Decorate a function that returns a message to return it as a ``dict[str, str]``."""
+    return _wraps(fn, _to_string_dict)
+
+
 def _wraps(fn, wrapper_fn):
     if callable(fn):
 
@@ -107,7 +112,7 @@ def _wraps(fn, wrapper_fn):
         return wrapper_fn(fn)
 
 
-def _to_point_data(message):
+def msg_to_point_data(message):
     """Convert a ``PointMessage`` object to a ``PointData`` object.
 
     Parameters
@@ -135,7 +140,7 @@ def _to_point_data_pair(message):
     -------
     tuple[:class:`.PointData`, :class:`.PointData`]
     """
-    return _to_point_data(message.point_0), _to_point_data(message.point_1)
+    return msg_to_point_data(message.point_0), msg_to_point_data(message.point_1)
 
 
 def _to_point_data_list(message):
@@ -149,7 +154,7 @@ def _to_point_data_list(message):
     -------
     list[:class:`.PointData`]
     """
-    return [_to_point_data(m) for m in message]
+    return [msg_to_point_data(m) for m in message]
 
 
 def _to_3_point3d_data(message):
@@ -183,7 +188,7 @@ def _to_point3d_data(message):
     return Point3DData(Value(message.x), Value(message.y), Value(message.z))
 
 
-def _to_polygon_data(message):
+def msg_to_polygon_data(message):
     """Convert an arbitrary message to a ``PolygonData`` object if possible.
 
     Parameters
@@ -218,11 +223,11 @@ def _to_polygon_data_list(message):
     list[:class:`.PolygonData`]
     """
     if hasattr(message, "polygons"):
-        return [_to_polygon_data(m) for m in message.polygons]
+        return [msg_to_polygon_data(m) for m in message.polygons]
     elif hasattr(message, "points"):
-        return [_to_polygon_data(m) for m in message.points]
+        return [msg_to_polygon_data(m) for m in message.points]
     else:
-        return [_to_polygon_data(m) for m in message]
+        return [msg_to_polygon_data(m) for m in message]
 
 
 def _to_box(message):
@@ -237,7 +242,7 @@ def _to_box(message):
     tuple[:class:`.PointData`, :class:`.PointData`]
     """
     if hasattr(message, "lower_left") and hasattr(message, "upper_right"):
-        return _to_point_data(message.lower_left), _to_point_data(message.upper_right)
+        return msg_to_point_data(message.lower_left), msg_to_point_data(message.upper_right)
 
 
 def _to_circle(message):
@@ -254,7 +259,7 @@ def _to_circle(message):
     from ansys.edb.core.utility.value import Value
 
     if hasattr(message, "center") and hasattr(message, "radius"):
-        return _to_point_data(message.center), Value(message.radius)
+        return msg_to_point_data(message.center), Value(message.radius)
 
 
 def _to_rlc(message):
@@ -498,3 +503,8 @@ def _to_mesh_op(message):
     for nli in message.net_layer_info:
         mesh_op.net_layer_info.append((nli.net, nli.layer, nli.is_sheet))
     return mesh_op
+
+
+def _to_string_dict(message):
+    """Convert a message to a dictionary of strings."""
+    return {key: value for (key, value) in message.string_map}