ansys-aedt-toolkits-antenna 0.8.0
Toolkit to design antennas with Ansys AEDT.
Requires Python: >=3.10

Antenna Toolkit
===============

|pyansys| |PythonVersion| |GH-CI| |MIT| |coverage| |black|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
   :target: https://docs.pyansys.com/
   :alt: PyAnsys

.. |PythonVersion| image:: https://img.shields.io/badge/python-3.10+-blue.svg
   :target: https://www.python.org/downloads/

.. |GH-CI| image:: https://github.com/ansys/pyaedt-toolkits-antenna/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/pyaedt-toolkits-antenna/actions/workflows/ci_cd.yml

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT

.. |coverage| image:: https://codecov.io/gh/ansys/pyaedt-toolkits-antenna/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/ansys/pyaedt-toolkits-antenna

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
  :target: https://github.com/psf/black
  :alt: black

.. reuse_start

The Antenna Toolkit is a Python interface for accelerating antenna design
using `Ansys Electronics Desktop <https://www.ansys.com/products/electronics>`_
(AEDT). You can launch this toolkit from the AEDT UI or launch it directly
from a Python console. This toolkit can also be launched as desktop application
based on `Pyside6 <https://doc.qt.io/qtforpython-6/quickstart.html>`_.

Requirements
~~~~~~~~~~~~
In addition to the runtime dependencies listed in the `Getting started <https://aedt.antenna.toolkit.docs.pyansys.com/version/stable/getting-started.html>`_,
the Antenna Toolkit requires AEDT 2025 R1 or later.

Documentation and issues
~~~~~~~~~~~~~~~~~~~~~~~~
Documentation for the latest stable release of the Antenna Toolkit is hosted at
`Antenna Toolkit documentation <https://aedt.antenna.toolkit.docs.pyansys.com/version/stable/index.html>`_.

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 `Antenna Toolkit Issues <https://github.com/ansys/pyaedt-toolkits-antenna/issues>`_
page, you can create issues to report bugs and request new features. On the `Discussions <https://discuss.ansys.com/>`_
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

Distributing
~~~~~~~~~~~~
This project is vectored to be an open-source project. For the time being, feel
free to distribute it internally, but direct users to visit the `Releases
<https://github.com/ansys/pyaedt-toolkits-antenna/releases>`__ page

Security
~~~~~~~~
The versions that are still supported for security updates can be found at
the `Security guidelines <https://github.com/ansys/pyaedt-toolkits-antenna/blob/main/SECURITY.md>`_
site. Information on how to report vulnerabilities is also found.

License
~~~~~~~
The Antenna Toolkit is licensed under the `MIT license <https://opensource.org/license/mit/>`_.

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 <https://www.ansys.com/products/electronics>`_ 
page on the Ansys website.