Toolkit API

The Toolkit API contains the ToolkitBackend class, which provides methods for controlling the toolkit workflow. In addition to methods for creating an AEDT session or connecting to an existing AEDT session, this API provides methods for automating the segmentation and skew of a 3D motor.

Warning

Both segmentation and skew of a 3D motor have requirements on the AEDT active project. Ensure that the active design meets these requirements:

• For segmentation, SymmetryFactor and HalfAxial design settings must be defined.

• For skew, Shaft must be the name of the shaft.

ToolkitBackend()

Provides methods for controlling the toolkit workflow.

This code shows how to use the ToolkitBackend class:

# Import required modules and backend
from ansys.aedt.toolkits.magnet_segmentation.backend.api import ToolkitBackend

# Initialize generic service
toolkit = ToolkitBackend()

# Get the default properties loaded from JSON file
properties = toolkit.get_properties()

# Set properties
aedt_file = os.path.join(common_temp_dir, "input_data", f"{PROJECT_NAME}.aedt")
new_properties = {
    "aedt_version": "2024.1",
    "non_graphical": True,
    "active_project": aedt_file,
    "active_design": DESIGN_NAME,
    "design_list": {PROJECT_NAME: [DESIGN_NAME]},
    "use_grpc": config["use_grpc"],
}
toolkit.set_properties(new_properties)

# Launch AEDT and open project
msg = toolkit.launch_aedt()
toolkit.open_project(aedt_file)
toolkit.connect_design("Maxwell3D")

# Segment and skew motor
toolkit.segmentation()
toolkit.apply_skew()

# Release AEDT
toolkit.release_aedt()