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

FIX: PyAEDT compatible #253

Merged
merged 75 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from 71 commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
db15ca5
Fix optimetrics
Samuelopez-ansys Sep 26, 2024
43e0ec8
Fix component conversion
Samuelopez-ansys Sep 26, 2024
8ec3e80
Fix reuse component
Samuelopez-ansys Sep 26, 2024
9117d9b
Fix read touchstone
Samuelopez-ansys Sep 26, 2024
a80685d
Fix virtual compliance
Samuelopez-ansys Sep 26, 2024
1921281
Fix virtual compliance
Samuelopez-ansys Sep 26, 2024
1d68528
Fix coaxial electrothermal
Samuelopez-ansys Sep 27, 2024
d94c040
Fix component 3d Icepak example
Samuelopez-ansys Sep 27, 2024
d7d3371
Fix ecad_import
Samuelopez-ansys Sep 27, 2024
d0e2840
Fix graphic card
Samuelopez-ansys Sep 27, 2024
b6d60d6
Revert thumbnail and plot ob objects
Samuelopez-ansys Sep 27, 2024
bd031e2
Fix graphic card
Samuelopez-ansys Sep 27, 2024
85912d4
Fix icepak circuit example
Samuelopez-ansys Sep 27, 2024
eff1317
Fix reflector
Samuelopez-ansys Sep 27, 2024
6e7ab64
Fix time domain
Samuelopez-ansys Sep 27, 2024
fc3f2a7
Add index
Samuelopez-ansys Sep 27, 2024
50b043c
Fix patch example
Samuelopez-ansys Sep 27, 2024
a74099d
commit array
Samuelopez-ansys Sep 27, 2024
62406ea
Fix subcircuit
Samuelopez-ansys Sep 27, 2024
9c68178
Fix ac q3d
Samuelopez-ansys Sep 27, 2024
d7d7757
commit spsim
Samuelopez-ansys Sep 27, 2024
ba564fd
Update links
Samuelopez-ansys Sep 27, 2024
4a3188d
Fix prelayout
Samuelopez-ansys Sep 27, 2024
0d4301d
Fix MRI
Samuelopez-ansys Sep 27, 2024
114e985
Apply gmalinve
Samuelopez-ansys Sep 27, 2024
6aafd34
Fix resistance
Samuelopez-ansys Sep 27, 2024
56d44bc
Fix flatten
Samuelopez-ansys Sep 27, 2024
292499f
Fix virtual compliance
Samuelopez-ansys Sep 27, 2024
e12033d
Fix index
Samuelopez-ansys Sep 27, 2024
0aeb550
Fix index
Samuelopez-ansys Sep 29, 2024
3e0f89b
Improve preprocessing
Samuelopez-ansys Sep 29, 2024
e9a5178
Improve aedt general
Samuelopez-ansys Sep 29, 2024
7861c8a
Improve component and modeler
Samuelopez-ansys Sep 29, 2024
bd5635e
Improve report
Samuelopez-ansys Sep 29, 2024
aabc701
Improve report
Samuelopez-ansys Sep 29, 2024
97afe55
Improve title
Samuelopez-ansys Sep 29, 2024
157a3be
Improve title
Samuelopez-ansys Sep 29, 2024
8c5991b
Improve style
Samuelopez-ansys Sep 30, 2024
1195532
Improve report
Samuelopez-ansys Sep 30, 2024
afaf3fd
Fixed touchstone
Samuelopez-ansys Sep 30, 2024
7609967
Fix grid of 2
Samuelopez-ansys Sep 30, 2024
c536deb
Fix grid of 2
Samuelopez-ansys Sep 30, 2024
8da5db0
Absolute path
Samuelopez-ansys Sep 30, 2024
72d0b7e
Remove
Samuelopez-ansys Sep 30, 2024
b46735f
Improve post processing
Samuelopez-ansys Sep 30, 2024
7f9d228
Improve post processing
Samuelopez-ansys Sep 30, 2024
5912766
Low frequency
Samuelopez-ansys Sep 30, 2024
d6c72f4
Low frequency
Samuelopez-ansys Sep 30, 2024
db9c179
Static pictures
Samuelopez-ansys Sep 30, 2024
f9776e3
Low frequency
Samuelopez-ansys Sep 30, 2024
f71d571
High frequency
Samuelopez-ansys Sep 30, 2024
084585a
Fix index
Samuelopez-ansys Sep 30, 2024
c4b3304
Fix image name
Samuelopez-ansys Sep 30, 2024
a888a28
Fix image name
Samuelopez-ansys Sep 30, 2024
9356f37
Fix image name
Samuelopez-ansys Sep 30, 2024
a4fd8b7
Fix layout index
Samuelopez-ansys Sep 30, 2024
1d96026
Fix index
Samuelopez-ansys Sep 30, 2024
4ef9faa
Fix resistance example
Samuelopez-ansys Sep 30, 2024
dc82de9
Add HFSS examples
Samuelopez-ansys Oct 1, 2024
d395b8f
Add Circuit examples
Samuelopez-ansys Oct 1, 2024
ed06c17
Add EMIT
Samuelopez-ansys Oct 1, 2024
7bbc8c3
Add HFSS 3D Layout
Samuelopez-ansys Oct 1, 2024
c7e8a65
Add Icepak
Samuelopez-ansys Oct 1, 2024
c2b1873
Add Maxwell 2D
Samuelopez-ansys Oct 1, 2024
eb66972
Add Maxwell 3D
Samuelopez-ansys Oct 1, 2024
ab0f2c5
Add Misc
Samuelopez-ansys Oct 1, 2024
5376a99
Add Q3D
Samuelopez-ansys Oct 1, 2024
0537cd9
Add Twin Builder
Samuelopez-ansys Oct 1, 2024
7e1a8b9
Fix download link
Samuelopez-ansys Oct 1, 2024
cf31a43
Fix report
Samuelopez-ansys Oct 1, 2024
d1336b4
Fix typo
Samuelopez-ansys Oct 1, 2024
da79bba
remove plot model
gmalinve Oct 1, 2024
ee78749
fix import in maxwell example
gmalinve Oct 1, 2024
c9182cf
add maxwell ipm optimization example
gmalinve Oct 1, 2024
9791435
Fix identation
Samuelopez-ansys Oct 1, 2024
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
Binary file removed doc/source/_static/thumbnails/com_eye.png
Binary file not shown.
Binary file removed doc/source/_static/thumbnails/diff_via.png
Binary file not shown.
Binary file removed doc/source/_static/thumbnails/e3dcomp.png
Binary file not shown.
Binary file removed doc/source/_static/thumbnails/emit_hfss.png
Binary file not shown.
Binary file removed doc/source/_static/thumbnails/rectifier.png
Binary file not shown.
Binary file not shown.
37 changes: 3 additions & 34 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -414,38 +414,7 @@ def setup(app):
nbsphinx_allow_errors = False

