Update SBR (#184)

Make consistent with template.

Co-authored-by: Samuel Lopez <85613111+Samuelopez-ansys@users.noreply.github.com>

Author: Devin-Crawford

examples/02-SBR+/SBR_City_Import.py

@@ -18,13 +18,7 @@
 # Set constant values
 
 AEDT_VERSION = "2024.1"
-
-# ## Set non-graphical mode
-#
-# Set non-graphical mode.
-# You can set ``non_graphical`` either to ``True`` or ``False``.
-
-non_graphical = False
+NG_MODE = False  # Open Electronics UI when the application is launched.
 
 # ## Create temporary directory
 
@@ -34,14 +28,14 @@
 #
 # Launch HFSS and open the project.
 
-project_name = pyaedt.generate_unique_project_name(rootname=temp_dir.name, project_name="city")
+project_name = os.path.join(temp_dir.name, "city.aedt")
 app = pyaedt.Hfss(
     project=project_name,
     design="Ansys",
     solution_type="SBR+",
     version=AEDT_VERSION,
     new_desktop=True,
-    non_graphical=non_graphical,
+    non_graphical=NG_MODE,
 )
 
 # ## Define Location to import
@@ -55,7 +49,11 @@
 # Assign boundaries.
 
 app.modeler.import_from_openstreet_map(
-    ansys_home, terrain_radius=250, road_step=3, plot_before_importing=False, import_in_aedt=True
+    ansys_home,
+    terrain_radius=250,
+    road_step=3,
+    plot_before_importing=False,
+    import_in_aedt=True,
 )
 
 # ## Plot model
@@ -76,6 +74,9 @@
 
 app.release_desktop()
 
-# ## Clean temporary directory
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.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()

examples/02-SBR+/SBR_Doppler_Example.py

@@ -17,13 +17,7 @@
 # Set constant values
 
 AEDT_VERSION = "2024.1"
-
-# ## Set non-graphical mode
-#
-# Set non-graphical mode.
-# You can set ``non_graphical`` either to ``True`` or ``False``.
-
-non_graphical = False
+NG_MODE = False  # Open Electronics UI when the application is launched.
 
 # ## Create temporary directory
 
@@ -38,16 +32,19 @@
 #
 # Launch HFSS and open the project.
 
-project_name = pyaedt.generate_unique_project_name(rootname=temp_dir.name, project_name="doppler")
+project_name = os.path.join(temp_dir.name, "doppler.aedt")
 app = pyaedt.Hfss(
     version=AEDT_VERSION,
     solution_type="SBR+",
     new_desktop=True,
     project=project_name,
     close_on_exit=True,
-    non_graphical=non_graphical,
+    non_graphical=NG_MODE,
 )
 
+# Creation of the "actors" in the scene is comprised of many editing steps. Disabling the "autosave" option helps
+# avoids delays that occur while the project is being saved.
+
 app.autosave_disable()
 
 # ## Save project and rename design
@@ -60,7 +57,7 @@
 
 # ## Set up library paths
 #
-# Set up library paths to 3D components.
+# Specify the location of 3D components used to create the scene.
 
 actor_lib = os.path.join(library_path, "actor_library")
 env_lib = os.path.join(library_path, "environment_library")
@@ -75,7 +72,7 @@
 #
 # Define the background environment.
 
-road1 = app.modeler.add_environment(env_folder=env_folder, environment_name="Bari")
+road1 = app.modeler.add_environment(input_dir=env_folder, name="Bari")
 prim = app.modeler
 
 # ## Place actors
@@ -84,37 +81,45 @@
 # in the environment.
 
 person1 = app.modeler.add_person(
-    actor_folder=person_folder, speed=1.0, global_offset=[25, 1.5, 0], yaw=180, actor_name="Massimo"
+    input_dir=person_folder,
+    speed=1.0,
+    global_offset=[25, 1.5, 0],
+    yaw=180,
+    name="Massimo",
 )
 person2 = app.modeler.add_person(
-    actor_folder=person_folder, speed=1.0, global_offset=[25, 2.5, 0], yaw=180, actor_name="Devin"
+    input_dir=person_folder,
+    speed=1.0,
+    global_offset=[25, 2.5, 0],
+    yaw=180,
+    name="Devin",
 )
 car1 = app.modeler.add_vehicle(
-    actor_folder=car_folder, speed=8.7, global_offset=[3, -2.5, 0], actor_name="LuxuryCar"
+    input_dir=car_folder, speed=8.7, global_offset=[3, -2.5, 0], name="LuxuryCar"
 )
 bike1 = app.modeler.add_vehicle(
-    actor_folder=bike_folder,
+    input_dir=bike_folder,
     speed=2.1,
     global_offset=[24, 3.6, 0],
     yaw=180,
-    actor_name="Alberto_in_bike",
+    name="Alberto_in_bike",
 )
 bird1 = app.modeler.add_bird(
-    actor_folder=bird_folder,
+    input_dir=bird_folder,
     speed=1.0,
     global_offset=[19, 4, 3],
     yaw=120,
     pitch=-5,
     flapping_rate=30,
-    actor_name="Pigeon",
+    name="Pigeon",
 )
 bird2 = app.modeler.add_bird(
-    actor_folder=bird_folder,
+    input_dir=bird_folder,
     speed=1.0,
     global_offset=[6, 2, 3],
     yaw=-60,
     pitch=10,
-    actor_name="Eagle",
+    name="Eagle",
 )
 
 # ## Place radar
@@ -124,7 +129,7 @@
 
 radar1 = app.create_sbr_radar_from_json(
     radar_file=radar_lib,
-    radar_name="Example_1Tx_1Rx",
+    name="Example_1Tx_1Rx",
     offset=[2.57, 0, 0.54],
     use_relative_cs=True,
     relative_cs_name=car1.cs_name,
@@ -145,22 +150,29 @@
 # Plot the model.
 
 app.plot(
-    show=False, export_path=os.path.join(app.working_directory, "Image.jpg"), plot_air_objects=True
+    show=False,
+    export_path=os.path.join(app.working_directory, "Image.jpg"),
+    plot_air_objects=True,
 )
 
 # ## Solve and release AEDT
 #
 # Solve and release AEDT. To solve, uncomment the ``app.analyze_setup`` command
 # to activate the simulation.
 
+# +
 # app.analyze_setup(sweep.name)
+# -
 
 # ## Release AEDT
 #
 # Release AEDT and close the example.
 
 app.release_desktop()
 
-# ## Clean temporary directory
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.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()

examples/02-SBR+/SBR_Example.py

@@ -19,13 +19,7 @@
 
 AEDT_VERSION = "2024.1"
 NUM_CORES = 4
-
-# ## Set non-graphical mode
-#
-# Set non-graphical mode.
-# You can set ``non_graphical`` either to ``True`` or ``False``.
-
-non_graphical = False
+NG_MODE = False  # Open Electronics UI when the application is launched.
 
 # ## Create temporary directory
 
@@ -47,7 +41,7 @@
     solution_type="SBR+",
     version=AEDT_VERSION,
     new_desktop=True,
-    non_graphical=non_graphical,
+    non_graphical=NG_MODE,
 )
 
 source = pyaedt.Hfss(
@@ -61,7 +55,9 @@
 #
 # Define a linked antenna. This is HFSS far field applied to HFSS SBR+.
 
-target.create_sbr_linked_antenna(source, target_cs="feederPosition", fieldtype="farfield")
+target.create_sbr_linked_antenna(
+    source, target_cs="feederPosition", fieldtype="farfield"
+)
 
 # ## Assign boundaries
 #
@@ -98,9 +94,9 @@
 setup1["RangeStart"] = "10GHz"
 target.analyze(num_cores=NUM_CORES)
 
-# ## Plot results
+# ## Post-processing
 #
-# Plot results.
+# Plot results in Electronics Desktop.
 
 variations = target.available_variations.nominal_w_values_dict
 variations["Freq"] = ["10GHz"]
@@ -115,8 +111,6 @@
     report_category="Far Fields",
 )
 
-# ## Plot results outside AEDT
-#
 # Plot results using Matplotlib.
 
 solution = target.post.get_solution_data(
@@ -135,6 +129,9 @@
 
 target.release_desktop()
 
-# ## Clean temporary directory
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.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()

examples/02-SBR+/SBR_Time_Plot.py

@@ -18,15 +18,9 @@
 
 AEDT_VERSION = "2024.1"
 NUM_CORES = 4
+NG_MODE = False  # Open Electronics UI when the application is launched.
 
 
-# ## Set non-graphical mode
-#
-# Set non-graphical mode.
-# You can set ``non_graphical`` either to ``True`` or ``False``.
-
-non_graphical = False
-
 # ## Create temporary directory
 
 temp_dir = tempfile.TemporaryDirectory(suffix="_ansys")
@@ -41,7 +35,7 @@
 hfss = Hfss(
     project=project_file,
     version=AEDT_VERSION,
-    non_graphical=non_graphical,
+    non_graphical=NG_MODE,
     new_desktop=True,
 )
 
@@ -93,8 +87,12 @@
 #
 # Release AEDT and close the example.
 
+hfss.save_project()
 hfss.release_desktop()
 
-# ## Clean temporary directory
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.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()