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

pyedb/grpc/edb.py

@@ -418,7 +418,7 @@ class Edb(EdbInit):
         self._extended_nets = ExtendedNets(self)
 
     @property
-    def cell_names(self):
+    def cell_names(self) -> [str]:
         """Cell name container.
 
         Returns
@@ -428,7 +428,7 @@ class Edb(EdbInit):
         return [cell.name for cell in self.active_db.top_circuit_cells]
 
     @property
-    def design_variables(self):
+    def design_variables(self) -> dict[str, float]:
         """Get all edb design variables.
 
         Returns
@@ -438,18 +438,18 @@ class Edb(EdbInit):
         return {i: self.active_cell.get_variable_value(i).value for i in self.active_cell.get_all_variable_names()}
 
     @property
-    def project_variables(self):
+    def project_variables(self) -> dict[str, float]:
         """Get all project variables.
 
         Returns
         -------
-        variables dictionary : Dict[str, variable_name: float, variable_value]
+        variables dictionary : dict[str, variable_name: float, variable_value]
 
         """
         return {i: self.active_db.get_variable_value(i).value for i in self.active_db.get_all_variable_names()}
 
     @property
-    def layout_validation(self):
+    def layout_validation(self) -> LayoutValidation:
         """Return LayoutValidation object.
 
         Returns
@@ -459,7 +459,7 @@ class Edb(EdbInit):
         return LayoutValidation(self)
 
     @property
-    def variables(self):
+    def variables(self) -> dict[str, float]:
         """Get all Edb variables.
 
         Returns
@@ -475,7 +475,7 @@ class Edb(EdbInit):
         return all_vars
 
     @property
-    def terminals(self):
+    def terminals(self) -> dict[str, Terminal]:
         """Get terminals belonging to active layout.
 
         Returns
@@ -485,7 +485,7 @@ class Edb(EdbInit):
         return {i.name: i for i in self.layout.terminals}
 
     @property
-    def excitations(self):
+    def excitations(self) -> dict[str, GapPort]:
         """Get all layout excitations.
 
         Returns
@@ -503,7 +503,7 @@ class Edb(EdbInit):
         return temp
 
     @property
-    def ports(self):
+    def ports(self) -> dict[str, GapPort]:
         """Get all ports.
 
         Returns
@@ -537,7 +537,7 @@ class Edb(EdbInit):
         return ports
 
     @property
-    def excitations_nets(self):
+    def excitations_nets(self) -> [str]:
         """Get all net names with excitation defined.
 
         Returns
@@ -548,7 +548,7 @@ class Edb(EdbInit):
         return list(set([i.net.name for i in self.layout.terminals if not i.is_reference_terminal]))
 
     @property
-    def sources(self):
+    def sources(self) -> dict[str, Terminal]:
         """Get all layout sources.
 
         Returns
@@ -574,7 +574,7 @@ class Edb(EdbInit):
         return _vrms
 
     @property
-    def probes(self):
+    def probes(self) -> dict[str, Terminal]:
         """Get all layout probes.
 
         Returns
@@ -585,7 +585,7 @@ class Edb(EdbInit):
         terms = [term for term in self.layout.terminals if term.boundary_type.value == 8]
         return {ter.name: ter for ter in terms}
 
-    def open_edb(self, restart_rpc_server=False, kill_all_instances=False):
+    def open_edb(self, restart_rpc_server=False) -> bool:
         """Open EDB.
 
         Returns
@@ -626,7 +626,7 @@ class Edb(EdbInit):
                 self.logger.error("Builder was not initialized.")
             return True
 
-    def create_edb(self, restart_rpc_server=False, kill_all_instances=False):
+    def create_edb(self, restart_rpc_server=False) -> bool:
         """Create EDB.
 
         Returns
@@ -801,7 +801,7 @@ class Edb(EdbInit):
         self.edbpath = os.path.join(working_dir, aedb_name)
         return self.open_edb()
 
-    def export_to_ipc2581(self, ipc_path=None, units="MILLIMETER"):
+    def export_to_ipc2581(self, ipc_path=None, units="MILLIMETER") -> str:
         """Create an XML IPC2581 file from the active EDB.
 
         .. note::
@@ -847,7 +847,7 @@ class Edb(EdbInit):
         return False
 
     @property
-    def configuration(self):
+    def configuration(self) -> Configuration:
         """Edb project configuration from a file.
 
         Returns
