Addition example edits

Author: PipKat

examples/02-aedt_general/components/reuse_component.py

@@ -97,9 +97,9 @@
 # You can easily assign a boundary to a face or to an object by taking advantage of
 # Object-Oriented Programming (OOP) available in PyAEDT.
 
-# ### Assign perfect e to sheets
+# ### Assign Perfect E boundary to sheets
 #
-# Assign perfect e to sheets.
+# Assign a Perfect E boundary to sheets.
 
 hfss.assign_perfecte_to_sheets(patch)
 

examples/02-aedt_general/modeler/coordinate_system.py

@@ -199,7 +199,7 @@
 # ### Create a dependent coordinate system
 #
 # The use of dependent coordinate systems can simplify model creation. The following
-# cell demonstrates how to create a coordinate system whose reference is the face coordinate system.
+# cell shows how to create a coordinate system whose reference is the face coordinate system.
 
 face = box.faces[1]
 fcs6 = hfss.modeler.create_face_coordinate_system(

examples/03-high_frequency/antenna/index.rst

@@ -1,6 +1,6 @@
 Antenna
 ~~~~~~~
-These examples use PyAEDT to show some antenna examples
+These examples use PyAEDT to show some antenna applications.
 
 .. nbgallery::
 

examples/03-high_frequency/antenna/interferences/interference.py

@@ -1,4 +1,4 @@
-# # Classify Interference Type
+# # Interference type classification
 #
 # This example shows how to load an existing AEDT EMIT
 # design and analyze the results to classify the

examples/03-high_frequency/antenna/interferences/interference_type.py

@@ -1,4 +1,4 @@
-# # Classify interference type GUI
+# # Interference type classification using a GUI
 #
 # This example uses a GUI to open an AEDT project with
 # an EMIT design and analyze the results to classify the

examples/03-high_frequency/emc/armoured_cable.py

@@ -2,19 +2,18 @@
 
 # This example shows how to use PyAEDT to perform these tasks:
 #
-#  - Create a Q2D design using modeler primitives and imported CAD.
+#  - Create a Q2D design using modeler primitives and an imported CAD.
 #  - Set up the simulation.
 #  - Link the solution to a Simplorer design.
 #
-# For information on the cable model used in this example please see the following link:
-#
-# - [4 Core Armoured Power Cable]
-# (https://www.luxingcable.com/low-voltage-cables/4-core-armoured-power-cable.html)
+# For information on the cable model used in this example, see
+# [4 Core Armoured Power Cable](https://www.luxingcable.com/low-voltage-cables/4-core-armoured-power-cable.html).
 #
 # Keywords: **Q2D**, **EMC**, **cable**.
 
-# ## Perform required imports
+# ## Perform imports and define constants
 #
+# Perform required imports.
 
 import math
 import os
@@ -23,18 +22,23 @@
 
 import ansys.aedt.core
 
-# ## Create temporary directory
-
-temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
-
 # Define constants.
 
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open AEDT UI when it is launched.
 
+# ## Create temporary directory
+#
+# Create a temporary directory where downloaded data or
+# dumped data can be stored.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
+
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
+
 # ## Set up for model creation
 #
-# Initialize cable sizing - radii in mm.
+# Initialize cable sizing by specifying radii in millimeters.
 
 c_strand_radius = 2.575
 cable_n_cores = 4
@@ -58,8 +62,8 @@
 arm_strand_rad = armour_thickness / 2.0 - 0.2
 n_arm_strands = 30
 
-# Start an instance of the Q2D extractor, providing the version, project name, design
-# name and type.
+# Start an instance of Q2D Extractor, providing the version, project name, design
+# name, and type.
 
 project_name = os.path.join(temp_folder.name, "Q2D_ArmouredCableExample.aedt")
 q2d_design_name = "2D_Extractor_Cable"
@@ -74,7 +78,7 @@
 )
 q2d.modeler.model_units = "mm"
 
