Skip to content

Commit

Permalink
DOCS: Add steps to install toolkit (#5293)
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuelopez-ansys authored Oct 14, 2024
1 parent 71d63c7 commit 6215b41
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
36 changes: 34 additions & 2 deletions doc/source/Getting_started/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,19 @@ If you are not utilizing gRPC, you can install the required dotnet dependencies
pip install pyaedt[dotnet]
If you want to install the PyAEDT panels in the AEDT Automation tab, use the following command:

.. code:: python
pip install pyaedt[installer]
Finally, in the python console, run the following commands:

.. code::
from ansys.aedt.core.workflows.installer.pyaedt_installer import add_pyaedt_to_aedt
add_pyaedt_to_aedt(“your_aedt_version", r“path_to_personalib")
Linux support
~~~~~~~~~~~~~
Expand All @@ -113,18 +126,37 @@ However, you must set up the following environment variables:
Install offline from a wheelhouse
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using a wheelhouse can be helpful if you work for a company that restricts access to external networks.
Wheelhouses for CPython 3.8, 3.9, 3.10, 3.11, and 3.12 are available in the releases for both Windows and Linux. From the `Releases <https://github.com/ansys/pyaedt/releases>`_

Wheelhouses for CPython 3.8, 3.9, 3.10, 3.11, and 3.12 are available in the releases for both Windows and Linux.
From the `Releases <https://github.com/ansys/pyaedt/releases>`_
page in the PyAEDT repository, you can find the wheelhouses for a particular release in its
assets and download the wheelhouse specific to your setup.

There are two kind of wheelhouses: `all` and `installer`.

The `all` wheelhouse contains all PyAEDT dependencies. And the `installer` one includes `ipython` and `jupyter lab`.

You can then install PyAEDT and all of its dependencies from one single entry point that can be shared internally,
which eases the security review of the PyAEDT package content.

For example, on Windows with Python 3.10, install PyAEDT and all its dependencies from a wheelhouse with code like this:

.. code::
pip install --no-cache-dir --no-index --find-links=file:///<path_to_wheelhouse>/PyAEDT-v<release_version>-wheelhouse-Windows-3.10 pyaedt
pip install --no-cache-dir --no-index --find-links=file:///<path_to_wheelhouse>/PyAEDT-v<release_version>-wheelhouse-Windows-3.10 pyaedt[all]
If you want to add the PyAEDT panels in the AEDT Automation tab, you need first to install the installer dependencies:

.. code::
pip install --no-cache-dir --no-index --find-links=file:///<path_to_wheelhouse>/PyAEDT-v<release_version>-wheelhouse-Windows-3.10 pyaedt[installer]
Finally, in the python console, run the following commands:

.. code::
from ansys.aedt.core.workflows.installer.pyaedt_installer import add_pyaedt_to_aedt
add_pyaedt_to_aedt(“your_aedt_version", r“path_to_personalib")
Install PyAEDT in Conda virtual environment
Expand Down
1 change: 1 addition & 0 deletions doc/styles/config/vocabularies/ANSYS/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ assign_mesh_region
assign_mesh_level
assign_mesh_reuse
json
jupyter
toml
Parasolid
i.e.
Expand Down

0 comments on commit 6215b41

Please sign in to comment.