@@ -917,7 +917,7 @@ class Edb(EdbInit):
             raise "No valid design."
 
     @property
-    def components(self):
+    def components(self) -> Components:
         """Edb Components methods and properties.
 
         Returns
@@ -935,7 +935,7 @@ class Edb(EdbInit):
         return self._components
 
     @property
-    def stackup(self):
+    def stackup(self) -> Stackup:
         """Stackup manager.
 
         Returns
@@ -955,7 +955,7 @@ class Edb(EdbInit):
         return self._stackup
 
     @property
-    def source_excitation(self):
+    def source_excitation(self) -> SourceExcitation:
         """Returns layout source excitations.
 
         Returns
@@ -966,7 +966,7 @@ class Edb(EdbInit):
             return self._source_excitation
 
     @property
-    def materials(self):
+    def materials(self) -> Materials:
         """Material Database.
 
         Returns
@@ -986,7 +986,7 @@ class Edb(EdbInit):
         return self._materials
 
     @property
-    def padstacks(self):
+    def padstacks(self) -> Padstacks:
         """Returns padstack object.
 
 
@@ -1009,7 +1009,7 @@ class Edb(EdbInit):
         return self._padstack
 
     @property
-    def siwave(self):
+    def siwave(self) -> Siwave:
         """Returns SIWave object.
 
         Returns
@@ -1027,7 +1027,7 @@ class Edb(EdbInit):
         return self._siwave
 
     @property
-    def hfss(self):
+    def hfss(self) -> Hfss:
         """Returns HFSS object.
 
         Returns
@@ -1047,7 +1047,7 @@ class Edb(EdbInit):
         return self._hfss
 
     @property
-    def nets(self):
+    def nets(self) -> Nets:
         """Returns nets object.
 
         Returns
@@ -1067,7 +1067,7 @@ class Edb(EdbInit):
         return self._nets
 
     @property
-    def net_classes(self):
+    def net_classes(self) -> NetClass:
         """Returns net classes object.
 
         Returns
@@ -1085,7 +1085,7 @@ class Edb(EdbInit):
             return {net.name: NetClass(self, net) for net in self.active_layout.net_classes}
 
     @property
-    def extended_nets(self):
+    def extended_nets(self) -> ExtendedNets:
         """Returns extended nets.
 
         Returns
@@ -1104,7 +1104,7 @@ class Edb(EdbInit):
         return self._extended_nets
 
     @property
-    def differential_pairs(self):
+    def differential_pairs(self) -> DifferentialPairs:
         """Returns differential pairs.
 
         Returns
@@ -1122,7 +1122,7 @@ class Edb(EdbInit):
         return self._differential_pairs
 
     @property
-    def modeler(self):
+    def modeler(self) -> Modeler:
         """Returns primitives modeler object.
 
         Returns
@@ -1140,7 +1140,7 @@ class Edb(EdbInit):
         return self._modeler
 
     @property
-    def layout(self):
+    def layout(self) -> Layout:
         """Returns Layout object.
 
         Returns
@@ -1150,7 +1150,7 @@ class Edb(EdbInit):
         return Layout(self)
 
     @property
-    def active_layout(self):
+    def active_layout(self) -> Layout:
         """Active layout.
 
         Returns
@@ -1255,7 +1255,7 @@ class Edb(EdbInit):
             return PointData(x, y)
 
     @staticmethod
-    def _is_file_existing_and_released(filename):
+    def _is_file_existing_and_released(filename) -> bool:
         if os.path.exists(filename):
             try:
                 os.rename(filename, filename + "_")
@@ -1267,13 +1267,13 @@ class Edb(EdbInit):
             return False
 
     @staticmethod
-    def _is_file_existing(filename):
+    def _is_file_existing(filename) -> bool:
         if os.path.exists(filename):
             return True
         else:
             return False
 
-    def _wait_for_file_release(self, timeout=30, file_to_release=None):
+    def _wait_for_file_release(self, timeout=30, file_to_release=None) -> bool:
         if not file_to_release:
             file_to_release = os.path.join(self.edbpath)
         tstart = time.time()
@@ -1303,7 +1303,7 @@ class Edb(EdbInit):
                 times = 0
                 time.sleep(0.250)
 
