Remaining edits

Author: PipKat

examples/03-high_frequency/layout/signal_integrity/multizone.py

@@ -1,4 +1,4 @@
-# # Simulate multi-zone layout with SIwave
+# # Multi-zone simulation with SIwave
 #
 # This example shows how to simulate multiple zones with SIwave.
 #

examples/03-high_frequency/radiofrequency_mmwave/lumped_element.py

@@ -1,4 +1,4 @@
-# # Lumped element filter
+# # Lumped element filter design
 #
 # This example shows how to use PyAEDT to use the ``FilterSolutions`` module to design and
 # visualize the frequency response of a band-pass Butterworth filter.

examples/04-low_frequency/general/control_program.py

@@ -33,7 +33,7 @@
 
 # ## Download project file
 #
-# The files required to run this example are downloaded to the temporary working folder.
+# The files required to run this example Download the files required to run this example to the temporary working folder.
 
 aedt_file = downloads.download_file(
     source="maxwell_ctrl_prg",

examples/04-low_frequency/index.rst

@@ -17,7 +17,7 @@ These end-to-end examples show how to use PyAEDT for low-frequency applications.
          :height: 200px
          :align: center
 
-      This section shows some general workflows
+      General examples
 
    .. grid-item-card:: Motor
       :padding: 2 2 2 2
@@ -30,7 +30,7 @@ These end-to-end examples show how to use PyAEDT for low-frequency applications.
          :height: 200px
          :align: center
 
-      This section shows some layout automation examples
+      Motor examples
 
    .. grid-item-card:: Magnetics
       :padding: 2 2 2 2
@@ -43,14 +43,14 @@ These end-to-end examples show how to use PyAEDT for low-frequency applications.
          :height: 200px
          :align: center
 
-      This section shows some RF and millimeter wave workflows
+      Magnetics examples
 
-   .. grid-item-card:: TEAM problems
+   .. grid-item-card:: T.E.A.M
       :padding: 2 2 2 2
       :link: team_problem/index
       :link-type: doc
 
-      This section shows some T.E.A.M. examples
+      T.E.A.M. examples
 
    .. grid-item-card:: Multiphysics
       :padding: 2 2 2 2
@@ -63,7 +63,7 @@ These end-to-end examples show how to use PyAEDT for low-frequency applications.
          :height: 200px
          :align: center
 
-      This section shows some multiphysics examples
+      Multiphysics examples
 
    .. grid-item-card:: Report
       :padding: 2 2 2 2
@@ -76,7 +76,7 @@ These end-to-end examples show how to use PyAEDT for low-frequency applications.
          :height: 200px
          :align: center
 
-      This section shows report examples
+      Report examples
 
    .. toctree::
       :hidden:

examples/04-low_frequency/magnetic/choke.py

@@ -4,7 +4,7 @@
 #
 # Keywords: **Maxwell 3D**, **choke**.
 
-# ## Perform required imports
+# ## Perform imports and define constants
 #
 # Perform required imports.
 
@@ -15,17 +15,18 @@
 
 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 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``.
+# the temporary folder name is given by ``temp_folder.name``
 
 temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
@@ -42,9 +43,9 @@
     new_desktop=True,
 )
 
-# ## Rules and information of use
+# ## Define parameters
 #
-# The dictionary values containing the different parameters of the core and
+# 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
 # the dictionary. The dictionary has many primary keys, including
 # ``"Number of Windings"``, ``"Layer"``, and ``"Layer Type"``, that have
@@ -55,28 +56,28 @@
 # You must not modify the primary or secondary keys. You can modify only their values.
 # You must not change the data types for these keys. For the dictionaries from
 # ``"Number of Windings"`` through ``"Wire Section"``, values must be Boolean. Only
-# one value per dictionary can be ``"True"``. If all values are ``True``, only the first one
+# one value per dictionary can be ``True``. If all values are ``True``, only the first one
 # remains set to ``True``. If all values are ``False``, the first value is chosen as the
 # 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.
 
@@ -112,7 +113,7 @@
 
 # ## Convert dictionary to JSON file
 #
-# Convert a dictionary to a JSON file. PyAEDT methods ask for the path of the
+# Convert the dictionary to a JSON file. PyAEDT methods ask for the path of the
 # JSON file as an argument. You can convert a dictionary to a JSON file.
 
 # +
