docs: Update examples

.github/workflows/ci_cd.yml

@@ -10,7 +10,7 @@ on:
       - main
 
 env:
-  MAIN_PYTHON_VERSION: '3.11'
+  MAIN_PYTHON_VERSION: '3.12'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/ci_cd_nightly.yml

@@ -6,7 +6,7 @@ on:
     - cron: "0 3 * * *"
 
 env:
-  MAIN_PYTHON_VERSION: '3.11'
+  MAIN_PYTHON_VERSION: '3.12'
   DEV_MAJOR_REV: '25'
   DEV_MINOR_REV: '2'
 

examples/00_tips/tips_01.py

@@ -25,41 +25,41 @@
 3D visualization
 ----------------
 
-Visualize 3D imported geometry
+The following example demonstrates how to visualize imported geometry in 3D.
 """
 
 # %%
-# Import necessary libraries
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+# Import the necessary libraries
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 from ansys.mechanical.core import App
 from ansys.mechanical.core.examples import delete_downloads, download_file
 
 # %%
-# Embed mechanical and set global variables
+# Initialize the embedded application
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-app = App()
-app.update_globals(globals())
+app = App(globals=globals())
 print(app)
 
-
 # %%
-# Download and import geometry
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Download geometry
+# Download and import the geometry file
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+# %%
+# Download the geometry file
 geometry_path = download_file("Valve.pmdb", "pymechanical", "embedding")
 
 # %%
-# Import geometry
+# Define the model and import the geometry file
+model = app.Model
 
-geometry_import = Model.GeometryImportGroup.AddGeometryImport()
+geometry_import = model.GeometryImportGroup.AddGeometryImport()
 geometry_import.Import(geometry_path)
 
 # %%
-# Visualize in 3D
-# ~~~~~~~~~~~~~~~
+# Visualize the model in 3D
+# ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 app.plot()
 
@@ -68,8 +68,11 @@
 #     This visualization is currently available only for geometry and on version 24R2 or later
 
 # %%
-# Cleanup
-# ~~~~~~~
+# Clean up the files and app
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+# Delete the downloaded files
 delete_downloads()
-app.new()
+
+# Close the app
+app.close()

examples/00_tips/tips_02.py

@@ -25,35 +25,42 @@
 Export image
 ------------
 
-Export image and display
+The following example demonstrates how to export an image of the imported geometry
+and display it using matplotlib.
 """
 
 # %%
-# Import necessary libraries
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Import the necessary libraries
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-import os
+from pathlib import Path
 
 from ansys.mechanical.core import App
 from ansys.mechanical.core.examples import delete_downloads, download_file
 
 # %%
-# Embed Mechanical and set global variables
+# Initialize the embedded application
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+# Create an instance of the App class
 app = App()
+
+# Update the global variables
 app.update_globals(globals())
-print(app)
 
+# Print the app to ensure it is working
+print(app)
 
 # %%
-# Download and import geometry
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Download geometry
+# Download and import the geometry file
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+# %%
+# Download the geometry file
 geometry_path = download_file("Valve.pmdb", "pymechanical", "embedding")
 
 # %%
-# Import geometry
+# Import the geometry file
 
 geometry_import = Model.GeometryImportGroup.AddGeometryImport()
 geometry_import.Import(geometry_path)
@@ -62,38 +69,48 @@
 # Configure graphics for image export
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-# Orientation
-Graphics.Camera.SetSpecificViewOrientation(ViewOrientationType.Iso)
+# Set the orientation of the camera
+ExtAPI.Graphics.Camera.SetSpecificViewOrientation(ViewOrientationType.Iso)
 
-# Export format
+# Set the image export format
 image_export_format = GraphicsImageExportFormat.PNG
 
-# Resolution and background
+# Configure the export settings for the image
 settings_720p = Ansys.Mechanical.Graphics.GraphicsImageExportSettings()
 settings_720p.Resolution = GraphicsResolutionType.EnhancedResolution
 settings_720p.Background = GraphicsBackgroundType.White
 settings_720p.Width = 1280
 settings_720p.Height = 720
 settings_720p.CurrentGraphicsDisplay = False
 
-# Rotate the geometry if needed
-ExtAPI.Graphics.Camera.Rotate(180, CameraAxisType.ScreenY)
-
+# Rotate the geometry on the Y-axis
+Graphics.Camera.Rotate(180, CameraAxisType.ScreenY)
 
 # %%
-# Custom function for displaying the image
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Create a function to display the image
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 from matplotlib import image as mpimg
 from matplotlib import pyplot as plt
 
-# Temporary directory to save the image
-cwd = os.path.join(os.getcwd(), "out")
+# Directory to save the image
+output_path = Path.cwd() / "out"
+
 
+def display_image(image_name) -> None:
+    """Display the image using matplotlib.
 
-def display_image(image_name):
+    Parameters
+    ----------
+    image_name : str
+        The name of the image file to display.
+    """
+    # Create the full path to the image
+    image_path = output_path / image_name
+
+    # Plot the figure and display the image
     plt.figure(figsize=(16, 9))
-    plt.imshow(mpimg.imread(os.path.join(cwd, image_name)))
+    plt.imshow(mpimg.imread(str(image_path)))
     plt.xticks([])
     plt.yticks([])
     plt.axis("off")
@@ -104,19 +121,22 @@ def display_image(image_name):
 # Export and display the image
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-# Fits the geometry in the viewing area
+# Fit the geometry in the viewing area
 Graphics.Camera.SetFit()
 
-Graphics.ExportImage(
-    os.path.join(cwd, "geometry.png"), image_export_format, settings_720p
-)
+# Export the image
+geometry_image = output_path / "geometry.png"
+Graphics.ExportImage(str(geometry_image), image_export_format, settings_720p)
 
-# Display the image using matplotlib
-display_image("geometry.png")
+# Display the image
+display_image(geometry_image.name)
 
 # %%
-# Cleanup
-# ~~~~~~~
+# Clean up the downloaded files and app
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+# Delete the downloaded files
 delete_downloads()
-app.new()
+
+# Close the app
+app.close()

examples/00_tips/tips_03.py

@@ -23,27 +23,25 @@
 """.. _ref_tips_03:
 
 Project tree
---------------------
+------------
 
-Display the heirarchial Mechanical project structure.
+The following example demonstrates how to print the heirarchial Mechanical project structure.
 """
 
 # %%
-# Import necessary libraries
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+# Import the necessary libraries
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 from ansys.mechanical.core import App
 from ansys.mechanical.core.examples import delete_downloads, download_file
 
 # %%
-# Embed Mechanical and set global variables
+# Initialize the embedded application
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-app = App()
-app.update_globals(globals())
+app = App(globals=globals())
 print(app)
 
-
 # %%
 # Download the mechdb file
 # ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -65,12 +63,16 @@
 # Display the tree only under the first analysis
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-app.print_tree(Model.Analyses[0])
+first_analysis = app.Model.Analyses[0]
+app.print_tree(first_analysis)
 
 
 # %%
-# Cleanup
-# ~~~~~~~
+# Clean up the downloaded files and app
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+# Delete the downloaded files
 delete_downloads()
-app.new()
+
+# Close the app
+app.close()