ansys-aedt-toolkits-common

User interface example repository to create your toolkit.


Keywords
ansys, pyaedt, python, toolkit
License
MIT
Install
pip install ansys-aedt-toolkits-common==0.4.3

Documentation

PyAEDT Common Toolkit

PyAnsys PythonVersion GH-CI MIT coverage black

The PyAEDT Common Toolkit provides common methods for creating an Ansys Electronics Desktop (AEDT) toolkit.

A common toolkit library can bring numerous advantages in the creation and development of toolkits, including enhancing efficiency, consistency, and collaboration.

The PyAEDT Common Toolkit has two main parts: a backend and a User Interface (UI).

  • The backend has some common methods for controlling an AEDT session and also a REST API based on Flask.
  • The UI consists of some common methods for creating a desktop app based on Pyside6.

Requirements

In addition to the runtime dependencies listed in Installation, the PyAEDT Common Toolkit requires AEDT 2023 R2 or later. This toolkit also supports the AEDT Student Version for 2023 R2 or later.

Documentation and issues

Documentation for the latest stable release is hosted at PyAEDT Common Toolkit documentation.

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

On the PyAEDT Common Toolkit Issues page, you can create issues to report bugs and request new features. On the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

License

The PyAEDT Common Toolkit is licensed under the MIT license.

This toolkit makes no commercial claim over Ansys whatsoever. The use of this toolkit requires a legally licensed copy of AEDT. For more information, see the Ansys Electronics page on the Ansys website.