S588850: Linked coupling pyaedt support

Author: jianwei425

_setup_common.py

@@ -52,6 +52,7 @@ def recursive_glob(startpath, filepattern):
     "pyaedt.modules",
     "pyaedt.generic",
     "pyaedt.edb_core",
+    "pyaedt.emit_core",
     "pyaedt.examples",
     "pyaedt.rpc",
     "pyaedt.third_party",

_unittest/test_26_emit.py

@@ -27,7 +27,7 @@ def test_objects(self):
         assert self.aedtapp.modeler
         assert self.aedtapp.oanalysis is None
 
-    @pytest.mark.skipif(config["build_machine"], reason="Not functional in non-graphical mode")
+    @pytest.mark.skipif(config["NonGraphical"], reason="Not functional in non-graphical mode")
     def test_create_components(self):
         radio = self.aedtapp.modeler.components.create_component("New Radio", "TestRadio")
         assert radio.name == "TestRadio"
@@ -36,7 +36,7 @@ def test_create_components(self):
         assert antenna.name == "TestAntenna"
         assert isinstance(antenna, EmitComponent)
 
-    @pytest.mark.skipif(config["build_machine"], reason="Not functional in non-graphical mode")
+    @pytest.mark.skipif(config["NonGraphical"], reason="Not functional in non-graphical mode")
     @pytest.mark.skipif(config["desktopVersion"] < "2021.2", reason="Skipped on versions lower than 2021.2")
     def test_connect_components(self):
         radio = self.aedtapp.modeler.components.create_component("New Radio")
@@ -54,7 +54,7 @@ def test_connect_components(self):
         assert connected_comp is None
         assert connected_port is None
 
-    @pytest.mark.skipif(config["build_machine"], reason="Not functional in non-graphical mode")
+    @pytest.mark.skipif(config["NonGraphical"], reason="Not functional in non-graphical mode")
     def test_radio_component(self):
         radio = self.aedtapp.modeler.components.create_component("New Radio")
         # default radio has 1 Tx channel and 1 Rx channel

examples/03-Circuit/EMIT_HFSS_Example.py

@@ -0,0 +1,118 @@
+"""
+EMIT Example
+------------
+This tutorial shows how you can use PyAEDT to open an AEDT project with
+an HFSS design, create an EMIT design in the project, then link the HFSS design
+as a coupling link in the EMIT design.
+"""
+# sphinx_gallery_thumbnail_path = 'Resources/emit.png'
+import os
+import tempfile
+
+# Import required modules
+from pyaedt.generic.filesystem import Scratch
+
+# Setup paths for module imports
+from _unittest.conftest import scratch_path
+
+from pyaedt import Emit
+from pyaedt import Desktop
+
+###############################################################################
+# Initialization Settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Change NonGraphical Boolean to False to open AEDT in graphical mode
+# With NewThread = False, an existing instance of AEDT will be used, if
+# available. This example will use AEDT 2022.2
+
+NonGraphical = False
+NewThread = True
+desktop_version = "2022.2"
+
+
+###############################################################################
+# Launch AEDT and EMIT Design
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Desktop class initializes AEDT and starts it on specified version and
+# specified graphical mode. NewThread Boolean variable defines if a user wants
+# to create a new instance of AEDT or try to connect to existing instance of
+# it.
+d = Desktop(desktop_version, NonGraphical, NewThread)
+tmpfold = tempfile.gettempdir()
+
+temp_folder = os.path.join(tmpfold, ("EmitHFSSExample"))
+if not os.path.exists(temp_folder):
+    os.mkdir(temp_folder)
+
+example_name = "Cell Phone RFI Desense"
+example_aedt = example_name + ".aedt"
+example_lock = example_aedt + ".lock"
+example_pdf_file = example_name + " Example.pdf"
+
+example_dir = os.path.join(d.install_path, "Examples\\EMIT")
+example_project = os.path.join(example_dir, example_aedt)
+example_pdf = os.path.join(example_dir, example_pdf_file)
+
+# If the Cell phone example is not in the install dir, exit from this example.
+if not os.path.exists(example_project):
+    msg = """
+        Cell phone RFT Desense example file is not in the
+         Examples/EMIT directory under the EDT installation. You can not run this example.
+        """
+    print(msg)
+    d.force_close_desktop()
+    exit()
+
+my_project = os.path.join(temp_folder, example_aedt)
+my_project_lock = os.path.join(temp_folder, example_lock)
+my_project_pdf = os.path.join(temp_folder, example_pdf_file)
+
+if os.path.exists(my_project):
+    os.remove(my_project)
+
+if os.path.exists(my_project_lock):
+    os.remove(my_project_lock)
+
+with Scratch(scratch_path) as local_scratch:
+    local_scratch.copyfile(example_project, my_project)
+    if os.path.exists(example_pdf):
+        local_scratch.copyfile(example_pdf, my_project_pdf)
+
+aedtapp = Emit(my_project)
+###############################################################################
+
+# Create and Connect EMIT Components
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Create 3 radios and connect an antenna to each.
+rad1 = aedtapp.modeler.components.create_component("UE - Handheld")
+ant1 = aedtapp.modeler.components.create_component("Antenna")
+if rad1 and ant1:
+    ant1.move_and_connect_to(rad1)
+
+rad2 = aedtapp.modeler.components.create_component("GPS Receiver")
+ant2 = aedtapp.modeler.components.create_component("Antenna")
+if rad2 and ant2:
+    ant2.move_and_connect_to(rad2)
+
+###############################################################################
+# Define Coupling Among the RF Systems
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+for link in aedtapp.couplings.linkable_design_names:
+    aedtapp.couplings.add_link(link)
+
+for link in aedtapp.couplings.coupling_names:
+    aedtapp.couplings.update_link(link)
+###############################################################################
+# Run the EMIT Simulation
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# This portion of the EMIT API is not yet implemented.
+
+
+###############################################################################
+# Close Desktop
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# After the simulaton is completed user can close the desktop or release it
+# (using release_desktop method). All methods give possibility to save projects
+# before exit.
+aedtapp.save_project()
+aedtapp.release_desktop(close_projects=True, close_desktop=True)

