Skip to content

Commit

Permalink
DOCS: Reduce documentation size (#4655)
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuelopez-ansys authored May 13, 2024
1 parent 6bc58c0 commit c7cde76
Show file tree
Hide file tree
Showing 74 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion doc/source/API/Application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Application and solvers
The PyAEDT API includes classes for different applications available in Ansys Electronics Desktop (AEDT).
You must initialize AEDT to get access to all PyAEDT modules and methods.

.. image:: ../Resources/aedt_2.png
.. image:: ../Resources/aedt_2.webp
:width: 800
:alt: Ansys Electronics Desktop (AEDT) is a platform that enables true electronics system design.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/API/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ and Mechanical solvers for comprehensive multiphysics analysis.
Tight integration among these solutions provides unprecedented ease of use for setup and
faster resolution of complex simulations for design and optimization.

.. image:: ../Resources/aedt_2.png
.. image:: ../Resources/aedt_2.webp
:width: 800
:alt: AEDT Applications
:target: https://www.ansys.com/products/electronics
Expand Down
2 changes: 1 addition & 1 deletion doc/source/Getting_started/About.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ and mechanical solvers for comprehensive multiphysics analysis.
Tight integration among these solutions provides unprecedented ease of use for setup and
faster resolution of complex simulations for design and optimization.

.. image:: ../Resources/aedt_collage.jpg
.. image:: ../Resources/aedt_collage.webp
:width: 800
:alt: AEDT Applications
:target: https://www.ansys.com/products/electronics
Expand Down
8 changes: 4 additions & 4 deletions doc/source/Getting_started/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ In order to do that you can:
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
.. image:: ../Resources/wheelhouse_installation.webp
:width: 800
:alt: PyAEDT run script

Starting from 2023R2, buttons are available in the Automation Tab as in the example below.

.. image:: ../Resources/toolkits_ribbon.png
.. image:: ../Resources/toolkits_ribbon.webp
:width: 800
:alt: PyAEDT toolkit buttons available in AEDT

Expand All @@ -55,13 +55,13 @@ There are three options:

- 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
.. image:: ../Resources/toolkit_manager_1.webp
:width: 800
:alt: PyAEDT toolkit manager 1

The user can select the AEDT application to install the specific workflow.

.. image:: ../Resources/toolkit_manager_2.png
.. image:: ../Resources/toolkit_manager_2.webp
:width: 400
:alt: PyAEDT toolkit manager 2

Expand Down
2 changes: 1 addition & 1 deletion doc/source/Getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ and Mechanical solvers for comprehensive multiphysics analysis.
Tight integration among these solutions provides unprecedented ease of use for setup and
faster resolution of complex simulations for design and optimization.

.. image:: ../Resources/aedt_3.png
.. image:: ../Resources/aedt_3.webp
:width: 800
:alt: AEDT Applications
:target: https://www.ansys.com/products/electronics
Expand Down
Binary file removed doc/source/Resources/3dlayout.png
Binary file not shown.
Binary file removed doc/source/Resources/3dlayout_1.png
Binary file not shown.
Binary file removed doc/source/Resources/5gantenna.png
Binary file not shown.
Binary file removed doc/source/Resources/Dipole.png
Binary file not shown.
Binary file removed doc/source/Resources/IronPython2Cpython.png
Binary file not shown.
Binary file removed doc/source/Resources/Maxwell3DTeam3.png
Binary file not shown.
Binary file removed doc/source/Resources/Mesh_Operations.png
Binary file not shown.
Binary file added doc/source/Resources/Mesh_Operations.webp
Binary file not shown.
Binary file removed doc/source/Resources/Optimetrics_Parametric.png
Binary file not shown.
Binary file added doc/source/Resources/Optimetrics_Parametric.webp
Binary file not shown.
Binary file removed doc/source/Resources/Setups.png
Binary file not shown.
Binary file added doc/source/Resources/Setups.webp
Binary file not shown.
Binary file removed doc/source/Resources/Sherlock.png
Binary file not shown.
Binary file removed doc/source/Resources/aedt_2.png
Binary file not shown.
Binary file added doc/source/Resources/aedt_2.webp
Binary file not shown.
Binary file removed doc/source/Resources/aedt_3.png
Binary file not shown.
Binary file added doc/source/Resources/aedt_3.webp
Binary file not shown.
Binary file removed doc/source/Resources/aedt_box.png
Binary file not shown.
Binary file added doc/source/Resources/aedt_box.webp
Binary file not shown.
Binary file removed doc/source/Resources/aedt_collage.jpg
Binary file not shown.
Binary file added doc/source/Resources/aedt_collage.webp
Binary file not shown.
Binary file removed doc/source/Resources/aedt_first_page.png
Binary file not shown.
Binary file added doc/source/Resources/aedt_first_page.webp
Binary file not shown.
Binary file removed doc/source/Resources/aedt_setup.png
Binary file not shown.
Binary file removed doc/source/Resources/aedt_variables.png
Binary file not shown.
Binary file added doc/source/Resources/aedt_variables.webp
Binary file not shown.
Binary file removed doc/source/Resources/array.png
Binary file not shown.
Binary file removed doc/source/Resources/busbar.png
Binary file not shown.
Binary file removed doc/source/Resources/coordinate_system.png
Binary file not shown.
Binary file removed doc/source/Resources/edb.png
Binary file not shown.
Binary file removed doc/source/Resources/edb2.png
Binary file not shown.
Binary file removed doc/source/Resources/edb_intro.png
Binary file not shown.
Binary file removed doc/source/Resources/icepak.png
Binary file not shown.
Binary file removed doc/source/Resources/ipc2581.png
Binary file not shown.
Binary file removed doc/source/Resources/maxwell_losses.png
Diff not rendered.
Binary file removed doc/source/Resources/mechanical.png
Diff not rendered.
Binary file removed doc/source/Resources/nde.png
Diff not rendered.
Binary file modified doc/source/Resources/objects_operations.gif
Binary file removed doc/source/Resources/optimetrics.png
Diff not rendered.
Binary file removed doc/source/Resources/parametrized_edb.png
Diff not rendered.
Binary file removed doc/source/Resources/pyvista_plot.jpg
Diff not rendered.
Binary file added doc/source/Resources/pyvista_plot.webp
Binary file not shown.
Binary file removed doc/source/Resources/schematic.png
Diff not rendered.
Binary file removed doc/source/Resources/sherlock_doppler.png
Diff not rendered.
Binary file removed doc/source/Resources/siwave.png
Diff not rendered.
Binary file removed doc/source/Resources/sparams.jpg
Diff not rendered.
Binary file added doc/source/Resources/sparams.webp
Binary file not shown.
Binary file removed doc/source/Resources/sparams_w_matplotlib.jpg
Diff not rendered.
Binary file added doc/source/Resources/sparams_w_matplotlib.webp
Binary file not shown.
Binary file removed doc/source/Resources/spiral.png
Diff not rendered.
Binary file removed doc/source/Resources/template_ribbon.png
Diff not rendered.
Binary file removed doc/source/Resources/toolkit_manager_1.png
Diff not rendered.
Binary file added doc/source/Resources/toolkit_manager_1.webp
Binary file not shown.
Binary file removed doc/source/Resources/toolkit_manager_2.png
Diff not rendered.
Binary file added doc/source/Resources/toolkit_manager_2.webp
Binary file not shown.
Binary file removed doc/source/Resources/toolkits.png
Diff not rendered.
Binary file removed doc/source/Resources/toolkits_ribbon.png
Diff not rendered.
Binary file added doc/source/Resources/toolkits_ribbon.webp
Binary file not shown.
Binary file removed doc/source/Resources/variables_advanced.png
Diff not rendered.
Binary file added doc/source/Resources/variables_advanced.webp
Binary file not shown.
Binary file removed doc/source/Resources/viawizard.png
Diff not rendered.
Binary file removed doc/source/Resources/wheelhouse_installation.png
Diff not rendered.
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/source/User_guide/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can initiate AEDT in non-graphical mode from Python using this code:
The preceding code launches AEDT and initializes a new Circuit design.

.. image:: ../Resources/aedt_first_page.png
.. image:: ../Resources/aedt_first_page.webp
:width: 800
:alt: AEDT launched

Expand Down
2 changes: 1 addition & 1 deletion doc/source/User_guide/mesh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All mesh operations are conveniently listed within the mesh object:
my_mesh_op.update()
.. image:: ../Resources/Mesh_Operations.png
.. image:: ../Resources/Mesh_Operations.webp
:width: 800
:alt: Mesh object List

Expand Down
2 changes: 1 addition & 1 deletion doc/source/User_guide/modeler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The following code creates a box and changes the color to red:
.. image:: ../Resources/aedt_box.png
.. image:: ../Resources/aedt_box.webp
:width: 800
:alt: Modeler Object

Expand Down
6 changes: 3 additions & 3 deletions doc/source/User_guide/postprocessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To use PyAEDT to create a report in AEDT, you can follow this general structure:
hfss.post.create_report(["db(S11)", "db(S12)"])
.. image:: ../Resources/sparams.jpg
.. image:: ../Resources/sparams.webp
:width: 800
:alt: AEDT report

Expand All @@ -34,7 +34,7 @@ You can also generate reports in Matplotlib:
plt = solution.plot(solution.expressions) # Matplotlib axes object.
.. image:: ../Resources/sparams_w_matplotlib.jpg
.. image:: ../Resources/sparams_w_matplotlib.webp
:width: 800
:alt: S-Parameters report created with Matplotlib

Expand Down Expand Up @@ -97,7 +97,7 @@ PyAEDT leverages PyVista to export and plot fields outside AEDT, generating imag
)
.. image:: ../Resources/pyvista_plot.jpg
.. image:: ../Resources/pyvista_plot.webp
:width: 800
:alt: Postprocessing features