@@ -124,11 +125,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 inequations 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 = m3d.modeler.check_choke_values(
     input_dir=json_path, create_another_file=False
@@ -137,7 +138,7 @@
 
 # ## Create choke
 #
-# Create the choke. The ``create_choke`` method takes the JSON file path as an
+# Create the choke. The ``create_choke()`` method takes the JSON file path as an
 # argument.
 
 list_object = m3d.modeler.create_choke(input_file=json_path)
@@ -148,8 +149,6 @@
 third_winding_list = list_object[4]
 
 # ## Assign excitations
-#
-# Assign excitations.
 
 first_winding_faces = m3d.modeler.get_object_faces(
     assignment=first_winding_list[0].name
@@ -204,16 +203,12 @@
 )
 
 # ## Assign matrix
-#
-# Assign the matrix.
 
 m3d.assign_matrix(
     assignment=["phase_1_in", "phase_2_in", "phase_3_in"], matrix_name="current_matrix"
 )
 
 # ## Create mesh operation
-#
-# Create the mesh operation.
 
 mesh = m3d.mesh
 mesh.assign_skin_depth(
@@ -253,8 +248,6 @@
 )
 
 # ## Save project
-#
-# Save the project.
 
 m3d.save_project()
 m3d.modeler.fit_all()

examples/04-low_frequency/magnetic/lorentz_actuator.py

@@ -3,9 +3,9 @@
 # This example uses PyAEDT to set up a Lorentz actuator
 # and solve it using the Maxwell 2D transient solver.
 #
-# Keywords: **Maxwell2D**, **Transient**, **translational motion**, **mechanical transient**
+# Keywords: **Maxwell2D**, **transient**, **translational motion**, **mechanical transient**
 
-# ## Perform required imports
+# ## Perform imports and define constantss
 #
 # Perform required imports.
 
@@ -15,25 +15,28 @@
 
 import ansys.aedt.core
 
-# ## Define constants
+# Define constants.
 
 AEDT_VERSION = "2024.2"
 NUM_CORES = 4
 NG_MODE = False  # Open AEDT UI when it is launched.
 
 # ## 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``.
 
 temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
 
 # ## Initialize dictionaries
 #
-# Initialize electric and geometric parameters for the actuator.
-# Initialize simulation specification.
-# Initialize materials for the actuator component.
+# Initialize the following:
+#
+# - Electric and geometric parameters for the actuator
+# - Simulation specifications
+# - Materials for the actuator component
 
 dimensions = {
     "Core_outer_x": "100mm",
@@ -73,7 +76,7 @@
 # Launch AEDT and Maxwell 2D after first setting up the project name.
 # The following code also creates an instance of the
 # ``Maxwell2d`` class named ``m2d`` by providing
-# the project name, the design name, the solver, the version and the graphical mode.
+# the project name, the design name, the solver, the version, and the graphical mode.
 
 project_name = os.path.join(temp_folder.name, "Lorentz_actuator.aedt")
 m2d = ansys.aedt.core.Maxwell2d(
@@ -100,7 +103,7 @@
 for k, v in simulation_specifications.items():
     m2d[k] = v
 
-# Materials.
+# Definem materials.
 
 m2d.variable_manager.set_variable(name="Material data")
 m2d.logger.clear_messages()
@@ -119,7 +122,7 @@
 
 # ## Create geometry
 #
-# Create magnetic core, coils, and magnets. Assign materials and create a new coordinate system to
+# Create magnetic core, coils, and magnets. Assign materials and create a coordinate system to
 # define the magnet orientation.
 
 core_id = m2d.modeler.create_rectangle(
@@ -203,8 +206,8 @@
 
 # ## Assign motion
 #
-# Create band objects: all the objects within the band move. Inner band ensures that the mesh is good,
-# and additionally it is required when there more than 1 moving objects.
+# Create band objects. All the objects within the band move. The inner band ensures that the mesh is good,
+# and additionally it is required when there is more than one moving object.
 # Assign linear motion with mechanical transient.
 
 band_id = m2d.modeler.create_rectangle(
@@ -245,14 +248,14 @@
 
 # ## Create simulation domain
 #
-# Create region and assign zero vector potential on the region edges.
+# Create a region and assign zero vector potential on the region edges.
 
 region_id = m2d.modeler.create_region(pad_percent=2)
 m2d.assign_vector_potential(assignment=region_id.edges, boundary="VectorPotential1")
 
 # ## Assign mesh operations
 #
-# Transient solver does not have adaptive mesh refinement, so the mesh operations have to be assigned.
+# The transient solver does not have adaptive mesh refinement, so the mesh operations must be assigned.
 
 m2d.mesh.assign_length_mesh(
     assignment=[band_id, inner_band_id],
@@ -269,19 +272,17 @@
 
 # ## Turn on eddy effects
 #
-# Assign eddy effects to magnets.
+# Assign eddy effects to the magnets.
 
 m2d.eddy_effects_on(assignment=["magnet_n", "magnet_s"])
 
 # ## Turn on core loss
 #
-# Enable core loss for core.
+# Enable core loss for the core.
 
 m2d.set_core_losses(assignment="Core")
 
-# ## Create setup
-#
-# Create the simulation setup.
+# ## Create simulation setup
 
 setup = m2d.create_setup(name="Setup1")
 setup.props["StopTime"] = "Stop_time"
@@ -293,7 +294,8 @@
 
 # ## Create report
 #
-# Create a XY-report with force on coil and the position of the coil on Y-axis, time on X-axis.
+# Create an XY-report with force on the coil, the position of the coil on the Y axis,
+# and time on the X axis.
 
 m2d.post.create_report(
     expressions=["Moving1.Force_x", "Moving1.Position"],
@@ -302,8 +304,6 @@
 )
 
 # ## Analyze project
-#
-# Analyze the project.
 
 setup.analyze(cores=NUM_CORES, use_auto_settings=False)