Metadata-Version: 2.4
Name: ansys-pyetk
Version: 0.4.0
Summary: Advanced PyAEDT toolkit to set up electronic transformers in Ansys Electronic Desktop (AEDT).
Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-Expression: Apache-2.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Scientific/Engineering
License-File: LICENSE
Requires-Dist: ansys-aedt-toolkits-common[all]
Requires-Dist: ansys-aedt-toolkits-common[doc] ; extra == "doc"
Requires-Dist: pyinstaller ; extra == "freeze"
Requires-Dist: ansys-aedt-toolkits-common[tests] ; extra == "tests"
Project-URL: Changelog, https://github.com/ansys/ansys-pyetk/blob/main/doc/source/changelog.rst
Project-URL: Discussions, https://github.com/ansys/ansys-pyetk/discussions
Project-URL: Documentation, https://ansys-pyetk.docs.pyansys.com/version/stable/
Project-URL: Issues, https://github.com/ansys/ansys-pyetk/issues
Project-URL: Releases, https://github.com/ansys/ansys-pyetk/releases
Project-URL: Source, https://github.com/ansys/ansys-pyetk.git
Provides-Extra: doc
Provides-Extra: freeze
Provides-Extra: tests

Electronic Transformer ToolKit (PyETK)
======================================

|pyansys| |PythonVersion| |GH-CI| |Apache| |coverage| |ruff|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?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/ansys-pyetk/actions/workflows/ci-main.yml/badge.svg
   :target: https://github.com/ansys/ansys-pyetk/actions/workflows/ci_cd.yml

.. |Apache| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
   :target: https://opensource.org/licenses/Apache-2.0

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

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :target: https://github.com/astral-sh/ruff
   :alt: Ruff


PyETK provides a user-friendly interface to set up electronic transformer
models in Ansys Electronic Desktop (AEDT). You can use this toolkit inside AEDT or launch it
from a Python console. PyETK leverages the common toolkit library that consists of two
main parts: a backend and a User Interface (UI).

- The backend has some common methods for controlling an AEDT session and also an
  API based on `Flask <https://flask.palletsprojects.com/en/2.3.x/>`_.

- The UI consists of some common methods for creating a desktop app based on
  `Pyside6 <https://doc.qt.io/qtforpython-6/quickstart.html>`_.


Requirements
~~~~~~~~~~~~
In addition to the runtime dependencies listed in the installation information, PyETK
requires AEDT 2025 R2 or later.


Documentation and issues
~~~~~~~~~~~~~~~~~~~~~~~~
Documentation for the latest stable release of PyETK is hosted at
`PyETK documentation <https://etk.docs.pyansys.com/>`_.

On the repository's `Issues <https://github.com/ansys/ansys-pyetk/issues>`_ page, you can
create issues to submit questions, report bugs, and request new features.

Installation
~~~~~~~~~~~~
To install PyETK, go to the repository's `Releases <https://github.com/ansys/ansys-pyetk/releases>`__ page
and download the latest installer for your operating system.

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 repository's
`Releases <https://github.com/ansys/ansys-pyetk/releases>`__ page.

Security
~~~~~~~~
Information on how to report vulnerabilities can be found in the
`Security Policy <https://github.com/ansys/ansys-pyetk/blob/main/SECURITY.md>`__.

License
~~~~~~~
This toolkit is licensed under the Apache-2.0 license.

This module makes no commercial claim over Ansys whatsoever. The use of the interactive control
of this toolkit requires a legally licensed local copy of AEDT. For more information about AEDT,
visit the `AEDT page <https://www.ansys.com/products/electronics>`_ on the Ansys website.