-    def close_edb(self):
+    def close_edb(self) -> bool:
         """Close EDB and cleanup variables.
 
         Returns
@@ -1318,7 +1318,7 @@ class Edb(EdbInit):
         self._clean_variables()
         return True
 
-    def save_edb(self):
+    def save_edb(self) -> bool:
         """Save the EDB file.
 
         Returns
@@ -1332,7 +1332,7 @@ class Edb(EdbInit):
         self.logger.info("EDB file save time: {0:.2f}ms".format(elapsed_time * 1000.0))
         return True
 
-    def save_edb_as(self, fname):
+    def save_edb_as(self, fname) -> bool:
         """Save the EDB file as another file.
 
         Parameters
@@ -2306,7 +2306,7 @@ class Edb(EdbInit):
         self.logger.reset_timer()
         return [[pt.x.value, pt.y.value] for pt in _poly.without_arcs().points]
 
-    def get_conformal_polygon_from_netlist(self, netlist=None):
+    def get_conformal_polygon_from_netlist(self, netlist=None) -> Union[bool, Polygon]:
         """Returns conformal polygon data based on a netlist.
 
         Parameters
@@ -2337,7 +2337,7 @@ class Edb(EdbInit):
         else:
             return False
 
-    def number_with_units(self, value, units=None):
+    def number_with_units(self, value, units=None) -> str:
         """Convert a number to a string with units. If value is a string, it's returned as is.
 
         Parameters
@@ -2821,39 +2821,44 @@ class Edb(EdbInit):
         self.logger.info(f"Variable {variable_name} doesn't exists.")
         return False
 
-    def add_project_variable(self, variable_name, variable_value):
+    def add_project_variable(self, variable_name, variable_value, description=None) -> bool:
         """Add a variable to database. The variable will have the prefix `$`.
 
         Parameters
-         ----------
-         variable_name : str
-             Name of the variable. Name can be provided without ``$`` prefix.
-         variable_value : str, float
-             Value of the variable with units.
+        ----------
+        variable_name : str
+            Name of the variable. Name can be provided without ``$`` prefix.
+        variable_value : str, float
+            Value of the variable with units.
+        description : str, optional.
+            Add variable description.
 
-         Returns
-         -------
-         bool
+        Returns
+        -------
+        bool
 
-         Examples
-         --------
+        Examples
+        --------
 
-         >>> 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
-         >>> edb_app["$my_local_variable"] = "1cm"   #using setitem
+        >>> 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
+        >>> edb_app["$my_local_variable"] = "1cm"   #using setitem
 
         """
         if not variable_name.startswith("$"):
             variable_name = f"${variable_name}"
         if not self.variable_exists(variable_name):
-            return self.active_db.add_variable(variable_name, variable_value)
+            var = self.active_db.add_variable(variable_name, variable_value)
+            if description:
+                self.active_db.set_variable_desc(name=variable_name, desc=description)
+            return var
         else:
             self.logger.error(f"Variable {variable_name} already exists.")
             return False
 
-    def add_design_variable(self, variable_name, variable_value, is_parameter=False):
+    def add_design_variable(self, variable_name, variable_value, is_parameter=False, description=None) -> bool:
         """Add a variable to edb. The variable can be a design one or a project variable (using ``$`` prefix).
 
         Parameters
@@ -2866,6 +2871,8 @@ class Edb(EdbInit):
         is_parameter : bool, optional
             Whether to add the variable as a local variable. The default is ``False``.
             When ``True``, the variable is added as a parameter default.
+        description : str, optional
+            Add variable description.
 
         Returns
         -------
@@ -2887,7 +2894,10 @@ class Edb(EdbInit):
         if variable_name.startswith("$"):
             variable_name = variable_name[1:]
         if not self.variable_exists(variable_name):
-            return self.active_cell.add_variable(variable_name, variable_value)
+            var = self.active_cell.add_variable(variable_name, variable_value)
+            if description:
+                self.active_cell.set_variable_desc(name=variable_name, desc=description)
+            return var
         else:
             self.logger.error(f"Variable {variable_name} already exists.")
             return False
@@ -2921,7 +2931,7 @@ class Edb(EdbInit):
             elif variable_name in self.active_cell.get_all_variable_names():
                 self.active_cell.set_variable_value(variable_name, GrpcValue(variable_value))
 
