PyAEDT: Introduction to the Ansys Electronics Desktop API

In this article, I will introduce you to PyAEDT, the Python library designed to enhance your experience with the Ansys Electronics Desktop, or AEDT. PyAEDT simplifies scripting by interacting directly with the AEDT API, allowing for seamless integration across Ansys’s comprehensive suite of electromagnetic, thermal, and mechanical solvers. By harnessing the power of PyAEDT, you can take your analysis to the next level, such as by extracting field information directly from mesh nodes or creating custom core loss models, opening up new dimensions in simulation accuracy and customization.

Be sure to check out the accompanying YouTube video for this blog, which delves deeper into this topic. The video guides you through downloading and installing PyAEDT, running it in a Jupyter notebook, and explores several additional details:

Understanding PyAEDT and Python Environments in Ansys Electronics Desktop

• PyANSYS and PyAEDT: PyANSYS is a comprehensive Python library that enables scripting and automation across various Ansys applications. PyAEDT is a specialized subset focused on Ansys Electronics Desktop, designed to streamline tasks in electromagnetic, thermal, and mechanical analysis through direct API interactions.

• IronPython in AEDT: IronPython is a Python implementation that integrates with the .NET framework, allowing scripts to interact directly with AEDT. It's ideal for running scripts within the AEDT environment, providing seamless access to Ansys features, though it may not support some external Python libraries due to its .NET alignment.

• CPython with AEDT: CPython is the standard Python interpreter known for its extensive support of scientific and engineering libraries. For AEDT, CPython is typically used for external scripting, enabling complex data processing and visualization tasks with libraries like numpy, scipy, and matplotlib.

• Choosing the Right Environment: The choice between IronPython and CPython depends on the specific requirements of your project. IronPython offers direct integration within AEDT, making it suitable for straightforward scripting tasks. In contrast, CPython is preferable for tasks requiring intensive data analysis or the use of extensive Python libraries outside the .NET framework.

Activating a Control Program in Maxwell Transient Solutions

Control programs in Maxwell are powerful scripts or executables that can dramatically extend the functionality of your simulations by interacting directly with each timestep of the solver. Whether you're working with Maxwell 2D or 3D, these programs can modify source inputs, adjust circuit elements, control mechanical quantities, and even redefine stopping criteria based on real-time solution updates. This capability is particularly useful for applications like custom core loss calculations where you need precise control over the simulation process.

Here’s how you can specify and use a control program in your Maxwell transient solver setup:

1. Enable the Control Program: In the Solve Setup dialog box, check the Use Control Program box to activate the field where you can enter the name of your control program.

2. Select Your Program: Click the ... button to open a file selection dialog. Navigate to the location of your control program, which can be a Python script (.py) or an executable file (.exe), and select it.

3. Configure Program Arguments: In the Arguments text box within the Solve Setup dialog, enter any arguments your control program requires. Maxwell calls your control program with these arguments formatted as program_name specified_arguments. For Python scripts, arguments can include the --post flag if the script should execute post-processing after the last timestep.

4. Post-Processing Option: If your simulation requires running the control program after the final timestep for post-processing (such as for final state analysis or additional calculations), select the Call after last timestep for post processing checkbox. For Python scripts, use --post as the flag, and for compiled programs, use -post.

5. Apply Settings: Click OK to apply these settings and return to the main Solve Setup window

Integrating a Control Program in Maxwell 2D with PyAEDT

Introducing automation into Maxwell 2D projects through control programs can significantly enhance the efficiency and precision of your electromagnetic simulations. Using PyAEDT, a Python library tailored for Ansys Electronics Desktop, you can automate various aspects of your simulation process from geometry creation to post-processing. This example will guide you through setting up a control program in Maxwell 2D, leveraging PyAEDT's robust capabilities.

1. Import Necessary Modules: Begin by importing the required Python modules from PyAEDT which facilitate file handling, unique folder generation, and interaction with Maxwell 2D:

from pyaedt import downloads
from pyaedt import generate_unique_folder_name
from pyaedt import Maxwell2d

2. Configure AEDT Version and Mode: Specify the version of AEDT you're working with and whether to run it in graphical or non-graphical mode, depending on your computational preferences or system capabilities

aedt_version = "2024.1"
non_graphical = False   

temp_folder = generate_unique_folder_name()
aedt_file = downloads.download_file("maxwell_ctrl_prg", "ControlProgramDemo.aedt", temp_folder)
ctrl_prg_file = downloads.download_file("maxwell_ctrl_prg", "timestep_only.py", temp_folder) 

m2d = Maxwell2d(projectname=aedt_file,
                specified_version=aedt_version,
                new_desktop_session=True,
                non_graphical=non_graphical)

m2d.set_active_design("1 time step control")

setup.enable_control_program(control_program_path=ctrl_prg_file)

setup.analyze()    

sols = m2d.post.get_solution_data("FluxLinkage(Winding1)", variations={"Time": ["All"]}, primary_sweep_variable="Time")
sols.plot()  

m2d.save_project()
m2d.release_desktop()