pyaedt/application/AnalsyisEmit.py renamed to pyaedt/application/AnalysisEmit.py

@@ -1,5 +1,6 @@
 from pyaedt.application.Design import Design
 from pyaedt.modeler.Circuit import ModelerEmit
+from pyaedt.emit_core.Couplings import CouplingsEmit
 
 
 class FieldAnalysisEmit(Design):
@@ -50,6 +51,7 @@ def __init__(
         self.solution_type = solution_type
         self.oanalysis = None
         self._modeler = ModelerEmit(self)
+        self._couplings = CouplingsEmit(self)
 
     @property
     def modeler(self):
@@ -61,3 +63,14 @@ def modeler(self):
             Design oModeler
         """
         return self._modeler
+
+    @property
+    def couplings(self):
+        """Emit Couplings.
+
+        Returns
+        -------
+        pyaedt.emit_core.Couplings.CouplingsEmit
+            Couplings within the EMIT Design
+        """
+        return self._couplings

pyaedt/emit.py

@@ -1,6 +1,6 @@
 from __future__ import absolute_import  # noreorder
 
-from pyaedt.application.AnalsyisEmit import FieldAnalysisEmit
+from pyaedt.application.AnalysisEmit import FieldAnalysisEmit
 
 
 class Emit(FieldAnalysisEmit, object):

pyaedt/emit_core/Couplings.py

@@ -0,0 +1,77 @@
+"""
+This module contains these classes: `CouplingsEmit`.
+
+This module provides the capability to interact with EMIT Analysis & Results windows.
+"""
+
+import warnings
+
+
+class CouplingsEmit(object):
+    """Provides for interaction with the EMIT Coupling folder
+
+    This class is accessible through the EMIT application results variable
+    object( eg. ``emit.couplings``).
+
+    Parameters
+    ----------
+    app :
+        Inherited parent object.
+
+    Examples
+    --------
+    >>> from pyaedt import Emit
+    >>> app = Emit()
+    >>> my_couplings = app.couplings
+    """
+
+    def __init__(self, app):
+        self._app = app
+
+    # Properties derived from internal parent data
+    @property
+    def _desktop(self):
+        """Desktop."""
+        return self._app._desktop
+
+    @property
+    def logger(self):
+        """Logger."""
+        return self._app.logger
+
+    @property
+    def _odesign(self):
+        """Design."""
+        return self._app._odesign
+
+    @property
+    def projdir(self):
+        """Project directory."""
+        return self._app.project_path
+
+    @property
+    def coupling_names(self):
+        """List of existing link names."""
+        return self._odesign.GetLinkNames()
+
+    def add_link(self, new_coupling_name):
+        """add a new link if it's not already there"""
+        if new_coupling_name not in self._odesign.GetLinkNames():
+            self._odesign.AddLink(new_coupling_name)
+
+    def update_link(self, coupling_name):
+        """update the link if it's a valid link"""
+        if coupling_name in self._odesign.GetLinkNames():
+            self._odesign.UpdateLink(coupling_name)
+
+    @property
+    def linkable_design_names(self):
+        """list the available link names"""
+        desktop_version = self._desktop.GetVersion()[0:6]
+        if desktop_version >= "2022.2":
+            return self._odesign.GetAvailableLinkNames()
+        else:
+            warnings.warn(
+                "The function linkable_design_names() requires AEDT 2022 R2 or newer."
+            )
+            return []