-    def get_bounding_box(self):
+    def get_bounding_box(self) -> list[list[float, float], list[float, float]]:
         """Get the layout bounding box.
 
         Returns
@@ -3030,7 +3040,9 @@ class Edb(EdbInit):
         return True if len(iDintersection) > 0 else False
 
     @property
-    def setups(self):
+    def setups(
+        self,
+    ) -> Union[HfssSimulationSetup, SiwaveSimulationSetup, SIWaveDCIRSimulationSetup, RaptorXSimulationSetup]:
         """Get the dictionary of all EDB HFSS and SIwave setups.
 
         Returns
@@ -3056,7 +3068,7 @@ class Edb(EdbInit):
         return self._setups
 
     @property
-    def hfss_setups(self):
+    def hfss_setups(self) -> dict[str, HfssSimulationSetup]:
         """Active HFSS setup in EDB.
 
         Returns
@@ -3072,7 +3084,7 @@ class Edb(EdbInit):
         return setups
 
     @property
-    def siwave_dc_setups(self):
+    def siwave_dc_setups(self) -> dict[str, SIWaveDCIRSimulationSetup]:
         """Active Siwave DC IR Setups.
 
         Returns
@@ -3084,7 +3096,7 @@ class Edb(EdbInit):
         return {name: i for name, i in self.setups.items() if isinstance(i, SIWaveDCIRSimulationSetup)}
 
     @property
-    def siwave_ac_setups(self):
+    def siwave_ac_setups(self) -> dict[str, SiwaveSimulationSetup]:
         """Active Siwave SYZ setups.
 
         Returns
@@ -3094,7 +3106,9 @@ class Edb(EdbInit):
         """
         return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSimulationSetup)}
 
-    def create_hfss_setup(self, name=None, start_frequency="0GHz", stop_frequency="20GHz", step_frequency="10MHz"):
+    def create_hfss_setup(
+        self, name=None, start_frequency="0GHz", stop_frequency="20GHz", step_frequency="10MHz"
+    ) -> HfssSimulationSetup:
         """Create an HFSS simulation setup from a template.
 
         . deprecated:: pyedb 0.30.0
@@ -3122,7 +3136,7 @@ class Edb(EdbInit):
             step_freq=step_frequency,
         )
 
-    def create_raptorx_setup(self, name=None):
+    def create_raptorx_setup(self, name=None) -> RaptorXSimulationSetup:
         """Create an RaptorX simulation setup from a template.
 
         Parameters
@@ -3176,7 +3190,7 @@ class Edb(EdbInit):
         #  TODO check HFSS-PI with Grpc. seems to defined at terminal level not setup.
         pass
 
-    def create_siwave_syz_setup(self, name=None, **kwargs):
+    def create_siwave_syz_setup(self, name=None, **kwargs) -> SiwaveSimulationSetup:
         """Create a setup from a template.
 
         Parameters
@@ -3213,7 +3227,7 @@ class Edb(EdbInit):
             setattr(setup, k, v)
         return self.setups[name]
 
-    def create_siwave_dc_setup(self, name=None, **kwargs):
+    def create_siwave_dc_setup(self, name=None, **kwargs) -> GrpcSIWaveDCIRSimulationSetup:
         """Create a setup from a template.
 
         Parameters
@@ -3459,6 +3473,9 @@ class Edb(EdbInit):
     def create_port(self, terminal, ref_terminal=None, is_circuit_port=False, name=None):
         """Create a port.
 
+        ..deprecated:: 0.51.0
+           Use: func:`create_port` has been move to source_excitation.create_port.
+
         Parameters
         ----------
         terminal : class:`pyedb.dotnet.database.edb_data.terminals.EdgeTerminal`,
@@ -3481,22 +3498,16 @@ class Edb(EdbInit):
         list: [:class:`GapPort <pyedb.grpc.database.ports.ports.GapPort`>,
             :class:`WavePort <pyedb.grpc.database.ports.ports.WavePort>`].
         """
