Skip to content

Commit

Permalink
Merge pull request #35 from ansys-internal/doc
Browse files Browse the repository at this point in the history
Doc
  • Loading branch information
svandenb-dev authored Oct 24, 2023
2 parents 1b8ca50 + ca9194e commit a2e2341
Show file tree
Hide file tree
Showing 10 changed files with 43 additions and 224 deletions.
19 changes: 19 additions & 0 deletions doc/source/User_guide/edb_queries.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
EDB Queries
===========
PyEBD allows layout information queries, this section describe some basic examples:

- stackup layers
.. code:: python
- changing layer thickness
.. code:: python
- Nets
.. code:: python
- Components
.. code:: python
. image:: ../Resources/aedt_box.png
:width: 800
:alt: Modeler Object
8 changes: 2 additions & 6 deletions doc/source/User_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,5 @@ You can obtain the same result with:
:hidden:
:maxdepth: 2

variables
modeler
mesh
setup
optimetrics
postprocessing
loading_layout
edb_queries
20 changes: 20 additions & 0 deletions doc/source/User_guide/loading_layout.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Loading layout
==============
Although an entire layout can be built from scratch with PyEDB most of the time the first step is
loading an existing aedb file. This section is showing how to load an EDB and start manipulating
objects.



.. code:: python
from pyedb.grpc.edb import Edb
edb_file = r"C:\Temp\My_edb_file.aedb"
edb = Edb(edbversion="2024.1", edbpath=edb_file, port=50001)
.. image:: ../Resources/starting_load_edb.png
:width: 600
:alt: Loading first EDB

22 changes: 0 additions & 22 deletions doc/source/User_guide/mesh.rst

This file was deleted.

56 changes: 0 additions & 56 deletions doc/source/User_guide/modeler.rst

This file was deleted.

18 changes: 0 additions & 18 deletions doc/source/User_guide/optimetrics.rst

This file was deleted.

33 changes: 0 additions & 33 deletions doc/source/User_guide/postprocessing.rst

This file was deleted.

24 changes: 0 additions & 24 deletions doc/source/User_guide/setup.rst

This file was deleted.

41 changes: 0 additions & 41 deletions doc/source/User_guide/variables.rst

This file was deleted.

26 changes: 2 additions & 24 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ PyEDB is a Python library that interacts directly with the EDB-core API to make
Getting started
^^^^^^^^^^^^^^^

Learn how to run install PyAEDT, to launch Electronics Desktop and
install link button in AEDT.
Learn how to run install PyEDB.

+++

Expand Down Expand Up @@ -44,26 +43,6 @@ PyEDB is a Python library that interacts directly with the EDB-core API to make



.. grid:: 2

.. grid-item-card::
:img-top: _static/assets/index_api.png

AEDT API reference
^^^^^^^^^^^^^^^^^^

Understand PyAEDT API endpoints, their capabilities,
and how to interact with them programmatically.

+++
.. button-link:: API/index.html
:color: secondary
:expand:
:outline:
:click-parent:

AEDT API reference

.. grid-item-card::
:img-top: _static/assets/index_api.png

Expand Down Expand Up @@ -93,7 +72,7 @@ PyEDB is a Python library that interacts directly with the EDB-core API to make
Examples
^^^^^^^^

Explore examples that show how to use PyAEDT to
Explore examples that show how to use PyEDB to
perform different types of simulations.

+++
Expand Down Expand Up @@ -137,7 +116,6 @@ Indices and tables

Getting_started/index
User_guide/index
API/index
EDBAPI/index
{% if run_examples %}
examples/index
Expand Down

0 comments on commit a2e2341

Please sign in to comment.