AEDT Modules

This section lists the core PyAEDT application modules:

  • Design

  • Variable

  • DesignXPloration

Variable

This module provides all functionalities for creating and editing design and project variables in the 3D tools.

from pyaedt import Hfss
app = Hfss(specified_version="2021.1",
             non_graphical=False, new_desktop_session=True,
             close_on_exit=True, student_version=False)

# this call return the VariableManager Class
variable_manager = self.aedtapp._variable_manager

# Set and Get a variable
app["w"] = "10mm"
a = app["w"]
...

CSVDataset

Reads in a CSV file and extracts data, which can be augmented with constant values.

VariableManager

Manages design properties and project variables.

Variable

Stores design properties and project variables and provides operations to perform on them.

DataSet

Manages datasets.

DesignXploration

This module contains all properties and methods needed to create optimetrics setups.

from pyaedt import Hfss
app = Hfss(specified_version="2021.1",
             non_graphical=False, new_desktop_session=True,
             close_on_exit=True, student_version=False)

# returns the ParametericsSetups Class
app.opti_parametric

# returns the OptimizationSetups Class
app.opti_optimization

# returns the DOESetups Class
app.opti_doe

# returns the DXSetups Class
app.opti_designxplorer

# returns the SensitivitySetups Class
app.opti_sensitivity

# returns the StatisticalSetups Class
app.opti_statistical

# adds an optimization and returns Setup class with all settings and methods
sweep3 = hfss.opti_optimization.add_optimization(calculation="dB(S(1,1))", calculation_value="2.5GHz")

...

DXSetups

Sets up DesignXplorer optimizations.

ParametericsSetups

Sets up parametric analyses.

SensitivitySetups

Sets up sensitivity analyses.

StatisticalSetups

Sets up statistical analyses.

DOESetups

Sets up DOEs (Designs of Experiments).

OptimizationSetups

Sets up optimizations.

Design Cache

This module contains all properties and methods applicable to projects and designs.

DesignCache

Analyzes the differences in the state of a design between two points in time.