Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: installer documentation #4635

Merged
merged 2 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 43 additions & 29 deletions doc/source/Getting_started/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,45 +12,59 @@
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 <https://github.com/ansys/pyaedt/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 <https://github.com/ansys/pyaedt/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 <https://github.com/ansys/pyaedt-toolkits-antenna/>`_.
Toolkit Manager

Check warning on line 47 in doc/source/Getting_started/Installation.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/Getting_started/Installation.rst#L47

[Google.Headings] 'Toolkit Manager' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Toolkit Manager' should use sentence-style capitalization.", "location": {"path": "doc/source/Getting_started/Installation.rst", "range": {"start": {"line": 47, "column": 1}}}, "severity": "WARNING"}
~~~~~~~~~~~~~~~
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 <https://aedt.common.toolkit.docs.pyansys.com/>`_ 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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Binary file added doc/source/Resources/toolkit_manager_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/Resources/toolkit_manager_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/Resources/toolkits_ribbon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading