Merge branch 'main' into refacto/maxwell_examples

Author: Samuelopez-ansys

doc/Makefile

@@ -23,7 +23,7 @@ help:
 		@echo "Removing vtk to avoid conflicts with vtk-osmesa needed for CI/CD"; \
 		pip uninstall --yes vtk; \
 		@echo "Installing vtk-osmesa"; \
-		pip install --extra-index-url https://wheels.vtk.org vtk-osmesa==9.2.20230527.dev0; \
+		pip install --extra-index-url https://wheels.vtk.org vtk-osmesa; \
 	fi
 	@if [ "${ON_CI}" = "True" ] && [ "$$is_pypandoc_binary_installed" != "yes" ]; then \
 		@echo "Removing pypandoc to avoid conflicts with pypandoc-binary needed for CI/CD"; \

doc/make.bat

@@ -22,7 +22,7 @@ if NOT "%is_vtk_osmesa_installed%" == "vtk-osmesa" if "%ON_CI%" == "true" (
 	@ECHO ON
 	echo "Installing vtk-osmesa"
 	@ECHO OFF
-	pip install --extra-index-url https://wheels.vtk.org vtk-osmesa==9.2.20230527.dev0)
+	pip install --extra-index-url https://wheels.vtk.org vtk-osmesa)
 for /f %%i in ('pip freeze ^| findstr /c:"pypandoc_binary"') do set is_pypandoc_binary_installed=%%i
 if NOT "%is_pypandoc_binary_installed%" == "pypandoc_binary" if "%ON_CI%" == "true" (
 	@ECHO ON

doc/source/conf.py

@@ -64,33 +64,6 @@ def run(self):
         return [addnodes.desc_name(text=member_name), addnodes.desc_content("", literal)]
 
 
-# Sphinx builder specific events hook
-
-
-def check_example_error(app: Sphinx, pagename: str, templatename:str , context:dict[str, Any], doctree: document):
-    """Log an error if the execution of an example as a notebook triggered an error.
-
-    Since the documentation build might not stop if the execution of a notebook triggered
-    an error, we use a flag to log that an error is spotted in the html page context.
-    """
-    # Check if the HTML contains an error message
-    if pagename.startswith("examples") and not pagename.endswith("/index"):
-        if any(
-            map(
-                lambda msg: msg in context["body"],
-                [
-                    "UsageError",
-                    "NameError",
-                    "DeadKernelError",
-                    "NotebookError",
-                    "CellExecutionError",
-                ],
-            )
-        ):
-            logger.error(f"An error was detected in file {pagename}")
-            app.builder.config.html_context["build_error"] = True
-
-
 # Sphinx generic event hooks
 
 
@@ -227,8 +200,8 @@ def check_build_finished_without_error(app: Sphinx, exception: None | Exception)
     exception : None or Exception
         Exception raised during the build process.
     """
-    if app.builder.config.html_context.get("build_error", False):
-        logger.info("Build failed due to an error in html-page-context")
+    if exception is not None:
+        logger.error("Build failed due to an error.")
         exit(1)
 
 def remove_doctree(app: Sphinx, exception: None | Exception):
@@ -261,8 +234,6 @@ def setup(app):
         Sphinx instance containing all the configuration for the documentation build.
     """
     app.add_directive("pprint", PrettyPrintDirective)
-    # Builder specific hook
-    app.connect("html-page-context", check_example_error)
     # Builder inited hooks
     app.connect("builder-inited", copy_examples)
     app.connect("builder-inited", check_pandoc_installed)

examples/02-HFSS/Array.py

@@ -8,30 +8,25 @@
 # Keywords: **HFSS**, **antenna array**, **far field**.
 
 
-# ## Perform required imports
-#
-# Perform required imports.
+# ## Preparation
+# Import the required packages
 
 import os
 import tempfile
+import time
+
 import pyaedt
-from pyaedt.modules.solutions import FfdSolutionData
+from pyaedt.generic.farfield_visualization import FfdSolutionData
 
-# Set constant values
+# Define constants.
 
 AEDT_VERSION = "2024.1"
 NUM_CORES = 4
-
-# ## 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
 
-temp_dir = tempfile.TemporaryDirectory(suffix="_ansys")
+temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Download 3D component
 # Download the 3D component that is needed to run the example.
@@ -42,22 +37,26 @@
 #
 # Launch HFSS and open the project.
 
-project_name = pyaedt.generate_unique_project_name(rootname=temp_dir.name, project_name="array")
+# +
+project_name = os.path.join(temp_dir.name, "array.aedt")
 hfss = pyaedt.Hfss(
     project=project_name,
     version=AEDT_VERSION,
     design="Array_Simple",
-    non_graphical=non_graphical,
+    non_graphical=NG_MODE,
     new_desktop=True,
 )
 
 print("Project name " + project_name)
+# -
 
 # ## Read array definition from JSON file
 #
 # Read JSON file.
 
-dict_in = pyaedt.general_methods.read_json(os.path.join(example_path, "array_simple.json"))
+dict_in = pyaedt.general_methods.read_json(
+    os.path.join(example_path, "array_simple.json")
+)
 
 # ## 3D Component definition
 #
@@ -91,81 +90,87 @@
 setup = hfss.create_setup()
 setup.props["Frequency"] = "5GHz"
 setup.props["MaximumPasses"] = 3
-
-hfss.analyze(num_cores=NUM_CORES)
+hfss.analyze(cores=NUM_CORES)
 
 
 # ## Get far field data
 #
 # Get far field data. After the simulation completes, the far
 # field data is generated port by port and stored in a data class.
 
-ffdata = hfss.get_antenna_ffd_solution_data(
-    sphere_name="Infinite Sphere1", setup_name=hfss.nominal_adaptive, frequencies=[5e9]
-)
+ffdata = hfss.get_antenna_data(setup=hfss.nominal_adaptive, sphere="Infinite Sphere1")
 
 # ## Generate contour plot
 #
 # Generate a contour plot. You can define the Theta scan and Phi scan.
 
-ffdata.plot_farfield_contour(
-    farfield_quantity="RealizedGain", title="Contour at {}Hz".format(ffdata.frequency)
+ffdata.farfield_data.plot_contour(
+    quantity="RealizedGain",
+    title="Contour at {}Hz".format(ffdata.farfield_data.frequency),
 )
 
 # ## Release AEDT
 #
 # Release AEDT.
 # Far field post-processing can be performed without AEDT because the data is stored.
 
-eep_file = ffdata.eep_files
-frequencies = ffdata.frequencies
+metadata_file = ffdata.metadata_file
 working_directory = hfss.working_directory
 
+hfss.save_project()
 hfss.release_desktop()
+# Wait 3 seconds to allow Electronics Desktop to shut down before cleaning the temporary directory.
+time.sleep(3)
 
 # ## Load far field data
 #
 # Load far field data stored.
 
-ffdata = FfdSolutionData(frequencies=frequencies[0], eep_files=eep_file[0])
+ffdata = FfdSolutionData(input_file=metadata_file)
 
 # ## Generate contour plot
 #
 # Generate a contour plot. You can define the Theta scan
 # and Phi scan.
 
-ffdata.plot_farfield_contour(
-    farfield_quantity="RealizedGain", title="Contour at {}Hz".format(ffdata.frequency)
+ffdata.plot_contour(
+    quantity="RealizedGain", title="Contour at {}Hz".format(ffdata.frequency)
 )
 
 # ## Generate 2D cutout plots
 #
 # Generate 2D cutout plots. You can define the Theta scan
 # and Phi scan.
 
-ffdata.plot_2d_cut(
+ffdata.plot_cut(
+    quantity="RealizedGain",
     primary_sweep="theta",
     secondary_sweep_value=[-180, -75, 75],
-    farfield_quantity="RealizedGain",
     title="Azimuth at {}Hz".format(ffdata.frequency),
     quantity_format="dB10",
 )
 
-ffdata.plot_2d_cut(
+ffdata.plot_cut(
+    quantity="RealizedGain",
     primary_sweep="phi",
     secondary_sweep_value=30,
-    farfield_quantity="RealizedGain",
     title="Elevation",
     quantity_format="dB10",
 )
 
-# ## Generate 3D polar plots in Matplotlib
+# ## Generate 3D plot
 #
-# Generate 3D polar plots in Matplotlib. You can define
-# the Theta scan and Phi scan.
+# Generate 3D plots. You can define the Theta scan and Phi scan.
 
-ffdata.polar_plot_3d(farfield_quantity="RealizedGain")
+# ffdata.plot_3d(quantity='RealizedGain',
+#                output_file=os.path.join(working_directory, "Image.jpg"),
+#                show=False)
 
-# ## Clean temporary directory
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.name``.
+# If you've run this example as a Jupyter notebook you
+# can retrieve those project files. The following cell
+# removes all temporary files, including the project folder.
 
 temp_dir.cleanup()

examples/02-HFSS/Create_3d_Component_and_use_it.py

@@ -9,30 +9,35 @@
 #
 # Keywords: **HFSS**, **3D Component**.
 
-# ## Perform required imports
-#
-# Perform required imports.
+# ## Preparation
+# Import the required packages
 
 import os
 import tempfile
+import time
 
 from pyaedt import Hfss
-from pyaedt.generic.general_methods import generate_unique_name
 
-# Set constant values
+# ## Project setup
+#
+# Define constants
 
 AEDT_VERSION = "2024.1"
+NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# ## Create temporary directory
+# Create temporary directory
 
-temp_dir = tempfile.TemporaryDirectory(suffix="_ansys")
+temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
 
-# ## Launch AEDT
-#
-# Launch AEDT, create an HFSS design, and save the project.
+# Create an HFSS object.
 
-hfss = Hfss(version=AEDT_VERSION, new_desktop=True, close_on_exit=True)
-hfss.save_project(os.path.join(temp_dir.name, generate_unique_name("example") + ".aedt"))
+hfss = Hfss(
+    version=AEDT_VERSION,
+    new_desktop=True,
+    close_on_exit=True,
+    non_graphical=NG_MODE,
+)
+hfss.save_project(os.path.join(temp_dir.name, "example.aedt"))
 
 # ## Variable definition
 #
@@ -49,15 +54,23 @@
 
 # +
 substrate = hfss.modeler.create_box(
-    ["-width", "-width", "-thick"], ["2*width", "2*width", "thick"], matname="FR4_epoxy", name="sub"
+    ["-width", "-width", "-thick"],
+    ["2*width", "2*width", "thick"],
+    matname="FR4_epoxy",
+    name="sub",
 )
 
 patch = hfss.modeler.create_rectangle(
     "XY", ["-width/2", "-width/2", "0mm"], ["width", "width"], name="patch1"
 )
 
 via1 = hfss.modeler.create_cylinder(
-    2, ["-width/8", "-width/4", "-thick"], "0.01mm", "thick", matname="copper", name="via_inner"
+    2,
+    ["-width/8", "-width/4", "-thick"],
+    "0.01mm",
+    "thick",
+    matname="copper",
+    name="via_inner",
 )
 
 via_outer = hfss.modeler.create_cylinder(
@@ -84,7 +97,9 @@
 
 # +
 side_face = [
-    i for i in via_outer.faces if i.id not in [via_outer.top_face_z.id, via_outer.bottom_face_z.id]
+    i
+    for i in via_outer.faces
+    if i.id not in [via_outer.top_face_z.id, via_outer.bottom_face_z.id]
 ]
 
 hfss.assign_perfecte_to_sheets(side_face)
@@ -106,14 +121,14 @@
 # Multiple options are available to partially select objects, cs, boundaries and mesh operations.
 # Furthermore, encrypted 3d comp can be created too.
 
-component_path = os.path.join(temp_dir.name, generate_unique_name("component_test") + ".aedbcomp")
+component_path = os.path.join(temp_dir.name, "component_test.aedbcomp")
 hfss.modeler.create_3dcomponent(component_path, "patch_antenna")
 
 # ## Multiple project management
 #
 # PyAEDT allows to control multiple projects, design and solution type at the same time.
 
-new_project = os.path.join(temp_dir.name, generate_unique_name("new_project") + ".aedt")
+new_project = os.path.join(temp_dir.name, "new_project.aedt")
 hfss2 = Hfss(project=new_project, design="new_design")
 
 # ## Insert 3D component
@@ -137,7 +152,7 @@
 # They can be the same or linked to different files.
 
 hfss2.modeler.create_coordinate_system(origin=[20, 20, 10], name="Second_antenna")
-ant2 = hfss2.modeler.insert_3d_component(component_path, targetCS="Second_antenna")
+ant2 = hfss2.modeler.insert_3d_component(component_path, coordinate_system="Second_antenna")
 
 # ## Move 3D components
 #
@@ -165,14 +180,22 @@
 hfss2.modeler.fit_all()
 hfss2.plot(
     show=False,
-    export_path=os.path.join(hfss.working_directory, "Image.jpg"),
+    output_file=os.path.join(hfss.working_directory, "Image.jpg"),
     plot_air_objects=True,
 )
 
 # ## Release AEDT
 
+hfss2.save_project()
 hfss2.release_desktop()
+# Wait 3 seconds to allow Electronics Desktop to shut down before cleaning the temporary directory.
+time.sleep(3)
 
-# ## Clean temporary directory
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.name``.
+# If you've run this example as a Jupyter notebook you
+# can retrieve those project files. The following cell removes
+# all temporary files, including the project folder.
 
 temp_dir.cleanup()