Added ERL computation in Circuit through SPISIM launched in non-graphical mode (#4219)

* Added ERL computation in Circuit through SPISIM launched in non-graphical mode

* Added ERL computation in Circuit through SPISIM launched in non-graphical mode

* Added ERL computation in Circuit through SPISIM launched in non-graphical mode

* Update pyaedt/circuit.py

Co-authored-by: SMoraisAnsys <[email protected]>

* Update pyaedt/circuit.py

Co-authored-by: SMoraisAnsys <[email protected]>

* Update pyaedt/circuit.py

Co-authored-by: SMoraisAnsys <[email protected]>

* minor fix

* minor fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* minor fix

---------

Co-authored-by: maxcapodi78 <Shark78>
Co-authored-by: SMoraisAnsys <[email protected]>
Co-authored-by: ring630 <@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Hui Zhou <[email protected]>

Author: 4 people

Diff for: _unittest_solvers/example_models/T00/erl_unit_test.aedtz

@@ -26,6 +26,7 @@
     component = "Circ_Patch_5GHz.a3dcomp"
 
 test_subfolder = "T00"
+erl_project_name = "erl_unit_test"
 
 
 @pytest.fixture()
@@ -74,6 +75,12 @@ def circuit_app(add_app):
     app.modeler.schematic_units = "mil"
     return app
 
+@pytest.fixture(scope="class")
+def circuit_erl(add_app):
+    app = add_app(erl_project_name, design_name="2ports", application=Circuit, subfolder=test_subfolder)
+    return app
+
+
 
 @pytest.fixture(scope="class")
 def m3dtransient(add_app):
@@ -426,3 +433,10 @@ def test_07_export_maxwell_fields(self, m3dtransient):
                                               setuptype=setup.setuptype)
         new_setup.props = setup.props
         new_setup.update()
+
+    def test_08_compute_erl(self, circuit_erl):
+        erl_data2 = circuit_erl.compute_erl(port_order="EvenOdd",bandwidth="40p")
+        assert erl_data2
+        circuit_erl.set_active_design("4_ports")
+        erl_data_3 = circuit_erl.compute_erl(specify_through_ports=[1, 2, 3, 4])
+        assert erl_data_3

Diff for: _unittest_solvers/test_00_analyze.py

