REFACTOR: configure edb extension (#5128)

Co-authored-by: ring630 <@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

_unittest_solvers/test_45_workflows.py

@@ -162,7 +162,33 @@ def test_08_configure_a3d(self, local_scratch):
         local_scratch.copyfolder(os.path.join(solver_local_path, "example_models", "T45", "ANSYS-HSD_V1.aedb"),
                                  file_path)
 
-        assert main({"is_test": True, "aedb_path": file_path, "configuration_path": configuration_path})
+        main(is_test=True, execute={
+            "aedt_load": [
+                {"project_file": file_path,
+                 "file_cfg_path": configuration_path,
+                 "file_save_path": file_path.replace(".aedb", "_1.aedt")}
+            ],
+            "aedt_export": [
+                {"project_file": file_path,
+                 "file_path_save": configuration_path.replace(".json", "_1.json")}
+            ],
+            "active_load": [],
+            "active_export": [],
+            "siwave_load": [],
+            "siwave_export": [],
+        })
+
+        main(is_test=True, execute={
+            "aedt_load": [],
+            "aedt_export": [],
+            "active_load": [{"project_file": file_path,
+                             "file_cfg_path": configuration_path,
+                             "file_save_path": file_path.replace(".aedb", "_1.aedt")}],
+            "active_export": [{"project_file": file_path,
+                               "file_path_save": configuration_path.replace(".json", "_1.json")}],
+            "siwave_load": [],
+            "siwave_export": [],
+        })
 
     def test_08_advanced_fields_calculator_non_general(self, add_app):
         aedtapp = add_app(application=ansys.aedt.core.Hfss,
@@ -179,13 +205,13 @@ def test_08_advanced_fields_calculator_non_general(self, add_app):
             "assignment": "",
             "assignment_type": ["Line"],
             "operations": ["Fundamental_Quantity('E')",
-                            "Operation('Real')",
-                            "Operation('Tangent')",
-                            "Operation('Dot')",
-                            "EnterLine('assignment')",
-                            "Operation('LineValue')",
-                            "Operation('Integrate')",
-                            "Operation('CmplxR')"],
+                           "Operation('Real')",
+                           "Operation('Tangent')",
+                           "Operation('Dot')",
+                           "EnterLine('assignment')",
+                           "Operation('LineValue')",
+                           "Operation('Integrate')",
+                           "Operation('CmplxR')"],
             "report": ["Data Table", "Rectangular Plot"],
         }
 
@@ -383,4 +409,3 @@ def test_15_import_asc(self, local_scratch, add_app):
         from ansys.aedt.core.workflows.circuit.import_schematic import main
         assert main({"is_test": True, "asc_file": file_path})
         aedtapp.close_project()
-

doc/source/User_guide/pyaedt_extensions_doc/project/configure_edb.rst

@@ -1,28 +1,31 @@
 Configure layout EDB
 ====================
 
-Single configuration file to set up layout for any kind of PCB & package analysis.
+------------
+Introduction
+------------
 
+This extension provides the capability of
 
-The following image shows the extension user interface:
-
-.. image:: ../../../_static/extensions/configure_edb.png
-  :width: 800
-  :alt: Configure Layout UI
-
-
-The available arguments are: ``aedb_path``, ``configuration_path``.
-User can pass as an argument a configuration file (a json formatted file or a toml file), or a folder containing more
-than N configuration files. In such case the script creates N new aedb projects, each one with corresponding
-setting file applied.
+- Apply simulation configuration to HFSS 3D Layout design or SIwave project.
+- Export simulation configuration as a text file from HFSS 3D Layout design or SIwave project.
 
+The simulation configuration file is a text file in json or toml format. It contains information like layer stackup,
+materials, components, HFSS/SIwave setups, etc. This configure file can be used to set up PCB for DCIR, signal
+integrity as well as power integrity analysis.
 
 .. image:: ../../../_static/extensions/configure_edb_way_of_work.png
   :width: 800
   :alt: Principle of working of Layout UI
 
+Please refer to EDB Configuration `User Guide`_ for details
+
+.. _User Guide: https://edb.docs.pyansys.com/version/stable/examples/use_configuration/index.html
+
+--------------------------------------------------------------------------
+A brief description of which options are defined in the configuration file
+--------------------------------------------------------------------------
 
-A brief description of which options are defined in the configuration file:
 
 .. image:: ../../../_static/extensions/edb_config_setup.png
   :width: 800
@@ -38,3 +41,46 @@ configuration setup and re-use it with or without modifications as many times as
 The value of this format and toolkit, lies in the fact that it is totally reusable, it is really user-friendly, even with users that are not familiar with scripting.
 It supports most of the options that the UI also supports (not only the ones explained above, but many additional), and it has the advantage of obtaining the initial
 configuration file from the design, by using its export property.
+
+----------
+How to use
+----------
+
+.. image:: ../../../_static/extensions/configure_edb.png
+  :width: 800
+  :alt: Configure Layout UI
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Configure HFSS 3D Layout design in active AEDT project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1, Select ``Active Design`` in GUI.
+
+2, Make sure the HFSS 3D Layout design is open and active in AEDT.
+
+3, Click ``Select and Apply Configuration`` and browse to your configuration files.
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Configure HFSS 3D Layout design in a AEDT project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1, Select ``HFSS 3D Layout`` in GUI.
+
+2, Click ``Select Project File`` and browse to .aedt file.
+
+3, Click ``Select and Apply Configuration`` and browse to your configuration files.
+
+4, In the second pop-up window. Specify where to save the new project.
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Configure design in siwave project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1, Select ``SIwave`` in GUI.
+
+2, Click ``Select Project File`` and browse to .siw file.
+
+3, Click ``Select and Apply Configuration`` and browse to your configuration files.
+
+4, In the second pop-up window. Specify where to save the new project.