Skip to content

Commit

Permalink
DOC: update development documentation 9bab5f4
Browse files Browse the repository at this point in the history
  • Loading branch information
SMoraisAnsys committed Oct 21, 2024
0 parents commit 72e6e0c
Show file tree
Hide file tree
Showing 737 changed files with 263,799 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
examples.aedt.docs.pyansys.com
10 changes: 10 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Redirecting to https://examples.aedt.docs.pyansys.com/version/dev/</title>
<meta name="description" content="">
<meta http-equiv="refresh" content="0; URL=https://examples.aedt.docs.pyansys.com/version/dev/">
<link rel="canonical" href="https://examples.aedt.docs.pyansys.com/version/dev/">
</head>
</html>
Binary file added version/dev/_images/CFD_coil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/TEAM.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/ac_q3d.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/aedt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/aedt_electronics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/ami.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/armoured.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/array.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/asymmetric_conductor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/automatic_report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/bath.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/bdf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/busbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/car_w_pedestrians.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/charging.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/choke.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/choke1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/circuit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/circuit_transient.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/city.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/coaxial.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/com_eye.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/com_report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/component_3d.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added version/dev/_images/components.png
Binary file added version/dev/_images/configuration_file_icepak.png
Binary file added version/dev/_images/control_program.png
Binary file added version/dev/_images/coordinate_system.png
Binary file added version/dev/_images/coupling.png
Binary file added version/dev/_images/cpwg.png
Binary file added version/dev/_images/dc.png
Binary file added version/dev/_images/dcir.png
Binary file added version/dev/_images/dcir_q3d.png
Binary file added version/dev/_images/dipole.png
Binary file added version/dev/_images/doppler.png
Binary file added version/dev/_images/dynamic_rom_plot.png
Binary file added version/dev/_images/e3dcomp.png
Binary file added version/dev/_images/ecad.png
Binary file added version/dev/_images/eddy_current.png
Binary file added version/dev/_images/eigenmode.png
Binary file added version/dev/_images/electrostatic.png
Binary file added version/dev/_images/electrothermal.png
Binary file added version/dev/_images/emc.png
Binary file added version/dev/_images/emit.png
Binary file added version/dev/_images/emit_hfss.png
Binary file added version/dev/_images/emit_simple_cosite.png
Binary file added version/dev/_images/emit_simple_cosite1.png
Binary file added version/dev/_images/external_circuit.png
Binary file added version/dev/_images/field.png
Binary file added version/dev/_images/flex_cable.png
Binary file added version/dev/_images/general.png
Binary file added version/dev/_images/graphic.png
Binary file added version/dev/_images/hf.png
Binary file added version/dev/_images/hfss_mechanical.png
Binary file added version/dev/_images/icepak_csv.png
Binary file added version/dev/_images/icepak_logo.png
Binary file added version/dev/_images/interference.png
Binary file added version/dev/_images/interference_type.png
Binary file added version/dev/_images/ipm_optimization.png
Binary file added version/dev/_images/layout.png
Binary file added version/dev/_images/ldf.png
Binary file added version/dev/_images/logo.png
Binary file added version/dev/_images/lorentz_actuator.png
Binary file added version/dev/_images/lti_rom.png
Binary file added version/dev/_images/lumped_filter.png
Binary file added version/dev/_images/magnet_segmentation.png
Binary file added version/dev/_images/magnetic.png
Binary file added version/dev/_images/magneto.png
Binary file added version/dev/_images/modeler.png
Binary file added version/dev/_images/motor.png
Binary file added version/dev/_images/motor_maxwell.png
Binary file added version/dev/_images/motorcad.png
Binary file added version/dev/_images/mri.png
Binary file added version/dev/_images/multizone.png
Binary file added version/dev/_images/netlist.png
Binary file added version/dev/_images/optimetrics.png
Binary file added version/dev/_images/patch.png
Binary file added version/dev/_images/pcb_stress.png
Binary file added version/dev/_images/pm_synchronous.png
Binary file added version/dev/_images/polyline.png
Binary file added version/dev/_images/power_integrity.png
Binary file added version/dev/_images/power_integrity1.png
Binary file added version/dev/_images/protection.png
Binary file added version/dev/_images/pyedb.png
Binary file added version/dev/_images/pyedb2.png
Binary file added version/dev/_images/rc.png
Binary file added version/dev/_images/rectifier.png
Binary file added version/dev/_images/rectifier_response.png
Binary file added version/dev/_images/reflector.png
Binary file added version/dev/_images/resistance.png
Binary file added version/dev/_images/ring.png
Binary file added version/dev/_images/rmxpert.png
Binary file added version/dev/_images/sherlock.png
Binary file added version/dev/_images/signal_integrity.png
Binary file added version/dev/_images/spiral.png
Binary file added version/dev/_images/static_rom.png
Binary file added version/dev/_images/stripline.png
Binary file added version/dev/_images/subcircuit.png
Binary file added version/dev/_images/time_domain.png
Binary file added version/dev/_images/touchstone.png
Binary file added version/dev/_images/touchstone_skitrf.png
Binary file added version/dev/_images/transformer.png
Binary file added version/dev/_images/transformer2.png
Binary file added version/dev/_images/transient.png
Binary file added version/dev/_images/unitcell.png
Binary file added version/dev/_images/user_interface.png
Binary file added version/dev/_images/virtual_compliance_class.png
Binary file added version/dev/_images/virtual_compliance_eye.png
Binary file added version/dev/_images/virtual_compliance_usage.png
Binary file added version/dev/_images/wgf.png
Binary file added version/dev/_images/wgf1.png
122 changes: 122 additions & 0 deletions version/dev/_sources/examples/aedt/circuit/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
Circuit
~~~~~~~

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
82 changes: 82 additions & 0 deletions version/dev/_sources/examples/aedt/emit/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
EMIT
~~~~

These examples use PyAEDT to show EMIT capabilities.

.. grid:: 2

.. 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

0 comments on commit 72e6e0c

Please sign in to comment.