Improved Examples Titles (#652)

* Improved Examples Titles * Fixed style errors * Apply suggestions from code review Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com> Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
ansys · Dec 16, 2021 · ddab517 · ddab517
1 parent 4ef432f
commit ddab517
Show file tree

Hide file tree

Showing 27 changed files with 101 additions and 70 deletions.
diff --git a/doc/source/Resources/viawizard.png b/doc/source/Resources/viawizard.png
diff --git a/examples/00-EDB/00_EDB_Create_VIA.py b/examples/00-EDB/00_EDB_Create_VIA.py
@@ -1,6 +1,6 @@
 """
 EDB Geometry Creation
----------------------------
+---------------------
 This example shows how to use EDB to create a layout.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/3dlayout.png'

diff --git a/examples/00-EDB/01_edb_example.py b/examples/00-EDB/01_edb_example.py
@@ -1,6 +1,6 @@
 """
-EDB  Analysis
---------------
+Siwave Analysis from EDB Setup
+------------------------------
 This example shows how to use EDB to interact with a layout.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/edb.png'

diff --git a/examples/00-EDB/02_edb_to_ipc2581.py b/examples/00-EDB/02_edb_to_ipc2581.py
@@ -1,6 +1,6 @@
 """
-IPC 2581 Exporter
------------------
+IPC 2581 Export
+---------------
 This example shows how to use PyAEDT to Export an IPC2581 file.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/ipc2581.png'

diff --git a/examples/00-EDB/03_5G_antenna_example.py b/examples/00-EDB/03_5G_antenna_example.py
@@ -1,6 +1,6 @@
 """
 5G linear array antenna
---------------------------------------
+-----------------------
 This example shows how to use HFSS 3D Layout to create and solve a 5G linear array antenna.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/5gantenna.png'

diff --git a/examples/00-EDB/04_edb_parametrized_design.py b/examples/00-EDB/04_edb_parametrized_design.py
@@ -1,15 +1,16 @@
 """
-Example of fully parameterized design using edb.
--------------------------------------------------------
+Fully parameterized design
+--------------------------
 This example shows how to use HFSS 3D Layout to create and solve a parametric design.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/parametrized_edb.png'
 
 ###############################################################################
-# # Import the `Hfss3dlayout` Object
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Import the `Hfss3dlayout` Object
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # This example imports the `Hfss3dlayout` object and initializes it on version
 # 2021.1.
+
 import tempfile
 from pyaedt import Edb
 from pyaedt.generic.general_methods import generate_unique_name
@@ -126,7 +127,9 @@ def get_variable_value(self, variable_name=""):
         return value.ToDouble()
 
 
-# layer stackup ####
+####################
+# Layer stackup
+#
 if edb:
     edb.core_stackup.stackup_layers.add_layer("bottom")
     edb.core_stackup.stackup_layers.add_layer(
@@ -175,7 +178,7 @@ def get_variable_value(self, variable_name=""):
 net_name2 = "strip_line_n"
 
 ######################
-# line p
+# line placement
 #
 seg1_p = line(width="$line_width", net_name=net_name, layer="top")
 
@@ -188,12 +191,17 @@ def get_variable_value(self, variable_name=""):
 seg1_p.place_line()
 path_port_1p = edb.core_primitives.primitives[-1]
 
-# via placement ####
+####################
+# via placement
+#
+
 via_instance(
     pos_x="$pcb_len/3", pos_y="($line_width+$line_spacing+$via_spacing)/2", rotation=90, net_name=net_name
 ).place_via(viadef1)
 
-# line creation ####
+####################
+# line creation
+#
 seg2_p = line(width="$line2_width", net_name=net_name, layer="sig1")
 seg2_p.point_list = [
     ["$pcb_len/3", "($line_width+$line_spacing+$via_spacing)/2"],
@@ -212,7 +220,10 @@ def get_variable_value(self, variable_name=""):
     pos_x="2*$pcb_len/3", pos_y="($line_width+$line_spacing+$via_spacing)/2", rotation=90, net_name=net_name
 ).place_via(viadef1)
 
-# line creation ####
+####################
+# line creation
+#
+
 seg3_p = line(width="$line_width", net_name=net_name, layer="top")
 seg3_p.point_list = [
     ["2*$pcb_len/3", "($line_width+$line_spacing+$via_spacing)/2"],
@@ -226,7 +237,7 @@ def get_variable_value(self, variable_name=""):
 ##################
 # line n
 #
-# line creation ####
+# line creation
 seg1_n = line(width="$line_width", net_name=net_name2, layer="top")
 
 seg1_n.point_list = [
@@ -237,12 +248,18 @@ def get_variable_value(self, variable_name=""):
 ]
 seg1_n.place_line()
 
-# via placement ####
+##################
+# via placement
+#
+
 via_instance(
     pos_x="$pcb_len/3", pos_y="-($line_width+$line_spacing+$via_spacing)/2", rotation=-90, net_name=net_name2
 ).place_via(viadef1)
 
-# line creation ####
+##################
+# line creation
+#
+
 seg2_n = line(width="$line2_width", net_name=net_name2, layer="sig1")
 seg2_n.point_list = [
     ["$pcb_len/3", "-($line_width+$line_spacing+$via_spacing)/2"],
@@ -254,12 +271,17 @@ def get_variable_value(self, variable_name=""):
 ]
 seg2_n.place_line()
 
-# via placement ####
+##################
+# via placement
+#
+
 via_instance(
     pos_x="2*$pcb_len/3", pos_y="-($line_width+$line_spacing+$via_spacing)/2", rotation=-90, net_name=net_name2
 ).place_via(viadef1)
 
-# line creation ####
+####################
+# line creation
+
 seg3_p = line(width="$line_width", net_name=net_name2, layer="top")
 seg3_p.point_list = [
     ["2*$pcb_len/3", "-($line_width+$line_spacing+$via_spacing)/2"],
@@ -268,8 +290,10 @@ def get_variable_value(self, variable_name=""):
     ["$pcb_len", "-($line_width+$line_spacing)/2"],
 ]
 seg3_p.place_line()
+##########################
+# GND plane
+#
 
-# ####### GND plane #########
 rectangle(
     lower_left_corner=[0.0, "-$pcb_w/2"],
     upper_right_corner=["$pcb_len", "$pcb_w/2"],
@@ -291,18 +315,24 @@ def get_variable_value(self, variable_name=""):
     "bottom", "gnd"
 )
 
-# saving edb #####
+##########################
+# saving edb
 edb.save_edb()
 edb.close_edb()
 
-# opening edb in aedt ####
+##########################
+# opening edb in aedt
 h3d = Hfss3dLayout(projectname=os.path.join(aedb_path, "edb.def"), specified_version="2021.2", non_graphical=False)
 
-# creating wave ports ####
+##########################
+# creating wave ports
+
 h3d.create_wave_port_from_two_conductors(["line_0", "line_3"], [0, 0])
 h3d.create_wave_port_from_two_conductors(["line_5", "line_2"], [5, 5])
 
-# adding hfss simulation setup ####
+##########################
+# adding hfss simulation setup
+
 setup = h3d.create_setup()
 h3d.create_linear_count_sweep(
     setupname=setup.name,
@@ -317,6 +347,8 @@ def get_variable_value(self, variable_name=""):
     save_fields=False,
     use_q3d_for_dc=False,
 )
-# start hfss solver ####
+
+##########################
+# start hfss solver. Uncomment to solve
 # h3d.analyze_nominal()
 h3d.release_desktop()
diff --git a/examples/00-EDB/Advanced_EDB.py b/examples/00-EDB/Advanced_EDB.py
@@ -1,8 +1,9 @@
 """
-EDB Parametric Via Creation
----------------------------
+Parametric Via Creation
+-----------------------
 This example shows how to use EDB to create a layout.
 """
+# sphinx_gallery_thumbnail_path = 'Resources/viawizard.png'
 
 import os
 import numpy as np

diff --git a/examples/01-Modeling-Setup/HFSS_CoordinateSystem.py b/examples/01-Modeling-Setup/HFSS_CoordinateSystem.py
@@ -1,6 +1,6 @@
 """
-Coordinate System Creation Example
-----------------------------------
+Coordinate System Creation
+--------------------------
 This example shows how you can use PyAEDT to create and modify coordinate systems in the modeler.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/coordinate_system.png'

diff --git a/examples/01-Modeling-Setup/Optimetrics.py b/examples/01-Modeling-Setup/Optimetrics.py
@@ -1,6 +1,6 @@
 """
-Optimetrics Example Analysis
-----------------------------
+Optimetrics Setup
+-----------------
 This example shows how you can use PyAEDT to create a project in HFSS and create all optimetrics setups.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/optimetrics.png'

diff --git a/examples/01-Modeling-Setup/Polyline_Primitives.py b/examples/01-Modeling-Setup/Polyline_Primitives.py
@@ -1,6 +1,6 @@
 """
-Polyline Example Analysis
--------------------------
+Polyline Creation
+-----------------
 This example shows how you can use PyAEDT to create and manipulate polylines.
 """
 

diff --git a/examples/02-HFSS/EDB_in_3DLayout.py b/examples/02-HFSS/EDB_in_3DLayout.py
@@ -1,6 +1,6 @@
 """
-HFSS 3D Layout Analysis
------------------------
+PCB and EDB in HFSS 3D Layout
+-----------------------------
 This example shows how to use HFSS 3D Layout combined with EDB to interact with a layout.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/edb2.png'

diff --git a/examples/02-HFSS/HFSS_Dipole.py b/examples/02-HFSS/HFSS_Dipole.py
@@ -1,6 +1,6 @@
 """
-Dipole Antenna Example
-----------------------
+Dipole Antenna
+--------------
 This example shows how you can use PyAEDT to create an antenna setup in HFSS and postprocess results.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/Dipole.png'

diff --git a/examples/02-HFSS/HFSS_Spiral.py b/examples/02-HFSS/HFSS_Spiral.py
@@ -1,6 +1,6 @@
 """
-Spiral Inductor Example
------------------------
+Spiral Inductor
+---------------
 This example shows how you can use PyAEDT to create a spiral inductor, solve it and plot results.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/spiral.png'

diff --git a/examples/02-HFSS/SBR_Doppler_Example.py b/examples/02-HFSS/SBR_Doppler_Example.py
@@ -1,6 +1,6 @@
 """
-SBR+ Doppler Example
---------------------
+SBR+ Doppler Setup
+------------------
 This example shows how you can use PyAEDT to create a Multipart Scenario in SBR+ and setup a doppler Analysis.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/sherlock_doppler.png'

diff --git a/examples/02-HFSS/SBR_Example.py b/examples/02-HFSS/SBR_Example.py
@@ -1,8 +1,8 @@
 """
-SBR+ Example
-------------
-This example shows how you can use PyAEDT to create a Busbar project in
-in Q3D and run a simulation.
+HFSS to SBR+ Coupling
+---------------------
+This example shows how you can use PyAEDT to create an SBR+ project from Hfss
+antenna and run a simulation.
 """
 ###############################################################################
 # Import Packages

diff --git a/examples/02-Maxwell/Maxwell2D_Eddy.py b/examples/02-Maxwell/Maxwell2D_Eddy.py
@@ -1,6 +1,6 @@
 """
-Maxwell 2D  Coil Analysis
--------------------------
+2D  Coil Analysis
+-----------------
 This example shows how you can use PyAEDT to create a project in
 Maxwell2D and run an eddy current simulation.
 

diff --git a/examples/02-Maxwell/Maxwell2D_Transient.py b/examples/02-Maxwell/Maxwell2D_Transient.py
@@ -1,7 +1,6 @@
 """
-
-Maxwell 2D Analysis
--------------------
+Transient Winding Analysis
+--------------------------
 This example shows how you can use PyAEDT to create a project in Maxwell 2D
 and run a transient simulation. It runs only on Windows using CPython.
 

diff --git a/examples/02-Maxwell/Maxwell3D_TEAM7.py b/examples/02-Maxwell/Maxwell3D_TEAM7.py
@@ -1,7 +1,6 @@
 """
-TEAM Problem 7 'Asymmetrical Conductor with a Hole'
-Maxwell 3D Eddy Current Analysis
--------------------------
+Asymmetrical Conductor with a Hole
+----------------------------------
 This example shows how you can use PyAEDT to create a project in
 Maxwell3D and run an eddy current simulation.
 

diff --git a/examples/02-Maxwell/Maxwell_Magnet.py b/examples/02-Maxwell/Maxwell_Magnet.py
@@ -1,6 +1,6 @@
 """
-Magnet Example
---------------
+3D Magnet DC Analysis
+---------------------
 This example shows how you can use PyAEDT to create a Maxwell DC Analysis,
 compute mass center and move Coordinate Systems.
 """

diff --git a/examples/03-Circuit/Circuit_Example.py b/examples/03-Circuit/Circuit_Example.py
@@ -1,6 +1,6 @@
 """
-Circuit Example Analysis
-------------------------
+Schematic Creation and Analysis
+-------------------------------
 This example shows how you can use PyAEDT to create a Circuit design
 and run a Nexxim time-domain simulation.
 """

diff --git a/examples/03-Circuit/Create_Netlist.py b/examples/03-Circuit/Create_Netlist.py
@@ -1,6 +1,6 @@
 """
-Netlist Example Analysis
-------------------------
+Netlist to Schematic Import
+---------------------------
 # This example shows how to import Netlist data into a
 # Circuit design. Supported Netlist files are HSPICE and,
 # partially, Mentor.

diff --git a/examples/03-Circuit/EMIT_Example.py b/examples/03-Circuit/EMIT_Example.py
@@ -1,6 +1,6 @@
 """
 EMIT Example
---------------------------------------------
+------------
 This tutorial shows how you can use PyAEDT to create a project in EMIT.
 """
 # sphinx_gallery_thumbnail_path = 'Resources/emit.png'

diff --git a/examples/03-Circuit/Touchstone_Management.py b/examples/03-Circuit/Touchstone_Management.py
@@ -1,5 +1,5 @@
 """
-Manage Touchstone Objects
+Touchstone File Management
 --------------------------
 This example shows how to use Touchstone objects without opening AEDT.
 

diff --git a/examples/04-Icepak/Icepak_Example.py b/examples/04-Icepak/Icepak_Example.py
@@ -1,6 +1,6 @@
 """
-Icepak Example
-----------------------
+Graphic Card Thermal Analsyis
+-----------------------------
 This example shows how you can use PyAEDT to create an Graphic Card setup in Icepak and postprocess results.
 The example file is an Icepak Project with a model already created and with materials assigned.
 """

diff --git a/examples/05-Q3D/Q3D_Example.py b/examples/05-Q3D/Q3D_Example.py
@@ -1,6 +1,6 @@
 """
-Q3D Busbar Analysis
--------------------
+Busbar Analysis
+---------------
 This example shows how you can use PyAEDT to create a busbar design in
 in Q3D and run a simulation.
 """

diff --git a/examples/06-Multiphysics/Hfss_Icepak_Coupling.py b/examples/06-Multiphysics/Hfss_Icepak_Coupling.py
@@ -1,6 +1,6 @@
 """
-HFSS-Icepack Coupling Analysis
-------------------------------
+HFSS-Icepack Multyphisics Analysis
+----------------------------------
 This example shows how to create a full project from scratch in HFSS and Icepak (linked to HFSS).
 The project creates a setup, solves it, and creates post-processing output. It includes several
 commands to show PyAEDT's capabilities.