Expand Down
2 changes: 1 addition & 1 deletion doc/source/User_guide/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ essential components of the simulation process:
new_setup = m3d.create_setup("New_Setup")
.. image:: ../Resources/Setups.png
.. image:: ../Resources/Setups.webp
:width: 800
:alt: Setup Editing and Creation

6 changes: 3 additions & 3 deletions doc/source/User_guide/variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ for the variable name, a project-wide variable is created:
hfss["$dim"] = "1mm" # project variable
.. image:: ../Resources/aedt_variables.png
.. image:: ../Resources/aedt_variables.webp
:width: 800
:alt: Variable Management

Expand All @@ -36,7 +36,7 @@ access the ``variable_manager`` object for a more comprehensive set of functions
'34 * $PrjVar1/$PrjVar2'
.. image:: ../Resources/variables_advanced.png
.. image:: ../Resources/variables_advanced.webp
:width: 600
:alt: Variable Management

Expand All @@ -54,7 +54,7 @@ optimetrics setups by allowing you to read existing configurations, make edits,
m3d.parametrics.add("Rload", 0.1, 1, 0.1)
.. image:: ../Resources/Optimetrics_Parametric.png
.. image:: ../Resources/Optimetrics_Parametric.webp
:width: 800
:alt: Optimetrics creation

0 comments on commit c7cde76

Please sign in to comment.