Merge branch 'main' into update/04-Icepak

Author: SMoraisAnsys

.github/workflows/ci_cd.yml

@@ -12,10 +12,11 @@ on:
     - cron: "0 3 * * *"
 
 env:
-  MAIN_PYTHON_VERSION: '3.10'
-  PACKAGE_NAME: 'pyaedt-examples'
   ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
+  DOCUMENTATION_CNAME: 'examples.aedt.docs.pyansys.com'
+  MAIN_PYTHON_VERSION: '3.10'
   ON_CI: True
+  PACKAGE_NAME: 'pyaedt-examples'
   PYAEDT_NON_GRAPHICAL: '1'
   PYAEDT_DOC_GENERATION: '1'
 
@@ -93,28 +94,10 @@ jobs:
           path: doc/_build/latex
           retention-days: 7
 
-  release:
-    if: github.event_name == 'refs/heads/main' && !contains(github.ref, 'refs/tags')
-    needs: [doc-build, doc-style]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/download-artifact@v4
-
-      - name: Display structure of downloaded files
-        run: ls -R
-
-      - name: Zip HTML documentation
-        uses: vimtor/action-zip@v1.2
+      - name: Deploy
+        if: contains(github.ref, 'refs/heads/main')
+        uses: ansys/actions/doc-deploy-dev@v4
         with:
-          files: documentation-html
-          dest: documentation-html.zip
-
-      - name: Release
-        uses: softprops/action-gh-release@v2
-        with:
-          generate_release_notes: true
-          files: |
-            ./documentation-html.zip
-            ./documentation-pdf/*.pdf
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          doc-artifact-name: 'documentation-html'

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

@@ -8,20 +8,14 @@
 from pathlib import Path
 from pprint import pformat
 from docutils.nodes import document
-
-# import re
 import shutil
 from typing import Any
 from sphinx.application import Sphinx
-import sys
-import warnings
 
-# from sphinx_gallery.sorting import FileNameSortKey
 from ansys_sphinx_theme import (
     ansys_favicon,
     ansys_logo_white,
     ansys_logo_white_cropped,
-    # get_version_match,
     latex,
     pyansys_logo_black,
     watermark,
@@ -51,9 +45,6 @@
 cname = os.getenv("DOCUMENTATION_CNAME", "nocname.com")
 release = version = "0.1.dev0"
 
-# os.environ["PYAEDT_NON_GRAPHICAL"] = "1"
-# os.environ["PYAEDT_DOC_GENERATION"] = "1"
-
 # -- Connect functions (hooks) to Sphinx events  -----------------------------
 
 class PrettyPrintDirective(Directive):
@@ -73,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
 
 
@@ -236,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):
@@ -270,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)
@@ -343,20 +305,6 @@ def setup(app):
     # separating the parameter name and type",
 }
 
-# numpydoc_validation_exclude = {  # set of regex
-#     r"\.AEDTMessageManager.add_message$",  # bad SS05
-#     r"\.Modeler3D\.create_choke$",  # bad RT05
-#     r"HistoryProps.",  # bad RT05 because of the base class named OrderedDict
-# }
-
-# # Add any paths that contain templates here, relative to this directory.
-# templates_path = ["_templates"]
-
-# # disable generating the sphinx nested documentation
-# if "PYAEDT_CI_NO_AUTODOC" in os.environ:
-#     templates_path.clear()
-
-
 # Copy button customization ---------------------------------------------------
 # exclude traditional Python prompts from the copied code
 copybutton_prompt_text = r">>> ?|\.\.\. "
@@ -370,21 +318,9 @@ def setup(app):
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
-    # "_build",
-    # "sphinx_boogergreen_theme_1",
-    # "Thumbs.db",
-    # ".DS_Store",
-    # "*.txt",
     "conf.py",
-    # "constants.py",
 ]
 
-# inheritance_graph_attrs = dict(rankdir="RL", size='"8.0, 10.0"', fontsize=14, ratio="compress")
-# inheritance_node_attrs = dict(
-#     shape="ellipse", fontsize=14, height=0.75, color="dodgerblue1", style="filled"
-# )
-
-
 # -- Options for HTML output -------------------------------------------------
 
 source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
@@ -410,47 +346,15 @@ def setup(app):
 }
 
 # Pyvista customization
-# pyvista.set_error_output_file("errors.txt")
-# Ensure that offscreen rendering is used for docs generation
-# pyvista.OFF_SCREEN = True
-# Preferred plotting style for documentation
-# pyvista.set_plot_theme('document')
-# must be less than or equal to the XVFB window size
+
+# Must be less than or equal to the XVFB window size
 pyvista.global_theme["window_size"] = np.array([1024, 768])
 
 # Save figures in specified directory
 pyvista.FIGURE_PATH = os.path.join(os.path.abspath("./images/"), "auto-generated/")
 if not os.path.exists(pyvista.FIGURE_PATH):
     os.makedirs(pyvista.FIGURE_PATH)
 
-# # suppress annoying matplotlib bug
-# warnings.filterwarnings(
-#     "ignore",
-#     category=UserWarning,
-#     message="Matplotlib is currently using agg so figures are not shown.",
-# )
-
-# necessary for pyvista when building the sphinx gallery
-# pyvista.BUILDING_GALLERY = True
-
-# jinja_contexts = {
-#     "main_toctree": {
-#         "run_examples": config["run_examples"],
-#     },
-# }
-# def prepare_jinja_env(jinja_env) -> None:
-#     """
-#     Customize the jinja env.
-#
-#     Notes
-#     -----
-#     See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment
-#     """
-#     jinja_env.globals["project_name"] = project
-#
-#
-# autoapi_prepare_jinja_env = prepare_jinja_env
-
 # -- Options for HTML output -------------------------------------------------
 html_short_title = html_title = "PyAEDT Examples"
 html_theme = "ansys_sphinx_theme"

examples/01-HFSS3DLayout/01_power_integrity.py

@@ -1,13 +1,17 @@
 # # HFSS 3D Layout: Power Integrity Analysis
 # This example shows how to use the electronics database (EDB) for power integrity analysis. The 
 # EDB will be loaded into HFSS 3D Layout for analysis and post-processing.
+#
 # - Set up EDB
+#
 #     - Assign S-parameter model to components
 #     - Create pin groups
 #     - Create ports
 #     - Create SIwave SYZ anaylsis
 #     - Create cutout
+#
 # - Import EDB into HFSS 3D Layout
+#
 #     - Analyze
 #     - Plot $Z_{11}$
 

examples/01-HFSS3DLayout/02_dc_ir_analysis.py

@@ -1,14 +1,18 @@
 # # HFSS 3D Layout: DC IR Analysis
 # This example shows how to configure EDB for DC IR analysis, and load EDB into the 3D Layout UI for analysis and
 # post-processing.
+#
 # - Set up EDB
+#
 #     - Edit via padstack
 #     - Assign SPICE model to components
 #     - Create pin groups
 #     - Create voltage and current sources
 #     - Create SIwave DC anaylsis
 #     - Create cutout
+#
 # - Import EDB into HFSS 3D Layout
+#
 #     - Analyze
 #     - Get DC IR analysis results
 

examples/01-HFSS3DLayout/04_pre_layout_sma_connector_on_pcb.py

@@ -1,7 +1,9 @@
 # # HFSS 3D Layout: Pre-layout Signal Integrity
 # This example shows how to create a parameterized layout design, and load the layout into HFSS 3D Layout for analysis and
 # post-processing.
+#
 # - Create EDB
+#
 #     - Add material
 #     - Create stackup
 #     - Create a parameterized via padstack definition
@@ -10,7 +12,9 @@
 #     - Create signal vias and traces
 #     - Create ground stitching vias
 #     - Create HFSS analysis setup and frequency sweep
+#
 # - Import EDB into HFSS 3D Layout
+#
 #     - Place SMA connector
 #     - Analysis
 #     - Plot return loss

examples/01-Modeling-Setup/Configurations.py

@@ -23,41 +23,40 @@
 # any reason, this face position has changed or the object name in the target
 # design has changed, the boundary fails to apply.
 
-# ## Perform required imports
+# ## Preparation
+# Import the required packages
 
+# +
 import os
 import tempfile
+import time
 
 import pyaedt
 from pyaedt.generic.general_methods import generate_unique_name
+# -
 
-# Set constant values
+# Define constants
 
 AEDT_VERSION = "2024.1"
-
-# ## 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 project
 
 project_full_name = pyaedt.downloads.download_icepak(destination=temp_dir.name)
 
 # ## Open project
-
-# Open the project, and save it to the temporary folder.
+#
+# Open the Icepak project from the project folder.
 
 ipk = pyaedt.Icepak(
     project=project_full_name,
     version=AEDT_VERSION,
     new_desktop=True,
-    non_graphical=non_graphical,
+    non_graphical=NG_MODE,
 )
 ipk.autosave_disable()
 
@@ -99,23 +98,25 @@
     file_name=filename,
     file_path=ipk.working_directory,
     file_format=".step",
-    object_list=[],
-    removed_objects=[],
+    assignment_to_export=[],
+    assignment_to_remove=[],
 )
 
 # ## Export configuration files
 #
 # Export the configuration files. You can optionally disable the export and
 # import sections. Supported formats are json and toml files
 
-conf_file = ipk.configurations.export_config(os.path.join(ipk.working_directory, "config.toml"))
+conf_file = ipk.configurations.export_config(
+    os.path.join(ipk.working_directory, "config.toml")
+)
 ipk.close_project()
 
 # ## Create project
 #
 # Create an Icepak project and import the step.
 
-new_project = os.path.join(temp_dir.name, generate_unique_name("example") + ".aedt")
+new_project = os.path.join(temp_dir.name, "example.aedt")
 app = pyaedt.Icepak(project=new_project)
 app.modeler.import_3d_cad(file_path)
 
@@ -131,7 +132,13 @@
 # Close the project and release AEDT.
 
 app.release_desktop()
+time.sleep(3)   # Allow Electronics Desktop to shut down before cleaning the temporary project folder.
 
-# ## 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()