Merge branch 'main' into add/circuit_maxwell

Author: Samuelopez-ansys

.github/workflows/ci_cd.yml

@@ -16,8 +16,8 @@ env:
   DOCUMENTATION_CNAME: 'examples.aedt.docs.pyansys.com'
   MAIN_PYTHON_VERSION: '3.10'
   ON_CI: True
-  PACKAGE_NAME: 'pyaedt-examples'
   PYAEDT_NON_GRAPHICAL: '1'
+  # To keep as it impacts pyaedt behavior
   PYAEDT_DOC_GENERATION: '1'
 
 concurrency:

doc/source/conf.py

@@ -252,6 +252,11 @@ def convert_examples_into_notebooks(app):
     EXAMPLES_TO_NOT_EXECUTE = (
         "03_gui_manipulation.py",
         "05_electrothermal.py",
+        # TODO: Remove the following example when 2025.1 is released, currently the latest version is 24.1.
+        "Lumped_Element_Response.py",
+        # TODO: Remove once EMIT examples are moved into extensions.
+        "ComputeInterferenceType.py",
+        "interference_gui.py",
     )
 
     # NOTE: Only convert the examples if the workflow isn't tagged as coupling HTML and PDF build.

examples/02-HFSS/Waveguide_Filter.py

@@ -45,9 +45,6 @@
     "t": 0.15,
     "units": "in",
 }
-
-non_graphical = False
-new_thread = True
 # -
 
 # ## Create temporary directory and download files

examples/04-Layout/hfss_3d_layout/03_gui_manipulation.py

@@ -23,11 +23,11 @@
 
 AEDT_VERSION = "2024.2"
 NUM_CORES = 4
-NG_MODE = False  # Open Electronics UI when the application is launched.
+NG_MODE = True  # Open Electronics UI when the application is launched.
 
 # Check if AEDT is launched in graphical mode.
 
-if not NG_MODE or os.getenv("PYAEDT_DOC_GENERATION", "0") == "1":
+if not NG_MODE:
     print("Warning: this example requires graphical mode enabled.")
     sys.exit()
 

examples/04-Layout/hfss_3d_layout/04_pre_layout_sma_connector_on_pcb.py.back examples/04-Layout/hfss_3d_layout/04_pre_layout_sma_connector_on_pcb.py

@@ -30,11 +30,11 @@
 
 AEDT_VERSION = "2024.2"
 NUM_CORES = 4
-NG_MODE = False  # Open Electronics UI when the application is launched.
+NG_MODE = True  # Open Electronics UI when the application is launched.
 
 # Check if AEDT is launched in graphical mode.
 
-if not NG_MODE or os.getenv("PYAEDT_DOC_GENERATION", "0") == "1":
+if not NG_MODE:
     print("Warning: this example requires graphical mode enabled.")
     sys.exit()
 

examples/04-Layout/hfss_3d_layout/05_electrothermal.py

@@ -9,6 +9,7 @@ pre-layout design creation.
     01_power_integrity
     02_dc_ir_analysis
     03_gui_manipulation.py
+    04_pre_layout_sma_connector_on_pcb.py
     05_electrothermal.py
     06_ipc2581_export.py
     07_import_gds.py

examples/04-Layout/hfss_3d_layout/index.rst

@@ -33,17 +33,6 @@
 
 temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
-# ## Launch AEDT
-#
-# Launch AEDT in graphical mode. This example uses SI units.
-
-# ## Set non-graphical mode
-#
-# Set non-graphical mode.
-# You can set ``non_graphical`` either to ``True`` or ``False``.
-# The Boolean parameter ``new_thread`` defines whether to create a new instance
-# of AEDT or try to connect to an existing instance of it.
-
 # ## Launch AEDT and Circuit
 #
 # Launch AEDT and Circuit. The [pyaedt.Desktop](

examples/08-Circuit/Circuit_Example.py

@@ -41,7 +41,7 @@
 #
 # - The argument ``non_graphical`` specifies whether or not an interactive session will be launched or if
 #   AEDT runs in non-graphical mode.
-# - The Boolean parameter ``new_thread`` specifies if a new instance
+# - The Boolean parameter ``new_desktop`` specifies if a new instance
 #   of AEDT will be launched. If it is set to ``False`` the API will try to connect to a running session.
 #
 # This example extracts an archived project. The full path

examples/08-Circuit/Results.py

@@ -9,12 +9,11 @@
 # Perform required imports
 
 # +
-import os
-import subprocess
 import sys
 import tempfile
 
 import ansys.aedt.core
+import plotly.graph_objects as go
 from ansys.aedt.core import Emit
 from ansys.aedt.core.emit_core.emit_constants import InterfererType
 
@@ -25,34 +24,6 @@
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# ## Python Dependencies
-#
-# The following cell can be run to make sure the ``plotly`` package is installed
-# in the current Python environment. If ``plotly`` is installed there is no need
-# to run this cell.
-
-# +
-reqs = subprocess.check_output([sys.executable, "-m", "pip", "freeze"])
-installed_packages = [r.decode().split("==")[0] for r in reqs.split()]
-
-
-# Install required packages if they are not installed
-def install(package):
-    subprocess.check_call([sys.executable, "-m", "pip", "install", package])
-
-
-# Install plotly (if needed) to display legend and
-# scenario matrix results (internet connection needed)
-required_packages = ["plotly"]
-for package in required_packages:
-    if package not in installed_packages:
-        install(package)
-
-# Import plotly library
-import plotly.graph_objects as go
-
-# -
-
 # ## Create temporary directory
 #
 # Create temporary directory.
@@ -103,10 +74,11 @@ def install(package):
 
 power_matrix = []
 all_colors = []
-if os.getenv("PYAEDT_DOC_GENERATION", "0") != "1":
-    all_colors, power_matrix = rev.interference_type_classification(
-        domain, use_filter=False, filter_list=[]
-    )
+
+
+all_colors, power_matrix = rev.interference_type_classification(
+    domain, use_filter=False, filter_list=[]
+)
 
 # ## Release AEDT
 #
@@ -238,12 +210,11 @@ def create_legend_table():
     fig.show()
 
 
-if os.getenv("PYAEDT_DOC_GENERATION", "0") != "1":
-    # Create a scenario view for all the interference types
-    create_scenario_view(power_matrix, all_colors, tx_radios, rx_radios)
+# Create a scenario view for all the interference types
+create_scenario_view(power_matrix, all_colors, tx_radios, rx_radios)
 
-    # Create a legend for the interference types
-    create_legend_table()
+# Create a legend for the interference types
+create_legend_table()
 
 # ## Cleanup
 #

examples/10-EMIT/ComputeInterferenceType.py

@@ -12,13 +12,14 @@
 
 # +
 import os
-import subprocess
 import sys
 import tempfile
 import time
 
+import plotly.graph_objects as go
 from ansys.aedt.core import Emit
-from ansys.aedt.core.emit_core.emit_constants import InterfererType
+from ansys.aedt.core.emit_core.emit_constants import \
+    InterfererType  # noqa: F401
 
 # -
 
@@ -27,34 +28,6 @@
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# ## Python Dependencies
-#
-# The following cell can be run to make sure the ``plotly`` package is installed
-# in the current Python environment. If ``plotly`` is installed there is no need
-# to run this cell.
-
-# +
-# Check to see which Python packages have been installed
-reqs = subprocess.check_output([sys.executable, "-m", "pip", "freeze"])
-installed_packages = [r.decode().split("==")[0] for r in reqs.split()]
-
-
-# Install required packages if they are not installed
-def install(package):
-    subprocess.check_call([sys.executable, "-m", "pip", "install", package])
-
-
-# Install any missing libraries
-required_packages = ["plotly"]
-for package in required_packages:
-    if package not in installed_packages:
-        install(package)
-# -
-
-# Import to support plotting.
-
-import plotly.graph_objects as go
-
 # ## Create temporary directory
 #
 # Create temporary directory.
@@ -271,31 +244,33 @@ def create_scenario_view(emis, colors, tx_radios, rx_radios):
 #
 # Get lists of all transmitters and receivers in the project.
 
-if os.getenv("PYAEDT_DOC_GENERATION", "0") != "1":
-    rev = emitapp.results.current_revision
-    rx_radios = rev.get_receiver_names()
-    tx_radios = rev.get_interferer_names(InterfererType.TRANSMITTERS)
-    domain = emitapp.results.interaction_domain()
+# NOTE : The following code can be uncommented.
+#
+# rev = emitapp.results.current_revision
+# rx_radios = rev.get_receiver_names()
+# tx_radios = rev.get_interferer_names(InterfererType.TRANSMITTERS)
+# domain = emitapp.results.interaction_domain()
 
 # ## Classify the results
 #
 # Iterate over all the transmitters and receivers and compute the power
 # at the input to each receiver due to each of the transmitters. Computes
 # which, if any, protection levels are exceeded by these power levels.
 
