Convert to md format

01-Modeling-setup

Author: Devin-Crawford

Diff for: examples/01-Modeling-Setup/Configurations.py

@@ -1,47 +1,42 @@
-"""
-General: configuration files
-----------------------------
-This example shows how you can use PyAEDT to export configuration files and re-use
-them to import in a new project. A configuration file is supported by these applications:
-
-* HFSS
-* 2D Extractor and Q3D Extractor
-* Maxwell
-* Icepak (in AEDT)
-* Mechanical (in AEDT)
-
-The following sections are covered:
-
-* Variables
-* Mesh operations (except Icepak)
-* Setup and optimetrics
-* Material properties
-* Object properties
-* Boundaries and excitations
-
-When a boundary is attached to a face, the tool tries to match it with a
-``FaceByPosition`` on the same object name on the target design. If, for
-any reason, this face position has changed or the object name in the target
-design has changed, the boundary fails to apply.
-"""
+# # General: configuration files
+#
+# This example shows how you can use PyAEDT to export configuration files and re-use
+# them to import in a new project. A configuration file is supported by these applications:
+#
+# * HFSS
+# * 2D Extractor and Q3D Extractor
+# * Maxwell
+# * Icepak (in AEDT)
+# * Mechanical (in AEDT)
+#
+# The following sections are covered:
+#
+# * Variables
+# * Mesh operations (except Icepak)
+# * Setup and optimetrics
+# * Material properties
+# * Object properties
+# * Boundaries and excitations
+#
+# When a boundary is attached to a face, the tool tries to match it with a
+# ``FaceByPosition`` on the same object name on the target design. If, for
+# any reason, this face position has changed or the object name in the target
+# design has changed, the boundary fails to apply.
 
-###############################################################################
 # Perform required imports
 # ~~~~~~~~~~~~~~~~~~~~~~~~
 # Perform required imports from PyAEDT.
 
 import os
 import pyaedt
 
-###############################################################################
 # Set non-graphical mode
 # ~~~~~~~~~~~~~~~~~~~~~~
 # Set non-graphical mode. 
 # You can set ``non_graphical`` either to ``True`` or ``False``.
 
 non_graphical = False
 
-###############################################################################
 # Open project
 # ~~~~~~~~~~~~
 # Download the project, open it, and save it to the temporary folder.
@@ -52,26 +47,23 @@
                     new_desktop_session=True, non_graphical=non_graphical)
 ipk.autosave_disable()
 
-###############################################################################
-# Create source blocks
-# ~~~~~~~~~~~~~~~~~~~~
+# ## Create source blocks
+#
 # Create a source block on the CPU and memories.
 
 ipk.create_source_block(object_name="CPU", input_power="25W")
 ipk.create_source_block(object_name=["MEMORY1", "MEMORY1_1"], input_power="5W")
 
-###############################################################################
-# Assign boundaries
-# ~~~~~~~~~~~~~~~~~
+# ## Assign boundaries
+#
 # Assign the opening and grille.
 
 region = ipk.modeler["Region"]
 ipk.assign_openings(air_faces=region.bottom_face_x.id)
 ipk.assign_grille(air_faces=region.top_face_x.id, free_area_ratio=0.8)
 
-###############################################################################
-# Create setup
-# ~~~~~~~~~~~~
+# ## Create setup
+#
 # Create the setup. Properties can be set up from the ``setup`` object
 # with getters and setters. They don't have to perfectly match the property
 # syntax.
@@ -83,9 +75,8 @@
 setup1["Solver Type Temperature"] = "flex"
 ipk.save_project(r"C:\temp\Graphic_card.aedt")
 
-###############################################################################
-# Export project to step file
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Export project to step file
+#
 # Export the current project to the step file.
 
 filename = ipk.design_name
@@ -94,34 +85,31 @@
                     removed_objects=[])
 
 ###############################################################################
-# Export configuration files
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Export configuration files
+#
 # Export the configuration files. You can optionally disable the export and
 # import sections.
 
 conf_file = ipk.configurations.export_config()
 ipk.close_project()
 
-###############################################################################
-# Create project
-# ~~~~~~~~~~~~~~
+# ## Create project
+#
 # Create an Icepak project and import the step.
 
 app = pyaedt.Icepak(projectname="new_proj_Ipk")
 app.modeler.import_3d_cad(file_path)
 
-###############################################################################
-# Import and apply configuration file
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Import and apply configuration file
+#
 # Import and apply the configuration file. You can apply all or part of the
 # JSON file that you import using options in the ``configurations`` object.
 
 out = app.configurations.import_config(conf_file)
 app.configurations.results.global_import_success
 
-###############################################################################
-# Close project
-# ~~~~~~~~~~~~~
+# ## Close project
+#
 # Close the project.
 
 app.release_desktop()