-        from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
-
-        if terminal.boundary_type == "port":
-            terminal.boundary_type = GrpcBoundaryType.PORT
-        terminal.is_circuit_port = is_circuit_port
-        if ref_terminal:
-            if ref_terminal.boundary_type == "port":
-                ref_terminal.boundary_type = GrpcBoundaryType.PORT
-            terminal.reference_terminal = ref_terminal
-        if name:
-            terminal.name = name
-        return self.ports[terminal.name]
+
+        warnings.warn("Use create_port from edb.source_excitation.create_port", DeprecationWarning)
+        return self.source_excitation.create_port(terminal, ref_terminal, is_circuit_port, name)
 
     def create_voltage_probe(self, terminal, ref_terminal):
         """Create a voltage probe.
 
+        ..deprecated:: 0.50.0
+           Use: func:`create_voltage_probe` located in edb.source_excitation.create_voltage_probe instead.
+
         Parameters
         ----------
         terminal : :class:`EdgeTerminal <pyedb.grpc.database.terminals.EdgeTerminal>`,
@@ -3514,18 +3525,15 @@ class Edb(EdbInit):
         -------
         :class:`Terminal <pyedb.dotnet.database.edb_data.terminals.Terminal>`
         """
-        term = Terminal(self, terminal)
-        term.boundary_type = "voltage_probe"
-
-        ref_term = Terminal(self, ref_terminal)
-        ref_term.boundary_type = "voltage_probe"
-
-        term.ref_terminal = ref_terminal
-        return term
+        warnings.warn("Use create_voltage_probe located in edb.source_excitation instead", DeprecationWarning)
+        return self.source_excitation.create_voltage_probe(terminal, ref_terminal)
 
     def create_voltage_source(self, terminal, ref_terminal):
         """Create a voltage source.
 
+        ..deprecated:: 0.50.0
+           Use: func:`create_voltage_source` located in edb.source_excitation.create_voltage_source instead.
+
         Parameters
         ----------
         terminal : :class:`EdgeTerminal <pyedb.grpc.database.terminals.EdgeTerminal>`,
@@ -3543,18 +3551,18 @@ class Edb(EdbInit):
         -------
         class:`ExcitationSources <legacy.database.edb_data.ports.ExcitationSources>`
         """
-        term = Terminal(self, terminal)
-        term.boundary_type = "voltage_source"
-
-        ref_term = Terminal(self, ref_terminal)
-        ref_term.boundary_type = "voltage_source"
-
-        term.ref_terminal = ref_terminal
-        return term
+        warnings.warn(
+            "use create_voltage_source located in edb.source_excitation.create_voltage_source instead",
+            DeprecationWarning,
+        )
+        return self.source_excitation.create_voltage_source(terminal, ref_terminal)
 
     def create_current_source(self, terminal, ref_terminal):
         """Create a current source.
 
+        ..deprecated:: 0.50.0
+           Use: func:`create_current_source` located in edb.source_excitation.create_current_source instead.
+
         Parameters
         ----------
         terminal : :class:`EdgeTerminal <pyedb.grpc.database.terminals.EdgeTerminal>`,
@@ -3572,17 +3580,17 @@ class Edb(EdbInit):
         -------
         :class:`ExcitationSources <legacy.database.edb_data.ports.ExcitationSources>`
         """
-        term = Terminal(self, terminal)
-        term.boundary_type = "current_source"
-
-        ref_term = Terminal(self, ref_terminal)
-        ref_term.boundary_type = "current_source"
-
-        term.ref_terminal = ref_terminal
-        return term
+        warnings.warn(
+            "use create_current_source located in edb.source_excitation.create_current_source instead",
+            DeprecationWarning,
+        )
+        return self.source_excitation.create_current_source(terminal, ref_terminal)
 
     def get_point_terminal(self, name, net_name, location, layer):
-        """Place a voltage probe between two points.
+        """Place terminal between two points.
+
+        ..deprecated:: 0.50.0
+           Use: func:`get_point_terminal` located in edb.source_excitation.get_point_terminal instead.
 
         Parameters
         ----------
@@ -3599,9 +3607,11 @@ class Edb(EdbInit):
         -------
         :class:`PointTerminal <pyedb.grpc.database.terminal.point_terminal.PointTerminal>`
         """
-        from pyedb.grpc.database.terminal.point_terminal import PointTerminal
 
-        return PointTerminal.create(layout=self.active_layout, name=name, net=net_name, layer=layer, point=location)
+        warnings.warn(
+            "use get_point_terminal located in edb.source_excitation.get_point_terminal instead", DeprecationWarning
+        )
+        return self.source_excitation.get_point_terminal(name, net_name, location, layer)
 
     def auto_parametrize_design(
         self,

{pyedb-0.49.0.dist-info → pyedb-0.50.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyedb
-Version: 0.49.0
+Version: 0.50.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>