-# Assign the variables to the Q3D design.
+# Assign variables to the Q3D design.
 
 core_params = {
     "n_cores": str(cable_n_cores),
@@ -101,22 +105,23 @@
     q2d[k] = v
 
 # Cable insulators require the definition of specific materials since they are not
-# included in the Sys Library.
-# Plastic, PE (cross-linked, wire, and cable grade)
+# included in the ``Sys`` library.
+#
+# Define Plastic, PE (cross-linked, wire, and cable grade):
 
 mat_pe_cable_grade = q2d.materials.add_material("plastic_pe_cable_grade")
 mat_pe_cable_grade.conductivity = "1.40573e-16"
 mat_pe_cable_grade.permittivity = "2.09762"
 mat_pe_cable_grade.dielectric_loss_tangent = "0.000264575"
 mat_pe_cable_grade.update()
 
-# Plastic, PP (10% carbon fiber)
+# Define Plastic, PP (10% carbon fiber):
 
 mat_pp = q2d.materials.add_material("plastic_pp_carbon_fiber")
 mat_pp.conductivity = "0.0003161"
 mat_pp.update()
 
-# ## Model Creation
+# ## Create model
 #
 # Create the geometry for core strands, fill, and XLPE insulation.
 
@@ -191,7 +196,7 @@
 )
 arm_fill_id.color = (255, 255, 255)
 
-# Create geometry for the outer sheath.
+# Create the geometry for the outer sheath.
 
 outer_sheath_id = q2d.modeler.create_circle(
     origin=["0mm", "0mm", "0mm"],
@@ -201,7 +206,7 @@
 )
 outer_sheath_id.color = (0, 0, 0)
 
