FEAT: Add PyAEDT examples (#219)

* Skip example if launched in non graphical mode or from documentation build

* Add thumbnail

* Add thumbnail

* Modify thumbnail

* Add Circuit Hfss Icepak example

* Add electrothermal

* Add Virtual compliance

* Add Virtual compliance

* Import sys

* Change design names

* Update deprecataed warning

* Update deprecated arguments

* Update workdir

* clean virtual compliance

* temp_dir to temp_folder

* fix Circuit_Hfss_Icepak_Coupling.py

* # set constants -> # ## Define constants

* jupyter clean up

---------

Co-authored-by: Giulia Malinverno <giulia.malinverno@ansys.com>

Author: Samuelopez-ansys

README.md

@@ -31,11 +31,11 @@ The following guidelines help ensure that the examples are consistent, easy to r
   ```
   Create a temporary folder at the beginning of the example:
   ```
-     temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+     temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
   ```
   Remove the temporary folder at the end of the example:
   ```
-     temp_dir.cleanup()
+     temp_folder.cleanup()
   ```
 - The examples should be formatted, so they are compatible with 
   [jupytext](https://jupytext.readthedocs.io/en/latest/) using the [light format](https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format) and can

doc/source/_static/thumbnails/charging.png

@@ -385,13 +385,16 @@ def setup(app):
     "examples/08-Circuit/Circuit_Siwave_Multizones": "_static/thumbnails/multizone.png",
     "examples/08-Circuit/Circuit_Subcircuit_Example": "_static/thumbnails/subcircuit.png",
     "examples/08-Circuit/Create_Netlist": "_static/thumbnails/netlist.png",
+    "examples/08-Circuit/Virtual_Compliance": "_static/thumbnails/virtual_compliance_eye.png",
     "examples/09-Multiphysics/Circuit_HFSS_Icepak_Coupling": "_static/thumbnails/ring.png",
+    "examples/09-Multiphysics/Maxwell_Icepak_Wireless_Charging": "_static/thumbnails/charging.png",
     "examples/10-EMIT/ComputeInterferenceType": "_static/thumbnails/interference.png",
     "examples/10-EMIT/ComputeProtectionLevels": "_static/thumbnails/protection.png",
     "examples/10-EMIT/EMIT_Example": "_static/thumbnails/emit.png",
     "examples/10-EMIT/EMIT_HFSS_Example": "_static/thumbnails/emit_hfss.png",
     "examples/11-twin_builder/static_rom_creation_and_visualization": "_static/thumbnails/static_rom.png",
     "examples/12-general/com_analysis": "_static/thumbnails/com_eye.png",
+    "examples/12-general/convert_model_version": "_static/thumbnails/e3dcomp.png",
 }
 nbsphinx_custom_formats = {
     ".py": ["jupytext.reads", {"fmt": ""}],

doc/source/_static/thumbnails/e3dcomp.png

@@ -43,12 +43,18 @@
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
 # ## Create temporary directory
+#
+# Create temporary directory.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Download project
 
-project_full_name = ansys.aedt.core.downloads.download_icepak(destination=temp_dir.name)
+project_full_name = ansys.aedt.core.downloads.download_icepak(
+    destination=temp_folder.name
+)
 
 # ## Open project
 #
@@ -118,7 +124,7 @@
 #
 # Create an Icepak project and import the step.
 
-new_project = os.path.join(temp_dir.name, "example.aedt")
+new_project = os.path.join(temp_folder.name, "example.aedt")
 app = ansys.aedt.core.Icepak(version=AEDT_VERSION, project=new_project)
 app.modeler.import_3d_cad(file_path)
 
@@ -140,9 +146,9 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``.
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()

doc/source/_static/thumbnails/multizone.png

@@ -18,9 +18,14 @@
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# ## Create temporary directory
+# ## Create temporary directory and download files
+#
+# Create a temporary directory where we store downloaded data or
+# dumped data.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Launch AEDT
 
@@ -32,7 +37,7 @@
 #
 # Insert an HFSS design with the default name.
 
-project_name = os.path.join(temp_dir.name, "CoordSysDemo.aedt")
+project_name = os.path.join(temp_folder.name, "CoordSysDemo.aedt")
 hfss = ansys.aedt.core.Hfss(version=AEDT_VERSION, project=project_name)
 
 # ## Create coordinate system
@@ -289,7 +294,7 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``. If you've run this example as a Jupyter notebook you
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()

doc/source/_static/thumbnails/virtual_compliance_eye.png

@@ -19,17 +19,22 @@
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# ## Create temporary directory
+# ## Create temporary directory and download files
+#
+# Create a temporary directory where we store downloaded data or
+# dumped data.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Initialize HFSS and create variables
 #
 # Initialize the ``Hfss`` object and create two needed design variables,
 # ``w1`` and ``w2``.
 
 # +
-project_name = os.path.join(temp_dir.name, "optimetrics.aedt")
+project_name = os.path.join(temp_folder.name, "optimetrics.aedt")
 
 hfss = ansys.aedt.core.Hfss(
     project=project_name,
@@ -151,9 +156,9 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``.
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()

doc/source/conf.py

@@ -19,15 +19,20 @@
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
 
-# ## Create temporary directory
+# ## Create temporary directory and download files
+#
+# Create a temporary directory where we store downloaded data or
+# dumped data.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Create Maxwell 3D object
 #
 # Create a `Maxwell3d` object and set the unit type to ``"mm"``.
 
-project_name = os.path.join(temp_dir.name, "polyline.aedt")
+project_name = os.path.join(temp_folder.name, "polyline.aedt")
 maxwell = ansys.aedt.core.Maxwell3d(
     project=project_name,
     solution_type="Transient",
@@ -339,9 +344,9 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``.
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()

examples/01-Modeling-Setup/Configurations.py

@@ -25,20 +25,26 @@
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
 # ## Create temporary directory
+#
+# Create temporary directory.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Download 3D component
 # Download the 3D component that is needed to run the example.
 
-example_path = ansys.aedt.core.downloads.download_3dcomponent(destination=temp_dir.name)
+example_path = ansys.aedt.core.downloads.download_3dcomponent(
+    destination=temp_folder.name
+)
 
 # ## Launch HFSS and open project
 #
 # Launch HFSS and open the project.
 
 # +
-project_name = os.path.join(temp_dir.name, "array.aedt")
+project_name = os.path.join(temp_folder.name, "array.aedt")
 hfss = ansys.aedt.core.Hfss(
     project=project_name,
     version=AEDT_VERSION,
@@ -170,9 +176,9 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``.
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()

examples/01-Modeling-Setup/CoordinateSystem.py

@@ -25,9 +25,13 @@
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# Create temporary directory
+# ## Create temporary directory
+#
+# Create temporary directory.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix=".ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # Create an HFSS object.
 
@@ -37,7 +41,7 @@
     close_on_exit=True,
     non_graphical=NG_MODE,
 )
-hfss.save_project(os.path.join(temp_dir.name, "example.aedt"))
+hfss.save_project(os.path.join(temp_folder.name, "example.aedt"))
 
 # ## Variable definition
 #
@@ -121,14 +125,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, "component_test.aedbcomp")
+component_path = os.path.join(temp_folder.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, "new_project.aedt")
+new_project = os.path.join(temp_folder.name, "new_project.aedt")
 hfss2 = Hfss(version=AEDT_VERSION, project=new_project, design="new_design")
 
 # ## Insert 3D component
@@ -195,9 +199,9 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``.
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()

examples/01-Modeling-Setup/Optimetrics.py

@@ -16,7 +16,7 @@
 import ansys.aedt.core
 from ansys.aedt.core.generic.general_methods import generate_unique_name
 
-# Set constant values
+# ## Define constants
 
 AEDT_VERSION = "2024.2"
 
@@ -27,9 +27,14 @@
 
 non_graphical = False
 
-# ## Create temporary directory
+# ## Create temporary directory and download files
+#
+# Create a temporary directory where we store downloaded data or
+# dumped data.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix="_ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Launch AEDT
 #
@@ -42,7 +47,7 @@
     non_graphical=non_graphical,
 )
 hfss.save_project(
-    os.path.join(temp_dir.name, generate_unique_name("example") + ".aedt")
+    os.path.join(temp_folder.name, generate_unique_name("example") + ".aedt")
 )
 
 # ## Design settings
@@ -246,4 +251,4 @@ def create_bending(radius, extension=0):
 
 # ## Clean temporary directory
 
-temp_dir.cleanup()
+temp_folder.cleanup()

examples/01-Modeling-Setup/Polyline_Primitives.py

@@ -15,18 +15,23 @@
 
 import ansys.aedt.core
 
-# Set constant values
+# ## Define constants
 
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open Electronics UI when the application is launched.
 
-# ## Create temporary directory
+# ## Create temporary directory and download files
+#
+# Create a temporary directory where we store downloaded data or
+# dumped data.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
 
-temp_dir = tempfile.TemporaryDirectory(suffix="_ansys")
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Launch HFSS
 
-project_name = os.path.join(temp_dir.name, "choke.aedt")
+project_name = os.path.join(temp_folder.name, "choke.aedt")
 hfss = ansys.aedt.core.Hfss(
     project=project_name,
     version=AEDT_VERSION,
@@ -256,9 +261,9 @@
 
 # ## Cleanup
 #
-# All project files are saved in the folder ``temp_dir.name``.
+# All project files are saved in the folder ``temp_folder.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()
+temp_folder.cleanup()