-if os.getenv("PYAEDT_DOC_GENERATION", "0") != "1":
-    power_matrix = []
-    all_colors = []
+# NOTE : The following code can be uncommented but depends on the previous commented code.
+#
+# power_matrix = []
+# all_colors = []
 
-    all_colors, power_matrix = rev.protection_level_classification(
-        domain, global_levels=protection_levels
-    )
+# all_colors, power_matrix = rev.protection_level_classification(
+#     domain, global_levels=protection_levels
+# )
 
-    # Create a scenario matrix-like view for the protection levels
-    create_scenario_view(power_matrix, all_colors, tx_radios, rx_radios)
+# # Create a scenario matrix-like view for the protection levels
+# create_scenario_view(power_matrix, all_colors, tx_radios, rx_radios)
 
-    # Create a legend for the protection levels
-    create_legend_table()
+# # Create a legend for the protection levels
+# create_legend_table()
 
 # ## Release AEDT
 #

examples/10-EMIT/ComputeProtectionLevels.py

@@ -12,25 +12,19 @@
 # Perform required imports.
 
 # +
-import os
 import tempfile
 import time
 
 import ansys.aedt.core
-from ansys.aedt.core.emit_core.emit_constants import ResultType, TxRxMode
+from ansys.aedt.core.emit_core.emit_constants import (
+    ResultType, TxRxMode)  # noqa: F401
 
 # -
 
 # ## Define constants
 
 AEDT_VERSION = "2024.2"
-
-# ## Set non-graphical mode
-#
-# Set non-graphical mode.
-# You can set ``non_graphical`` either to ``True`` or ``False``.
-
-non_graphical = False
+NG_MODE = False  # Open Electronics UI when the application is launched.
 
 # ## Create temporary directory and download files
 #
@@ -50,7 +44,7 @@
 project_name = ansys.aedt.core.generate_unique_project_name(
     rootname=temp_folder.name, project_name="antenna_cosite"
 )
-d = ansys.aedt.core.launch_desktop(AEDT_VERSION, non_graphical, True)
+d = ansys.aedt.core.launch_desktop(AEDT_VERSION, NG_MODE, new_desktop=True)
 aedtapp = ansys.aedt.core.Emit(project_name, version=AEDT_VERSION)
 
 # ## Create and connect EMIT components
@@ -87,18 +81,20 @@
 #
 # This part of the example requires Ansys AEDT 2023 R2.
 
-if AEDT_VERSION > "2023.1" and os.getenv("PYAEDT_DOC_GENERATION", "0") != "1":
-    rev = aedtapp.results.analyze()
-    rx_bands = rev.get_band_names(rad2.name, TxRxMode.RX)
-    tx_bands = rev.get_band_names(rad3.name, TxRxMode.TX)
-    domain = aedtapp.results.interaction_domain()
-    domain.set_receiver(rad2.name, rx_bands[0], -1)
-    domain.set_interferer(rad3.name, tx_bands[0])
-    interaction = rev.run(domain)
-    worst = interaction.get_worst_instance(ResultType.EMI)
-    if worst.has_valid_values():
-        emi = worst.get_value(ResultType.EMI)
-        print("Worst case interference is: {} dB".format(emi))
+# NOTE : The following code can be uncommented.
+#
+# if AEDT_VERSION > "2023.1":
+#     rev = aedtapp.results.analyze()
+#     rx_bands = rev.get_band_names(rad2.name, TxRxMode.RX)
+#     tx_bands = rev.get_band_names(rad3.name, TxRxMode.TX)
+#     domain = aedtapp.results.interaction_domain()
+#     domain.set_receiver(rad2.name, rx_bands[0], -1)
+#     domain.set_interferer(rad3.name, tx_bands[0])
+#     interaction = rev.run(domain)
+#     worst = interaction.get_worst_instance(ResultType.EMI)
+#     if worst.has_valid_values():
+#         emi = worst.get_value(ResultType.EMI)
+#         print("Worst case interference is: {} dB".format(emi))
 
 # ## Release AEDT
 #