@@ -2088,8 +2088,8 @@ def _export_touchstone(
 
         Returns
         -------
-        bool
-            ``True`` when successful, ``False`` when failed.
+        str
+            file name when successful, ``False`` when failed.
         """
         if variations is None:
             variations = list(self.available_variations.nominal_w_values_dict.keys())
@@ -2180,7 +2180,7 @@ def _export_touchstone(
                 NonStandardExtensions,
             )
         self.logger.info("Touchstone correctly exported to %s", filename)
-        return True
+        return OutFile
 
     @pyaedt_function_handler()
     def value_with_units(

Diff for: pyaedt/application/Analysis.py

@@ -8,13 +8,16 @@
 import os
 import re
 import shutil
+import subprocess  # nosec B404
 
 from pyaedt import Hfss3dLayout
+from pyaedt import settings
 from pyaedt.application.AnalysisNexxim import FieldAnalysisCircuit
 from pyaedt.generic import ibis_reader
 from pyaedt.generic.DataHandlers import from_rkm_to_aedt
 from pyaedt.generic.filesystem import search_files
 from pyaedt.generic.general_methods import generate_unique_name
+from pyaedt.generic.general_methods import is_linux
 from pyaedt.generic.general_methods import open_file
 from pyaedt.generic.general_methods import pyaedt_function_handler
 from pyaedt.modules.Boundary import CurrentSinSource
@@ -828,8 +831,8 @@ def export_touchstone(
 
         Returns
         -------
-        bool
-            ``True`` when successful, ``False`` when failed.
+        str
+            File name when successful, ``False`` when failed.
 
         References
         ----------
@@ -1684,3 +1687,230 @@ def import_edb_in_circuit(self, edb_path):
         hfss_3d_layout_model = self.modeler.schematic.add_subcircuit_3dlayout(hfss.design_name)
         hfss.close_project(save_project=False)
         return hfss_3d_layout_model
+
+    @pyaedt_function_handler()
+    def compute_erl_from_touchstone(
+        self,
+        touchstone_file,
+        port_order="EvenOdd",
+        specify_through_ports=None,
+        bandwidth=30e9,
+        tdr_duration=5,
+        z_terminations=50,
+        transition_time="10p",
+        fixture_delay=500e-12,
+        input_amplitude=1.0,
+        ber=1e-4,
+        pdf_bin_size=1e-5,
+        signal_loss_factor=1.7e9,
+        permitted_reflection=0.18,
+        reflections_lenght=1000,
+        modulation_type="NRZ",
+    ):
+        """Compute effective return loss (erl) using Ansys SPISIM from a S-parameter file.
+
+        Parameters
+        ----------
+        touchstone_file : str
+            Path to the touchstone file.
+        port_order : str, optional
+            Whether to use "``EvenOdd``" or "``Incremental``" numbering for ``s4p`` files.
+            Ignored if the ports are greater than 4.
+        specify_through_ports : list, optional
+            Input and Output ports on which compute the erl. Those are ordered like ``[inp, inneg, outp, outneg]``.
+        bandwidth : float, str, optional
+            Application bandwidth: inverse of one UI (unit interval). Can be a float or str with unit ("m", "g").
+            Default is ``30e9``.
+        tdr_duration : float, optional
+            TDR duration (in second): How long the TDR tailed data should be applied. Default is ``5``.
+        z_terminations : float, optional
+            Z-Terminations: termination (Z11 and Z22) when TDR is calculated. Default is ``50``.
+        transition_time : float, str, optional
+            Transition time: how fast (slew rate) input pulse transit from 0 to Vcc volt. Default is "``10p``".
+        fixture_delay : float, optional
+            Fixture delay: delay when input starts transition from 0 to Vcc. Default is ``500e-12``.
+        input_amplitude : float, optional
+            Input amplitude: Vcc volt of step input. Default is ``1.0``.
+        ber : float, optional
+            Specified BER: At what threshold ERL is calculated. Default is ``1e-4``.
+        pdf_bin_size : float, optional
+            PDF bin size: how to quantize the superimposed value. Default is ``1e-5``.
+        signal_loss_factor : float, optional
+            Signal loss factor (Beta). See SPISIM Help for info. Default is ``1.7e9``.
+        permitted_reflection : float, optional
+            Permitted reflection (Rho). See SPISIM Help for info. Default is ``0.18``.
+        reflections_lenght : float, optional
+            Length of the reflections: how many UI will be used to calculate ERL. Default is ``1000``.
+        modulation_type : str, optional
+           Modulations type: signal modulation type "``NRZ``" or "``PAM4``". Default is "``NRZ``".
+
+        Returns
+        -------
+        bool or dict
+            A dictionary with the result from the spisimExe command, ``False`` when failed.
+        """
+        exec_name = "SPISimJNI_LX64.exe" if is_linux else "SPISimJNI_WIN64.exe"
+        spisimExe = os.path.join(self.desktop_install_dir, "spisim", "SPISim", "modules", "ext", exec_name)
+
+        cfg_file = os.path.join(self.working_directory, "spisim_erl.cfg")
+        with open(cfg_file, "w") as fp:
+            fp.write("# INPARRY: INPARRY\n")
+            fp.write("INPARRY = {}\n".format(touchstone_file))
+            fp.write("# MIXMODE: MIXMODE\n")
+            if port_order and touchstone_file.lower().endswith(".s4p"):
+                fp.write("MIXMODE = {}\n".format(port_order))
+            else:
+                fp.write("MIXMODE = \n")
+            fp.write("# THRUS4P: THRUS4P\n")
+            if not touchstone_file.lower().endswith(".s4p"):
+                if isinstance(specify_through_ports[0], int):
+                    thrus4p = ",".join([str(i) for i in specify_through_ports])
+                else:
+                    try:
+                        ports = self.excitations.keys()
+                        thrus4p = ",".join([ports.index(i) for i in specify_through_ports])
+                    except IndexError:
+                        self.logger.error("Port not found.")
+                        return False
+                fp.write("THRUS4P = {}\n".format(thrus4p))
+            else:
+                fp.write("THRUS4P = \n")
+            fp.write("# BANDWID: BANDWID\n")
+            fp.write("BANDWID = {}\n".format(bandwidth))
+            fp.write("# TDR_DUR: TDR_DUR\n")
+            fp.write("TDR_DUR = {}\n".format(tdr_duration))
+            fp.write("# REFIMPD: REFIMPD\n")
+            fp.write("REFIMPD = {}\n".format(z_terminations))
+            fp.write("# BINSIZE: BINSIZE\n")
+            fp.write("BINSIZE = {}\n".format(pdf_bin_size))
+            fp.write("# SPECBER: SPECBER\n")
+            fp.write("SPECBER = {}\n".format(ber))
+            fp.write("# MODTYPE: MODTYPE\n")
+            fp.write("MODTYPE = {}\n".format(modulation_type))
+            fp.write("# FIXDELY: FIXDELY\n")
+            fp.write("FIXDELY = {}\n".format(fixture_delay))
+            fp.write("# INPVOLT: INPVOLT\n")
+            fp.write("INPVOLT = {}\n".format(input_amplitude))
+            fp.write("# TRSTIME: TRSTIME\n")
+            fp.write("TRSTIME = {}\n".format(transition_time))
+            fp.write("# SIGBETA: SIGBETA\n")
+            fp.write("SIGBETA = {}\n".format(signal_loss_factor))
+            fp.write("# REFLRHO: REFLRHO\n")
+            fp.write("REFLRHO = {}\n".format(permitted_reflection))
+            fp.write("# NCYCLES: NCYCLES\n")
+            fp.write("NCYCLES = {}\n".format(reflections_lenght))
+
+        cfgCmmd = '-i %s -v CFGFILE="%s"' % (touchstone_file, cfg_file)
+        command = [spisimExe, "CalcERL", cfgCmmd]
+        # Debug('%s %s' % (cmdList[0], ' '.join(arguments)))
+        # try up to three times to be sure
+        out_processing = os.path.join(self.working_directory, "spsim_erl_out.txt")
+        my_env = os.environ.copy()
+        my_env.update(settings.aedt_environment_variables)
+        if is_linux:  # pragma: no cover
+            command.append("&")
+            with open(out_processing, "w") as outfile:
+                subprocess.Popen(command, env=my_env, stdout=outfile, stderr=outfile).wait()  # nosec
+        else:
+            with open(out_processing, "w") as outfile:
+                subprocess.Popen(" ".join(command), env=my_env, stdout=outfile, stderr=outfile).wait()  # nosec
+        out_data = {}
+        try:
+            with open(out_processing, "r") as infile:
+                lines = infile.read()
+                parmDat = lines.split("[ParmDat]:", 1)[1]
+                for keyValu in parmDat.split(","):
+                    dataAry = keyValu.split("=")
+                    out_data[dataAry[0].strip()] = float(dataAry[1].strip().split()[0])
+            return out_data
+        except IndexError:
+            self.logger.error("Failed to compute ERL. Check input parameters and retry")
+            return False
+
+    @pyaedt_function_handler()
+    def compute_erl(
+        self,
+        setup_name=None,
+        port_order="EvenOdd",
+        specify_through_ports=None,
+        bandwidth=30e9,
+        tdr_duration=5,
+        z_terminations=50,
+        transition_time="10p",
+        fixture_delay=500e-12,
+        input_amplitude=1.0,
+        ber=1e-4,
+        pdf_bin_size=1e-5,
+        signal_loss_factor=1.7e9,
+        permitted_reflection=0.18,
+        reflections_lenght=1000,
+        modulation_type="NRZ",
+    ):
+        """Compute effective return loss (erl) using Ansys SPISIM.
+
+        Parameters
+        ----------
+        setup_name : str, optional
+            Name of the setup to use as the nominal. The default is
+            ``None``, in which case the active setup is used or
+            nothing is used.
+        port_order : str, optional
+            Whether to use "``EvenOdd``" or "``Incremental``" numbering for ``s4p`` files.
+            Ignored if the ports are greater than 4.
+        specify_through_ports : list, optional
+            Input and Output ports on which compute the erl. Those are ordered like ``[inp, inneg, outp, outneg]``.
+        bandwidth : float, str, optional
+            Application bandwidth: inverse of one UI (unit interval). Can be a float or str with unit ("m", "g").
+            Default is ``30e9``.
+        tdr_duration : float, optional
+            TDR duration (in second): How long the TDR tailed data should be applied. Default is ``5``.
+        z_terminations : float, optional
+            Z-Terminations: termination (Z11 and Z22) when TDR is calculated. Default is ``50``.
+        transition_time : float, str, optional
+            Transition time: how fast (slew rate) input pulse transit from 0 to Vcc volt. Default is "``10p``".
+        fixture_delay : float, optional
+            Fixture delay: delay when input starts transition from 0 to Vcc. Default is ``500e-12``.
+        input_amplitude : float, optional
+            Input amplitude: Vcc volt of step input. Default is ``1.0``.
+        ber : float, optional
+            Specified BER: At what threshold ERL is calculated. Default is ``1e-4``.
+        pdf_bin_size : float, optional
+            PDF bin size: how to quantize the superimposed value. Default is ``1e-5``.
+        signal_loss_factor : float, optional
+            Signal loss factor (Beta). See SPISIM Help for info. Default is ``1.7e9``.
+        permitted_reflection : float, optional
+            Permitted reflection (Rho). See SPISIM Help for info. Default is ``0.18``.
+        reflections_lenght : float, optional
+            Length of the reflections: how many UI will be used to calculate ERL. Default is ``1000``.
+        modulation_type : str, optional
+           Modulations type: signal modulation type "``NRZ``" or "``PAM4``". Default is "``NRZ``".
+
+        Returns
+        -------
+        bool or dict
+            A dictionary with the result from the spisimExe command, ``False`` when failed.
+        """
+
+        if not setup_name:
+            setup_name = self.nominal_sweep
+        tc_file = self.export_touchstone(
+            setup_name,
+        )
+
+        return self.compute_erl_from_touchstone(
+            tc_file,
+            port_order,
+            specify_through_ports,
+            bandwidth,
+            tdr_duration,
+            z_terminations,
+            transition_time,
+            fixture_delay,
+            input_amplitude,
+            ber,
+            pdf_bin_size,
+            signal_loss_factor,
+            permitted_reflection,
+            reflections_lenght,
+            modulation_type,
+        )