Skip to content

Commit

Permalink
REFACTOR: Extension documentation (#4873)
Browse files Browse the repository at this point in the history
Co-authored-by: maxcapodi78 <Shark78>
Co-authored-by: gmalinve <[email protected]>
  • Loading branch information
maxcapodi78 and gmalinve authored Jul 3, 2024
1 parent 08386d3 commit 75c4ec2
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 18 deletions.
4 changes: 2 additions & 2 deletions doc/source/Getting_started/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ gRPC interface

This is the default and preferred interface to connect to AEDT.
Ansys 2022 R2 and later support the latest gRPC interface, allowing
for remote management of MAPDL with rapid streaming of mesh, results,
and files from the MAPDL service.
for remote management of AEDT with rapid streaming of mesh, results,
and files from the AEDT service.


Legacy interfaces
Expand Down
9 changes: 8 additions & 1 deletion doc/source/User_guide/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,18 @@ Project extension apply to all extensions that are applicable for all AEDT appli
.. grid:: 2

.. grid-item-card:: Import Nastran
:link: pyaedt_extensions_doc/project
:link: pyaedt_extensions_doc/project/import_nastran
:link-type: doc

Import a Nastran or STL file in any 3D modeler application.

.. grid-item-card:: Configure Layout
:link: pyaedt_extensions_doc/project/configure_edb
:link-type: doc

Import a Nastran or STL file in any 3D modeler application.


.. toctree::
:hidden:
:maxdepth: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
Import Nastran
==============

You can import a Nastran or STL file in any 3D modeler. You can also preview the imported file and decimate it prior to import.

You can access the extension from the icon created on the **Automation** tab using the Extension Manager.

The following image shows the extension user interface:

.. image:: import_nastran_ui.png
:width: 800
:alt: Import Nastran UI

You can also launch the extension user interface from the terminal:
Command Line Extension Launch
=============================
Every extension can also launch the extension user interface from the terminal:

.. code::
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Configure Layout Edb
====================

Single configuration file to set up layout for any kind of PCB & package analysis.


The following image shows the extension user interface:

.. image:: ../../../_static/extensions/configure_edb.png
:width: 800
:alt: Configure Layout UI


The available arguments are: ``aedb_path``, ``configuration_path``.
User can pass as an argument a configuration file (a json formatted file or a toml file) or a folder containing more
than N configuration files. In such case the script creates N new aedb projects, each one with corresponding
setting file applied.


.. image:: ../../../_static/extensions/configure_edb_way_of_work.png
:width: 800
:alt: Principle of working of Layout UI



You can also launch the extension user interface from the terminal. An example can be found here:

.. toctree::
:maxdepth: 2

../commandline
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Import Nastran
==============

You can import a Nastran or STL file in any 3D modeler. You can also preview the imported file and decimate it prior to import.

You can access the extension from the icon created on the **Automation** tab using the Extension Manager.

The following image shows the extension user interface:

.. image:: ../../../_static/extensions/import_nastran_ui.png
:width: 800
:alt: Import Nastran UI


The available arguments are: ``file_path``, ``planar``, ``lightweight``, and ``decimate``.

By enabling ``lightweight`` check box the user imports the STL as a lightweight object.
The ``decimate`` parameter indicates the percentage of triangles that have to be removed during simplification.
A value of ``0.2`` means that 20% of the triangles is removed from the data read from the
file before importing in AEDT.
The ``planar`` parameter indicates that touching triangles that lie on the same plane are merged.

You can also launch the extension user interface from the terminal. An example can be found here:


.. toctree::
:maxdepth: 2

../commandline
4 changes: 3 additions & 1 deletion doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,6 @@ boolean
global_region
assign_mesh_region
assign_mesh_level
assign_mesh_reuse
assign_mesh_reuse
json
toml

0 comments on commit 75c4ec2

Please sign in to comment.