Skip to content

Commit

Permalink
Doc/overall review (#240)
Browse files Browse the repository at this point in the history
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Sebastien Morais <[email protected]>
Co-authored-by: anur7 <[email protected]>
  • Loading branch information
4 people authored Sep 18, 2024
1 parent 252e747 commit b8ca72b
Show file tree
Hide file tree
Showing 185 changed files with 2,307 additions and 2,279 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ANSYS, Inc.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Contributing

23 changes: 23 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributors

## Project Lead

* [Samuel Lopez](https://github.com/Samuelopez-ansys)

## Individual Contributors

* [Devin Crawford](https://github.com/dcrawforAtAnsys)
* [Massimo Capodiferro](https://github.com/maxcapodi78)
* [Giulia Malinverno](https://github.com/gmalinve)
* [Sébastien Morais](https://github.com/SMoraisAnsys)
* [Alberto Di Maria](https://github.com/Alberto-DM)
* [Simon Vandenbrouck](https://github.com/svandenb-dev)
* [Hui Zhou](https://github.com/ring630)
* [Maxime Rey](https://github.com/MaxJPRey)
* [Kathy Pippert](https://github.com/PipKat)
* [Lorenzo Vecchietti](https://github.com/lorenzovecchietti)
* [Abdun Nur](https://github.com/anur7)
* [Matthew Young](https://github.com/myoung301)
* [Josh Salant](https://github.com/jsalant22)
* [David Twyman](https://github.com/DaveTwyman)
* [Irene Woyna](https://github.com/IreneWoyna)
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 - 2024 ANSYS, Inc. and/or its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/_static/thumbnails/netlist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 30 additions & 29 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -415,35 +415,36 @@ def setup(app):

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


Expand Down
40 changes: 20 additions & 20 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Examples

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

Embedding examples for `PyAEDT <https://aedt.docs.pyansys.com/version/stable/>`_ are contained in this repository.
These end-to-end examples show how you can use PyAEDT.
This repository contains end-to-end embedding examples that demonstrate how to use
`PyAEDT <https://aedt.docs.pyansys.com/version/stable/>`_.


.. grid:: 2
Expand All @@ -17,78 +17,78 @@ These end-to-end examples show how you can use PyAEDT.
:link: https://aedt.docs.pyansys.com/version/stable/User_guide/index.html
:link-type: url

.. image:: examples/01-basic/_static/logo.png
.. image:: examples/basic/_static/logo.png
:alt: PyAEDT logo
:width: 250px
:height: 200px
:align: center

This section demonstrates basic PyAEDT capabilities
Links to brief tutorials provided in the PyAEDT documentation.

.. grid-item-card:: General
:padding: 2 2 2 2
:link: examples/02-aedt_general/index
:link: examples/aedt_general/index
:link-type: doc

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

AEDT general capabilities
Provides examples of some general PyAEDT capabilities.

.. grid-item-card:: High Frequency
:padding: 2 2 2 2
:link: examples/03-high_frequency/index
:link: examples/high_frequency/index
:link-type: doc

.. image:: examples/03-high_frequency/_static/hf.png
.. image:: examples/high_frequency/_static/hf.png
:alt: High frequency IC
:width: 250px
:height: 200px
:align: center

PyAEDT capabilities for High Frequency applications
Provides examples of PyAEDT capabilities for high-frequency applications.

.. grid-item-card:: Low Frequency
:padding: 2 2 2 2
:link: examples/04-low_frequency/index
:link: examples/low_frequency/index
:link-type: doc

.. image:: examples/04-low_frequency/_static/motor_maxwell.png
.. image:: examples/low_frequency/_static/motor_maxwell.png
:alt: Low frequency motor
:width: 250px
:height: 200px
:align: center

PyAEDT capabilities for Low Frequency applications
Provides examples of PyAEDT capabilities for low-frequency applications.

.. grid-item-card:: Electrothermal
:padding: 2 2 2 2
:link: examples/05-electrothermal/index
:link: examples/electrothermal/index
:link-type: doc

.. image:: examples/05-electrothermal/_static/icepak_logo.png
.. image:: examples/electrothermal/_static/icepak_logo.png
:alt: Icepak
:width: 250px
:height: 200px
:align: center

PyAEDT capabilities for Electrothermal applications
Provides examples of PyAEDT capabilities for electrothermal applications.

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

.. image:: examples/06-AEDT/_static/aedt.png
.. image:: examples/aedt/_static/aedt.png
:alt: AEDT
:width: 250px
:height: 200px
:align: center

Examples divided by AEDT application
Provides examples organized by AEDT applications.

.. toctree::
:hidden:
Expand Down
Binary file not shown.
Binary file not shown.
14 changes: 0 additions & 14 deletions examples/03-high_frequency/layout/power_integrity/index.rst

This file was deleted.

17 changes: 0 additions & 17 deletions examples/03-high_frequency/layout/signal_integrity/index.rst

This file was deleted.

13 changes: 0 additions & 13 deletions examples/03-high_frequency/multiphysics/index.rst

This file was deleted.

Empty file removed examples/06-AEDT/_static/aedt.png
Empty file.
15 changes: 0 additions & 15 deletions examples/06-AEDT/circuit/index.rst

This file was deleted.

12 changes: 0 additions & 12 deletions examples/06-AEDT/emit/index.rst

This file was deleted.

24 changes: 0 additions & 24 deletions examples/06-AEDT/hfss/index.rst

This file was deleted.

12 changes: 0 additions & 12 deletions examples/06-AEDT/hfss_3d_layout/index.rst

This file was deleted.

15 changes: 0 additions & 15 deletions examples/06-AEDT/icepak/index.rst

This file was deleted.

19 changes: 0 additions & 19 deletions examples/06-AEDT/maxwell_2d/index.rst

This file was deleted.

Loading

0 comments on commit b8ca72b

Please sign in to comment.