# Define static thumbnails
nbsphinx_thumbnails = {
"examples/aedt_general/configuration_files": "_static/thumbnails/configuration_file_icepak.png",
"examples/aedt_general/modeler/index": "_static/thumbnails/modeler.png",
"examples/aedt_general/modeler/coordinate_system": "_static/thumbnails/coordinate_system.png",
"examples/aedt_general/modeler/polyline": "_static/thumbnails/polyline.png",
"examples/aedt_general/modeler/netlist_to_schematic": "_static/thumbnails/netlist.png",
"examples/aedt_general/components/index": "_static/thumbnails/components.png",
"examples/aedt_general/components/component_conversion": "_static/thumbnails/e3dcomp.png",
"examples/aedt_general/report/index": "_static/thumbnails/touchstone.png",
"examples/aedt_general/report/virtual_compliance": "_static/thumbnails/virtual_compliance_eye.png",
"examples/high_frequency/antenna/fss_unitcell": "_static/thumbnails/unitcell.png",
"examples/high_frequency/antenna/large_scenarios/index": "_static/thumbnails/car_w_pedestrians.png",
"examples/high_frequency/antenna/interferences/index": "_static/thumbnails/emit_simple_cosite.png",
"examples/high_frequency/antenna/interferences/antenna": "_static/thumbnails/emit.png",
"examples/high_frequency/antenna/interferences/hfss_emit": "_static/thumbnails/emit_hfss.png",
"examples/high_frequency/antenna/interferences/interference": "_static/thumbnails/interference.png",
"examples/high_frequency/antenna/interferences/protection": "_static/thumbnails/protection.png",
"examples/high_frequency/antenna/interferences/interference_type": "_static/thumbnails/interference_type.png",
"examples/high_frequency/emc/subcircuit": "_static/thumbnails/subcircuit.png",
"examples/high_frequency/radiofrequency_mmwave/lumped_element": "_static/thumbnails/lumped_filter.png",
"examples/high_frequency/layout/signal_integrity/com_analysis": "_static/thumbnails/com_eye.png",
"examples/high_frequency/layout/signal_integrity/multizone": "_static/thumbnails/multizone.png",
"examples/high_frequency/multiphysics/index": "_static/thumbnails/multizone.png",
"examples/low_frequency/general/external_circuit": "_static/thumbnails/external_circuit.png",
"examples/low_frequency/general/twin_builder/index": "_static/thumbnails/rectifier.png",
"examples/low_frequency/general/twin_builder/static_rom": "_static/thumbnails/static_rom.png",
"examples/low_frequency/magnetic/lorentz_actuator": "_static/thumbnails/lorentz_actuator.png",
"examples/low_frequency/motor/aedt_motor/rmxpert": "_static/thumbnails/rmxpert.png",
"examples/low_frequency/multiphysics/maxwell_icepak": "_static/thumbnails/charging.png",
"examples/electrothermal/icepak_circuit_hfss_coupling": "_static/thumbnails/ring.png",
"examples/electrothermal/electrothermal": "_static/thumbnails/electrothermal.png",
}
nbsphinx_thumbnails = {}