-# Create the geometry for armature steel strands.
+# Create the geometry for the armature steel strands.
 
 arm_strand_1_id = q2d.modeler.create_circle(
     origin=["0mm", "armour_centre_pos", "0mm"],
@@ -240,23 +245,25 @@
 model = q2d.plot(show=False)
 model.plot(os.path.join(temp_folder.name, "Image.jpg"))
 
-# Specify the design settings
+# Specify the design settings.
 
 lumped_length = "100m"
 q2d.design_settings["LumpedLength"] = lumped_length
 
-# ## Solve the model
+# ## Solve model
 #
-# Insert setup and frequency sweep
+# Insert the setup and frequency sweep.
 
 q2d_setup = q2d.create_setup(name=setup_name)
 q2d_sweep = q2d_setup.add_sweep(name=sweep_name)
 
 # The cable model is generated by running two solution types:
+#
 # 1. Capacitance and conductance per unit length (CG).
 # For this model, the CG solution runs in a few seconds.
+#
 # 2. Series resistance and inductance (RL).
-# For this model the solution time can range from 15-20 minutes,
+# For this model, the solution time can range from 15-20 minutes,
 # depending on the available hardware.
 #
 # Uncomment the following line to run the analysis.
@@ -267,7 +274,7 @@
 
 # ## Evaluate results
 #
-# Add a Simplorer/Twin Builder design and the Q3D dynamic component
+# Add a Simplorer/Twin Builder design and the Q3D dynamic component.
 
 tb = ansys.aedt.core.TwinBuilder(design=tb_design_name, version=AEDT_VERSION)
 

examples/03-high_frequency/emc/busbar.py

@@ -5,7 +5,7 @@
 #
 # Keywords: **Q3D**, **EMC*, **busbar**.
 
-# ## Perform required imports
+# ## Perform imports and define constants
 #
 # Perform required imports.
 
@@ -15,15 +15,16 @@
 
 import ansys.aedt.core
 
-# ## Define constants
+# Define constants.
 
 AEDT_VERSION = "2024.2"
 NUM_CORES = 4
 NG_MODE = False
 
 # ## Create temporary directory
 #
-# Create temporary directory.
+# Create a temporary directory where downloaded data or
+# dumped data can be stored.
 # If you'd like to retrieve the project data for subsequent use,
 # the temporary folder name is given by ``temp_folder.name``.
 
@@ -125,9 +126,9 @@
 sweep.props["RangeStep"] = "5MHz"
 sweep.update()
 
-# ### Setup for postprocessing
+# ### Set up for postprocessing
 #
-# Specify the traces that will be displayed after solving the model.
+# Specify the traces to display after solving the model.
 
 data_plot_self = q3d.matrices[0].get_sources_for_plot(
     get_self_terms=True, get_mutual_terms=False
@@ -136,7 +137,7 @@
     get_self_terms=False, get_mutual_terms=True, category="C"
 )
 
-# Define a plot and a data table in Electronics Desktop for visualizing results.
+# Define a plot and a data table in AEDT for visualizing results.
 
 q3d.post.create_report(expressions=data_plot_self)
 q3d.post.create_report(

examples/03-high_frequency/emc/choke.py

@@ -4,7 +4,7 @@
 #
 # Keywords: **HFSS**, **EMC**, **choke**, .
 
-# ## Perform required imports
+# ## Perform imports and define constants
 #
 # Perform required imports.
 
@@ -15,15 +15,15 @@
 
 import ansys.aedt.core
 
-# ## Define constants
+# Define constants.
 
 AEDT_VERSION = "2024.2"
 NG_MODE = False  # Open AEDT UI when it is launched.
 
 # ## Create temporary directory
 #
-# Create a temporary directory where we store downloaded data or
-# dumped data.
+# Create a temporary directory where downloaded data or
+# dumped data can be stored.
 # If you'd like to retrieve the project data for subsequent use,
 # the temporary folder name is given by ``temp_folder.name``.
 
@@ -40,7 +40,7 @@
     solution_type="Terminal",
 )
 
-# ## Rules and information of use
+# ## Define parameters
 #
 # The dictionary values contain the different parameter values of the core and
 # the windings that compose the choke. You must not change the main structure of
@@ -58,23 +58,23 @@
 # correct one by default. For the dictionaries from ``"Core"`` through ``"Inner Winding"``,
 # values must be strings, floats, or integers.
 #
-# Descriptions follow for primary keys:
+# Descriptions follow for the primary keys:
 #
-# - ``"Number of Windings"``: Number of windings around the core
-# - ``"Layer"``: Number of layers of all windings
+# - ``"Number of Windings"``: Number of windings around the core.
+# - ``"Layer"``: Number of layers of all windings.
 # - ``"Layer Type"``: Whether layers of a winding are linked to each other
 # - ``"Similar Layer"``: Whether layers of a winding have the same number of turns and
-# same spacing between turns
-# - ``"Mode"``: When there are only two windows, whether they are in common or differential mode
-# - ``"Wire Section"``: Type of wire section and number of segments
-# - ``"Core"``: Design of the core
+# same spacing between turns.
+# - ``"Mode"``: When there are only two windows, whether they are in common or differential mode.
+# - ``"Wire Section"``: Type of wire section and number of segments.
+# - ``"Core"``: Design of the core.
 # - ``"Outer Winding"``: Design of the first layer or outer layer of a winding and the common
-# parameters for all layers
-# - ``"Mid Winding"``: Turns and turns spacing ("Coil Pit") for the second or
-# mid layer if it is necessary
-# - ``"Inner Winding"``: Turns and turns spacing ("Coil Pit") for the third or inner
-# layer if it is necessary
-# - ``"Occupation(%)"``: An informative parameter that is useless to modify
+# parameters for all layers.
+# - ``"Mid Winding"``: Turns and turns spacing (``Coil Pit``) for the second or
+# mid layer if it is necessary.
+# - ``"Inner Winding"``: Turns and turns spacing (``Coil Pit``) for the third or inner
+# layer if it is necessary.
+# - ``"Occupation(%)"``: An informative parameter that is useless to modify.
 #
 # The following parameter values work. You can modify them if you want.
 
@@ -110,7 +110,7 @@
 
 # ## Convert dictionary to JSON file
 #
-# Convert a dictionary to a JSON file. You must supply the path of the
+# Convert the dictionary to a JSON file. You must supply the path of the
 # JSON file as an argument.
 
 json_path = os.path.join(hfss.working_directory, "choke_example.json")
@@ -119,11 +119,11 @@
 
 # ## Verify parameters of JSON file
 #
-# Verify parameters of the JSON file. The ``check_choke_values`` method takes
+# Verify parameters of the JSON file. The ``check_choke_values()`` method takes
 # the JSON file path as an argument and does the following:
 #
-# - Checks if the JSON file is correctly written (as explained in the rules)
-# - Checks in equations on windings parameters to avoid having unintended intersections
+# - Checks if the JSON file is correctly written (as explained earlier).
+# - Checks equations on windings parameters to avoid having unintended intersections.
 
 dictionary_values = hfss.modeler.check_choke_values(
     json_path, create_another_file=False
@@ -142,8 +142,6 @@
 second_winding_list = list_object[3]
 
 # ## Create ground
-#
-# Create a ground.
 
 ground_radius = 1.2 * dictionary_values[1]["Outer Winding"]["Outer Radius"]
 ground_position = [0, 0, first_winding_list[1][0][2] - 2]
@@ -154,8 +152,6 @@
 ground.transparency = 0.9
 
 # ## Create lumped ports
-#
-# Create lumped ports.
 
 port_position_list = [
     [
@@ -192,8 +188,6 @@
     )
 
 # ## Create mesh
-#
-# Create the mesh.
 
 # +
 cylinder_height = 2.5 * dictionary_values[1]["Outer Winding"]["Height"]