:orphan: .. _ref_example_gallery: Examples ======== End-to-end examples show how you can use PyAEDT. If PyAEDT is installed on your machine, you can download these examples as Python files or Jupyter notebooks and run them locally. .. note:: Some examples require additional Python packages. .. raw:: html
.. raw:: html
EDB examples ~~~~~~~~~~~~ EDB is a powerful API for efficiently controlling PCB data. You can either use EDB standalone or embedded in HFSS 3D Layout in AEDT. The ``EDB`` class in now part of the PyEDB package, which is currently installed with PyAEDT and backward-compatible with PyAEDT. All EDB related examples have been moved to the `Examples page `_ in the PyEDB documentation. These examples use EDB (Electronics Database) with PyAEDT. .. code:: python # Launch the latest installed version of AEDB. import pyaedt edb = pyaedt.Edb("mylayout.aedb") # You can also launch EDB directly from PyEDB. import pyedb edb = pyedb.Edb("mylayout.aedb") .. raw:: html
.. raw:: html
HFSS 3D Layout examples ~~~~~~~~~~~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for HFSS 3D Layout. It includes model generation, setup, meshing, and post-processing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/01-HFSS3DLayout/images/thumb/sphx_glr_Dcir_in_3DLayout_thumb.png :alt: :ref:`sphx_glr_examples_01-HFSS3DLayout_Dcir_in_3DLayout.py` .. raw:: html
HFSS 3D Layout: SIwave DCIR analysis in HFSS 3D Layout
.. raw:: html
.. only:: html .. image:: /examples/01-HFSS3DLayout/images/thumb/sphx_glr_EDB_in_3DLayout_thumb.png :alt: :ref:`sphx_glr_examples_01-HFSS3DLayout_EDB_in_3DLayout.py` .. raw:: html
HFSS 3D Layout: PCB and EDB in 3D layout
.. raw:: html
.. only:: html .. image:: /examples/01-HFSS3DLayout/images/thumb/sphx_glr_HFSS3DLayout_Via_thumb.png :alt: :ref:`sphx_glr_examples_01-HFSS3DLayout_HFSS3DLayout_Via.py` .. raw:: html
HFSS 3D Layout: parametric via analysis
.. raw:: html
.. only:: html .. image:: /examples/01-HFSS3DLayout/images/thumb/sphx_glr_Hfss3DComponent_thumb.png :alt: :ref:`sphx_glr_examples_01-HFSS3DLayout_Hfss3DComponent.py` .. raw:: html
HFSS: 3D Components
.. raw:: html
General model and setup examples ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These examples use PyAEDT to show some general model and simulation setup features inside AEDT. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/01-Modeling-Setup/images/thumb/sphx_glr_Configurations_thumb.png :alt: :ref:`sphx_glr_examples_01-Modeling-Setup_Configurations.py` .. raw:: html
General: configuration files
.. raw:: html
.. only:: html .. image:: /examples/01-Modeling-Setup/images/thumb/sphx_glr_HFSS_CoordinateSystem_thumb.png :alt: :ref:`sphx_glr_examples_01-Modeling-Setup_HFSS_CoordinateSystem.py` .. raw:: html
General: coordinate system creation
.. raw:: html
.. only:: html .. image:: /examples/01-Modeling-Setup/images/thumb/sphx_glr_Optimetrics_thumb.png :alt: :ref:`sphx_glr_examples_01-Modeling-Setup_Optimetrics.py` .. raw:: html
General: optimetrics setup
.. raw:: html
.. only:: html .. image:: /examples/01-Modeling-Setup/images/thumb/sphx_glr_Polyline_Primitives_thumb.png :alt: :ref:`sphx_glr_examples_01-Modeling-Setup_Polyline_Primitives.py` .. raw:: html
General: polyline creation
.. raw:: html
HFSS examples ~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for HFSS 3D. This includes model generation, setup, meshing, and postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_Array_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_Array.py` .. raw:: html
HFSS: component antenna array
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_Create_3d_Component_and_use_it_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_Create_3d_Component_and_use_it.py` .. raw:: html
Create a 3D Component and reuse it
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_Flex_CPWG_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_Flex_CPWG.py` .. raw:: html
HFSS: flex cable CPWG
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_HFSS_Choke_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_HFSS_Choke.py` .. raw:: html
HFSS: choke
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_HFSS_Dipole_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_HFSS_Dipole.py` .. raw:: html
HFSS: dipole antenna
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_HFSS_FSS_unitcell_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_HFSS_FSS_unitcell.py` .. raw:: html
HFSS: FSS Unitcell Simulation
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_HFSS_Spiral_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_HFSS_Spiral.py` .. raw:: html
HFSS: spiral inductor
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_HFSS_eigenmode_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_HFSS_eigenmode.py` .. raw:: html
HFSS: Eigenmode filter
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_Probe_Fed_Patch_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_Probe_Fed_Patch.py` .. raw:: html
HFSS: Probe-fed patch antenna
.. raw:: html
.. only:: html .. image:: /examples/02-HFSS/images/thumb/sphx_glr_Waveguide_Filter_thumb.png :alt: :ref:`sphx_glr_examples_02-HFSS_Waveguide_Filter.py` .. raw:: html
HFSS: Inductive Iris waveguide filter
.. raw:: html
SBR+ examples ~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for HFSS SBR+. This includes model generation, setup, meshing, and postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/02-SBR+/images/thumb/sphx_glr_SBR_City_Import_thumb.png :alt: :ref:`sphx_glr_examples_02-SBR+_SBR_City_Import.py` .. raw:: html
SBR+: Import Geometry from Maps
.. raw:: html
.. only:: html .. image:: /examples/02-SBR+/images/thumb/sphx_glr_SBR_Doppler_Example_thumb.png :alt: :ref:`sphx_glr_examples_02-SBR+_SBR_Doppler_Example.py` .. raw:: html
SBR+: doppler setup
.. raw:: html
.. only:: html .. image:: /examples/02-SBR+/images/thumb/sphx_glr_SBR_Example_thumb.png :alt: :ref:`sphx_glr_examples_02-SBR+_SBR_Example.py` .. raw:: html
SBR+: HFSS to SBR+ coupling
.. raw:: html
.. only:: html .. image:: /examples/02-SBR+/images/thumb/sphx_glr_SBR_Time_Plot_thumb.gif :alt: :ref:`sphx_glr_examples_02-SBR+_SBR_Time_Plot.py` .. raw:: html
SBR+: HFSS to SBR+ time animation
.. raw:: html
Maxwell examples ~~~~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for Maxwell 2D and Maxwell 3D. This includes model generation, setup, meshing, and postprocessing. Examples cover different Maxwell solution types (Eddy Current, Magnetostatic, and Transient). .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell2D_DCConduction_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell2D_DCConduction.py` .. raw:: html
Maxwell 2D: resistance calculation
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell2D_Electrostatic_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell2D_Electrostatic.py` .. raw:: html
Maxwell 2D Electrostatic analysis
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell2D_PMSynchronousMotor_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell2D_PMSynchronousMotor.py` .. raw:: html
Maxwell 2D: PM synchronous motor transient analysis
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell2D_Transient_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell2D_Transient.py` .. raw:: html
Maxwell 2D: transient winding analysis
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell3DTeam7_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell3DTeam7.py` .. raw:: html
Maxwell 3D: asymmetric conductor analysis
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell3D_Choke_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell3D_Choke.py` .. raw:: html
Maxwell 3D: choke setup
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell3D_Segmentation_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell3D_Segmentation.py` .. raw:: html
Maxwell 3D: magnet segmentation
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell3D_Team3_bath_plate_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell3D_Team3_bath_plate.py` .. raw:: html
Maxwell 3D: bath plate analysis
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell_Control_Program_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell_Control_Program.py` .. raw:: html
Enabling Control Program in a Maxwell 2D Project
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell_Magnet_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell_Magnet.py` .. raw:: html
Maxwell 3D: magnet DC analysis
.. raw:: html
.. only:: html .. image:: /examples/03-Maxwell/images/thumb/sphx_glr_Maxwell_Transformer_Coreloss_thumb.png :alt: :ref:`sphx_glr_examples_03-Maxwell_Maxwell_Transformer_Coreloss.py` .. raw:: html
Maxwell 3D: Transformer
.. raw:: html
Icepak examples ~~~~~~~~~~~~~~~ These examples use PyAEDT to show end-to-end workflows for Icepak. This includes schematic generation, setup, and thermal postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/04-Icepak/images/thumb/sphx_glr_Icepak_3DComponents_Example_thumb.png :alt: :ref:`sphx_glr_examples_04-Icepak_Icepak_3DComponents_Example.py` .. raw:: html
Icepak: thermal analysis with 3D components
.. raw:: html
.. only:: html .. image:: /examples/04-Icepak/images/thumb/sphx_glr_Icepak_CSV_Import_thumb.png :alt: :ref:`sphx_glr_examples_04-Icepak_Icepak_CSV_Import.py` .. raw:: html
Icepak: Creating blocks and assigning materials and power
.. raw:: html
.. only:: html .. image:: /examples/04-Icepak/images/thumb/sphx_glr_Icepak_ECAD_Import_thumb.png :alt: :ref:`sphx_glr_examples_04-Icepak_Icepak_ECAD_Import.py` .. raw:: html
Icepak: Importing a PCB and its components via IDF and EDB
.. raw:: html
.. only:: html .. image:: /examples/04-Icepak/images/thumb/sphx_glr_Icepak_Example_thumb.png :alt: :ref:`sphx_glr_examples_04-Icepak_Icepak_Example.py` .. raw:: html
Icepak: graphic card thermal analysis
.. raw:: html
.. only:: html .. image:: /examples/04-Icepak/images/thumb/sphx_glr_Sherlock_Example_thumb.png :alt: :ref:`sphx_glr_examples_04-Icepak_Sherlock_Example.py` .. raw:: html
Icepak: setup from Sherlock inputs
.. raw:: html
2D Extractor and Q3D Extractor examples ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for 2D Extractor and Q3D Extractor. This includes model generation, setup, and thermal postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/05-Q3D/images/thumb/sphx_glr_Q2D_Armoured_Cable_thumb.png :alt: :ref:`sphx_glr_examples_05-Q3D_Q2D_Armoured_Cable.py` .. raw:: html
Q2D: Cable parameter identification
.. raw:: html
.. only:: html .. image:: /examples/05-Q3D/images/thumb/sphx_glr_Q2D_Example_CPWG_thumb.png :alt: :ref:`sphx_glr_examples_05-Q3D_Q2D_Example_CPWG.py` .. raw:: html
2D Extractor: CPWG analysis
.. raw:: html
.. only:: html .. image:: /examples/05-Q3D/images/thumb/sphx_glr_Q2D_Example_Stripline_thumb.png :alt: :ref:`sphx_glr_examples_05-Q3D_Q2D_Example_Stripline.py` .. raw:: html
2D Extractor: stripline analysis
.. raw:: html
.. only:: html .. image:: /examples/05-Q3D/images/thumb/sphx_glr_Q3D_DC_IR_thumb.png :alt: :ref:`sphx_glr_examples_05-Q3D_Q3D_DC_IR.py` .. raw:: html
Q3D Extractor: PCB DCIR analysis
.. raw:: html
.. only:: html .. image:: /examples/05-Q3D/images/thumb/sphx_glr_Q3D_Example_thumb.png :alt: :ref:`sphx_glr_examples_05-Q3D_Q3D_Example.py` .. raw:: html
Q3D Extractor: busbar analysis
.. raw:: html
.. only:: html .. image:: /examples/05-Q3D/images/thumb/sphx_glr_Q3D_from_EDB_thumb.png :alt: :ref:`sphx_glr_examples_05-Q3D_Q3D_from_EDB.py` .. raw:: html
Q3D Extractor: PCB analysis
.. raw:: html
Multiphysics examples ~~~~~~~~~~~~~~~~~~~~~ These examples use PyAEDT to create some multiphysics workflows. They might use an electromagnetic tool like HFSS or Maxwell and a thermal or structural tool like Icepak or Mechanical. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/06-Multiphysics/images/thumb/sphx_glr_Hfss_Icepak_Coupling_thumb.png :alt: :ref:`sphx_glr_examples_06-Multiphysics_Hfss_Icepak_Coupling.py` .. raw:: html
Multiphysics: HFSS-Icepak multiphysics analysis
.. raw:: html
.. only:: html .. image:: /examples/06-Multiphysics/images/thumb/sphx_glr_Hfss_Mechanical_thumb.png :alt: :ref:`sphx_glr_examples_06-Multiphysics_Hfss_Mechanical.py` .. raw:: html
Multiphysics: HFSS-Mechanical multiphysics analysis
.. raw:: html
.. only:: html .. image:: /examples/06-Multiphysics/images/thumb/sphx_glr_MRI_thumb.png :alt: :ref:`sphx_glr_examples_06-Multiphysics_MRI.py` .. raw:: html
Multiphysics: HFSS-Mechanical MRI analysis
.. raw:: html
.. only:: html .. image:: /examples/06-Multiphysics/images/thumb/sphx_glr_Maxwell3D_Icepak_2Way_Coupling_thumb.png :alt: :ref:`sphx_glr_examples_06-Multiphysics_Maxwell3D_Icepak_2Way_Coupling.py` .. raw:: html
Multiphysics: Maxwell 3D - Icepak electrothermal analysis
.. raw:: html
Circuit examples ~~~~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for Circuit. This includes schematic generation, setup, and postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Circuit_AMI_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Circuit_AMI.py` .. raw:: html
Circuit: AMI PostProcessing
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Circuit_Example_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Circuit_Example.py` .. raw:: html
Circuit: schematic creation and analysis
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Circuit_Siwave_Multizones_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Circuit_Siwave_Multizones.py` .. raw:: html
Circuit: Simulate multi-zones layout with Siwave
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Circuit_Subcircuit_Example_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Circuit_Subcircuit_Example.py` .. raw:: html
Circuit: schematic subcircuit management
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Circuit_Transient_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Circuit_Transient.py` .. raw:: html
Circuit: transient analysis and eye plot
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Create_Netlist_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Create_Netlist.py` .. raw:: html
Circuit: netlist to schematic import
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Reports_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Reports.py` .. raw:: html
Circuit: automatic report creation
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Touchstone_Management_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Touchstone_Management.py` .. raw:: html
Circuit: Touchstone file management
.. raw:: html
.. only:: html .. image:: /examples/07-Circuit/images/thumb/sphx_glr_Virtual_Compliance_thumb.png :alt: :ref:`sphx_glr_examples_07-Circuit_Virtual_Compliance.py` .. raw:: html
Circuit: PCIE virtual compliance
.. raw:: html
EMIT examples ~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for EMIT. This includes schematic generation, setup, and postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/07-EMIT/images/thumb/sphx_glr_ComputeInterferenceType_thumb.png :alt: :ref:`sphx_glr_examples_07-EMIT_ComputeInterferenceType.py` .. raw:: html
EMIT: Classify interference type
.. raw:: html
.. only:: html .. image:: /examples/07-EMIT/images/thumb/sphx_glr_ComputeProtectionLevels_thumb.png :alt: :ref:`sphx_glr_examples_07-EMIT_ComputeProtectionLevels.py` .. raw:: html
EMIT: Compute receiver protection levels
.. raw:: html
.. only:: html .. image:: /examples/07-EMIT/images/thumb/sphx_glr_EMIT_Example_thumb.png :alt: :ref:`sphx_glr_examples_07-EMIT_EMIT_Example.py` .. raw:: html
EMIT: antenna
.. raw:: html
.. only:: html .. image:: /examples/07-EMIT/images/thumb/sphx_glr_EMIT_HFSS_Example_thumb.png :alt: :ref:`sphx_glr_examples_07-EMIT_EMIT_HFSS_Example.py` .. raw:: html
EMIT: HFSS to EMIT coupling
.. raw:: html
.. only:: html .. image:: /examples/07-EMIT/images/thumb/sphx_glr_interference_gui_thumb.png :alt: :ref:`sphx_glr_examples_07-EMIT_interference_gui.py` .. raw:: html
EMIT: Classify interference type GUI
.. raw:: html
Twin Builder examples ~~~~~~~~~~~~~~~~~~~~~ These examples use PyAEDT to show some end-to-end workflows for Twin Builder. This includes schematic generation, setup, and postprocessing. .. raw:: html
.. raw:: html
.. only:: html .. image:: /examples/07-TwinBuilder/images/thumb/sphx_glr_01-RC_Circuit_Example_thumb.png :alt: :ref:`sphx_glr_examples_07-TwinBuilder_01-RC_Circuit_Example.py` .. raw:: html
Twin Builder: RC circuit design anaysis
.. raw:: html
.. only:: html .. image:: /examples/07-TwinBuilder/images/thumb/sphx_glr_02-Wiring_A_Rectifier_thumb.png :alt: :ref:`sphx_glr_examples_07-TwinBuilder_02-Wiring_A_Rectifier.py` .. raw:: html
Twin Builder: wiring a rectifier with a capacitor filter
.. raw:: html
.. only:: html .. image:: /examples/07-TwinBuilder/images/thumb/sphx_glr_03-Dynamic_ROM_Creation_And_Visualization_thumb.png :alt: :ref:`sphx_glr_examples_07-TwinBuilder_03-Dynamic_ROM_Creation_And_Visualization.py` .. raw:: html
Twin Builder: dynamic ROM creation and simulation (2023 R2 beta)
.. raw:: html
.. only:: html .. image:: /examples/07-TwinBuilder/images/thumb/sphx_glr_04-Static_ROM_Creation_And_Visualization_thumb.png :alt: :ref:`sphx_glr_examples_07-TwinBuilder_04-Static_ROM_Creation_And_Visualization.py` .. raw:: html
Twin Builder: static ROM creation and simulation (2023 R2 beta)
.. raw:: html
.. toctree:: :hidden: :includehidden: /examples/00-EDB/index.rst /examples/01-HFSS3DLayout/index.rst /examples/01-Modeling-Setup/index.rst /examples/02-HFSS/index.rst /examples/02-SBR+/index.rst /examples/03-Maxwell/index.rst /examples/04-Icepak/index.rst /examples/05-Q3D/index.rst /examples/06-Multiphysics/index.rst /examples/07-Circuit/index.rst /examples/07-EMIT/index.rst /examples/07-TwinBuilder/index.rst .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_