# Define custom notebook format
Expand Down Expand Up @@ -474,8 +443,8 @@ def setup(app):

.. admonition:: Download this example

Download this example as a `Jupyter Notebook <{examples_url}/{notebook_path}>`_
or as a `Python script <{examples_url}/{python_script_path}>`_.
Download this example as a `Jupyter Notebook <{examples_url}/version/dev/{notebook_path}>`_
or as a `Python script <{examples_url}/version/dev/{python_script_path}>`_.

""".format(
examples_url=f"https://{cname}",
Expand Down
24 changes: 12 additions & 12 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Examples

**Useful links**:
`Installation <https://aedt.docs.pyansys.com/version/stable/Getting_started/Installation.html>`_ |
`Source repository <https://github.com/ansys-internal/pyaedt-examples>`_ |
`Issues <https://github.com/ansys-internal/pyaedt-examples/issues>`_
`Source repository <https://github.com/ansys/pyaedt-examples>`_ |
`Issues <https://github.com/ansys/pyaedt-examples/issues>`_

This repository contains end-to-end embedding examples that demonstrate how to use
`PyAEDT <https://aedt.docs.pyansys.com/version/stable/>`_.
Expand All @@ -25,18 +25,18 @@ This repository contains end-to-end embedding examples that demonstrate how to u

Links to brief tutorials provided in the PyAEDT documentation.

.. grid-item-card:: General
.. grid-item-card:: Examples by AEDT application
:padding: 2 2 2 2
:link: examples/aedt_general/index
:link: examples/aedt/index
:link-type: doc

.. image:: examples/aedt_general/_static/aedt_electronics.png
:alt: AEDT electronics
.. image:: examples/aedt/_static/aedt.png
:alt: AEDT
:width: 250px
:height: 200px
:align: center

Provides examples of some general PyAEDT capabilities.
Provides examples organized by AEDT applications.

.. grid-item-card:: High Frequency
:padding: 2 2 2 2
Expand Down Expand Up @@ -77,18 +77,18 @@ This repository contains end-to-end embedding examples that demonstrate how to u

Provides examples of PyAEDT capabilities for electrothermal applications.

.. grid-item-card:: Examples by AEDT application
.. grid-item-card:: Pre-processing and post-processing
:padding: 2 2 2 2
:link: examples/aedt/index
:link: examples/aedt_general/index
:link-type: doc

.. image:: examples/aedt/_static/aedt.png
:alt: AEDT
.. image:: examples/aedt_general/_static/aedt_electronics.png
:alt: AEDT electronics
:width: 250px
:height: 200px
:align: center

Provides examples organized by AEDT applications.
Provides examples of some general AEDT pre-processing and post-processing capabilities.

.. toctree::
:hidden:
Expand Down
131 changes: 119 additions & 12 deletions examples/aedt/circuit/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,122 @@
Circuit
~~~~~~~

These examples use PyAEDT to show Circuit capabilities

.. nbgallery::

../../aedt_general/modeler/circuit_schematic.py
../../aedt_general/modeler/netlist_to_schematic.py
../../aedt_general/report/automatic_report.py
../../aedt_general/report/virtual_compliance.py
../../high_frequency/emc/subcircuit.py
../../high_frequency/layout/signal_integrity/ami.py
../../high_frequency/layout/signal_integrity/circuit_transient.py
../../high_frequency/layout/signal_integrity/multizone.py
These examples use PyAEDT to show Circuit capabilities.

.. grid-item-card:: Circuit schematic creation and analysis
:padding: 2 2 2 2
:link: ../../aedt_general/modeler/circuit_schematic
:link-type: doc

.. image:: ../../aedt_general/modeler/_static/circuit.png
:alt: Circuit
:width: 250px
:height: 200px
:align: center

This example shows how to build a circuit schematic and run a transient circuit simulation.

.. grid-item-card:: Circuit Netlist to Schematic
:padding: 2 2 2 2
:link: ../../aedt_general/modeler/netlist_to_schematic
:link-type: doc

.. image:: ../../aedt_general/modeler/_static/netlist.png
:alt: Netlist
:width: 250px
:height: 250px
:align: center

This example shows how to build a circuit schematic and run a transient circuit simulation.

.. grid-item-card:: Automatic report creation
:padding: 2 2 2 2
:link: ../../aedt_general/report/automatic_report
:link-type: doc

.. image:: ../../aedt_general/report/_static/automatic_report.png
:alt: Automatic report
:width: 250px
:height: 200px
:align: center

This example shows how to create reports from a JSON template file.

.. grid-item-card:: PCIE virtual compliance
:padding: 2 2 2 2
:link: ../../aedt_general/report/virtual_compliance
:link-type: doc

.. image:: ../../aedt_general/report/_static/virtual_compliance_eye.png
:alt: Virtual compliance
:width: 250px
:height: 200px
:align: center

This example shows how to generate a compliance report in PyAEDT using the VirtualCompliance class.

.. grid-item-card:: Schematic subcircuit management
:padding: 2 2 2 2
:link: ../../high_frequency/emc/subcircuit
:link-type: doc

.. image:: ../../high_frequency/emc/_static/subcircuit.png
:alt: Cable
:width: 250px
:height: 200px
:align: center

This example shows how to add a subcircuit to a circuit design.
It changes the focus within the hierarchy between the child subcircuit and the parent design.

.. grid-item-card:: AMI Postprocessing
:padding: 2 2 2 2
:link: ../../high_frequency/layout/signal_integrity/ami
:link-type: doc

.. image:: ../../high_frequency/layout/signal_integrity/_static/ami.png
:alt: AMI
:width: 250px
:height: 200px
:align: center

This example demonstrates advanced postprocessing of AMI simulations.

.. grid-item-card:: Multi-zone simulation with SIwave
:padding: 2 2 2 2
:link: ../../high_frequency/layout/signal_integrity/multizone
:link-type: doc

.. image:: ../../high_frequency/layout/signal_integrity/_static/multizone.png
:alt: Multizone
:width: 250px
:height: 200px
:align: center

This example shows how to simulate multiple zones with SIwave.

.. grid-item-card:: Circuit transient analysis and eye diagram
:padding: 2 2 2 2
:link: ../../high_frequency/layout/signal_integrity/circuit_transient
:link-type: doc

.. image:: ../../high_frequency/layout/signal_integrity/_static/circuit_transient.png
:alt: Circuit transient
:width: 250px
:height: 200px
:align: center

This example shows how to create a circuit design, run a Nexxim time-domain simulation, and create an eye diagram.


.. toctree::
:hidden:

../../aedt_general/modeler/circuit_schematic
../../aedt_general/modeler/netlist_to_schematic
../../aedt_general/report/automatic_report
../../aedt_general/report/virtual_compliance
../../high_frequency/emc/subcircuit.py
../../high_frequency/layout/signal_integrity/ami
../../high_frequency/layout/signal_integrity/multizone
../../high_frequency/layout/signal_integrity/circuit_transient
84 changes: 77 additions & 7 deletions examples/aedt/emit/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,82 @@
EMIT
~~~~

These examples use PyAEDT to show EMIT capabilities
These examples use PyAEDT to show EMIT capabilities.

.. nbgallery::
.. grid:: 2

../../high_frequency/antenna/interferences/antenna.py
../../high_frequency/antenna/interferences/hfss_emit.py
../../high_frequency/antenna/interferences/interference.py
../../high_frequency/antenna/interferences/interference_type.py
../../high_frequency/antenna/interferences/protection.py
.. grid-item-card:: Antenna
:padding: 2 2 2 2
:link: ../../high_frequency/antenna/interferences/antenna
:link-type: doc

.. image:: ../../high_frequency/antenna/interferences/_static/emit.png
:alt: Antenna
:width: 250px
:height: 200px
:align: center

This example shows how to create a project in EMIT for the simulation of an antenna using HFSS.

.. grid-item-card:: HFSS to EMIT coupling
:padding: 2 2 2 2
:link: ../../high_frequency/antenna/interferences/hfss_emit
:link-type: doc

.. image:: ../../high_frequency/antenna/interferences/_static/emit_hfss.png
:alt: EMIT HFSS
:width: 250px
:height: 200px
:align: center

This example shows how to link an HFSS design to EMIT and model RF interference among various components.

.. grid-item-card:: Interference type classification
:padding: 2 2 2 2
:link: ../../high_frequency/antenna/interferences/interference
:link-type: doc

.. image:: ../../high_frequency/antenna/interferences/_static/interference.png
:alt: EMIT HFSS
:width: 250px
:height: 200px
:align: center

This example shows how to load an existing AEDT EMIT design and analyze the results to classify the worst-case interference.

.. grid-item-card:: Compute receiver protection levels
:padding: 2 2 2 2
:link: ../../high_frequency/antenna/interferences/interference_type
:link-type: doc

.. image:: ../../high_frequency/antenna/interferences/_static/protection.png
:alt: EMIT protection
:width: 250px
:height: 200px
:align: center

This example shows how to open an AEDT project with an EMIT design and analyze the results to determine if
the received power at the input to each receiver exceeds the specified protection levels.

.. grid-item-card:: Interference type classification using a GUI
:padding: 2 2 2 2
:link: ../../high_frequency/antenna/interferences/interference_type
:link-type: doc

.. image:: ../../high_frequency/antenna/interferences/_static/interference_type.png
:alt: EMIT protection
:width: 250px
:height: 200px
:align: center

This example uses a GUI to open an AEDT project with an EMIT design and analyze the results to classify
the worst-case interference.

.. toctree::
:hidden:

../../high_frequency/antenna/interferences/antenna
../../high_frequency/antenna/interferences/hfss_emit
../../high_frequency/antenna/interferences/interference
../../high_frequency/antenna/interferences/protection
../../high_frequency/antenna/interferences/interference_type
Loading
Loading