diff --git a/doc/source/Getting_started/Installation.rst b/doc/source/Getting_started/Installation.rst index 0c81d8ebd83..4c09d638cfa 100644 --- a/doc/source/Getting_started/Installation.rst +++ b/doc/source/Getting_started/Installation.rst @@ -12,45 +12,59 @@ In addition to the runtime dependencies listed in the installation information, requires Ansys Electronics Desktop (AEDT) 2022 R1 or later. The AEDT Student Version is also supported. +Install from PyAEDT installer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The following python script automatically installs PyAEDT from AEDT, +using the CPython interpreter included in the AEDT installation. -Install from a Python file -~~~~~~~~~~~~~~~~~~~~~~~~~~ -AEDT already includes CPython 3.7, which can be used to run PyAEDT. -It is also possible to use CPython 3.7 (3.10 from AEDT 2023R2) as a virtual environment to run PyAEDT. -In order to do that you can download the following file -:download:`PyAEDT Installer Python file <../Resources/PyAEDTInstallerFromDesktop.py>` -Open an Electronics Desktop Session and click on Tools->Run Script and execute the file. -Offline install is also possible using wheelhouses. -A wheelhouse is a zip containing all needed packages that can be installed offline. -PyAEDT wheelhouse can be found at `Releases `_. -After downloading the wheelhouse zip specific for your distribution and Python release, -run the script from Electronics Desktop using the zip full path as argument. -Please note that AEDT 2023 R1 and lower requires Python 3.7 wheelhouse while AEDT 2023 R2 -and higher requires the Python 3.10 wheelhouse. - -After installation a new menu appears in AEDT Menu as in the image below. - -.. image:: ../Resources/toolkits.png - :width: 800 - :alt: PyAEDT toolkit installed after batch run +In order to do that you can: + +- Download the following file: :download:`PyAEDT Installer Python file <../Resources/PyAEDTInstallerFromDesktop.py>` + +- Open an Electronics Desktop Session and click on Tools->Run Script and execute the file. +- Offline install is also possible using wheelhouses. + +.. note:: + A wheelhouse is a zip containing all needed packages that can be installed offline. + PyAEDT wheelhouse can be found at `Releases `_. + After downloading the wheelhouse zip specific for your distribution and Python release, + run the script from Electronics Desktop using the zip full path as argument. + Please note that AEDT 2023 R1 and lower requires Python 3.7 wheelhouse while AEDT 2023 R2 + and higher requires the Python 3.10 wheelhouse. + +.. image:: ../Resources/wheelhouse_installation.png + :width: 800 + :alt: PyAEDT run script -Starting from 2023R2, a Ribbon button is available in Automation Tab as in the example below. +Starting from 2023R2, buttons are available in the Automation Tab as in the example below. .. image:: ../Resources/toolkits_ribbon.png :width: 800 - :alt: PyAEDT toolkit buttons available in AEDT 2023.2 after batch run + :alt: PyAEDT toolkit buttons available in AEDT -Build Toolkits with PyAEDT -~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can create and install external toolkits. -The Antenna Wizard toolkit provides an example for modeling antennas using Ansys Electronics Desktop (AEDT). -The Antenna Wizard can be found at `Antenna Wizard `_. +Toolkit Manager +~~~~~~~~~~~~~~~ +The user can install or uninstall automated workflows using the toolkit manager. +There are three options: -.. image:: ../Resources/template_ribbon.png +- Custom PyAEDT scripts. + +- Internal PyAEDT scripts. Existing workflows in the PyAEDT library. + +- Open source PyAEDT toolkits. Open source PyAEDT toolkits following the `common library `_ standard. + +.. image:: ../Resources/toolkit_manager_1.png :width: 800 - :alt: PyAEDT template toolkit buttons available in AEDT 2023.2 + :alt: PyAEDT toolkit manager 1 + +The user can select the AEDT application to install the specific workflow. + +.. image:: ../Resources/toolkit_manager_2.png + :width: 400 + :alt: PyAEDT toolkit manager 2 + Install on CPython from PyPI ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/Resources/toolkit_manager_1.png b/doc/source/Resources/toolkit_manager_1.png new file mode 100644 index 00000000000..5e093f2f703 Binary files /dev/null and b/doc/source/Resources/toolkit_manager_1.png differ diff --git a/doc/source/Resources/toolkit_manager_2.png b/doc/source/Resources/toolkit_manager_2.png new file mode 100644 index 00000000000..51993ddc2ab Binary files /dev/null and b/doc/source/Resources/toolkit_manager_2.png differ diff --git a/doc/source/Resources/toolkits_ribbon.png b/doc/source/Resources/toolkits_ribbon.png index e6e6d500d54..8f33f7825f2 100644 Binary files a/doc/source/Resources/toolkits_ribbon.png and b/doc/source/Resources/toolkits_ribbon.png differ diff --git a/doc/source/Resources/wheelhouse_installation.png b/doc/source/Resources/wheelhouse_installation.png new file mode 100644 index 00000000000..4d5e67076a6 Binary files /dev/null and b/doc/source/Resources/wheelhouse_installation.png differ