-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
REFACTOR: Extension documentation (#4873)
Co-authored-by: maxcapodi78 <Shark78> Co-authored-by: gmalinve <[email protected]>
- Loading branch information
1 parent
08386d3
commit 75c4ec2
Showing
7 changed files
with
76 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 3 additions & 14 deletions
17
...r_guide/pyaedt_extensions_doc/project.rst → ...ide/pyaedt_extensions_doc/commandline.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
doc/source/User_guide/pyaedt_extensions_doc/project/configure_edb.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
29 changes: 29 additions & 0 deletions
29
doc/source/User_guide/pyaedt_extensions_doc/project/import_nastran.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -94,4 +94,6 @@ boolean | |
global_region | ||
assign_mesh_region | ||
assign_mesh_level | ||
assign_mesh_reuse | ||
assign_mesh_reuse | ||
json | ||
toml |