Merge pull request #35 from ansys-internal/doc

Doc
ansys · Oct 24, 2023 · a2e2341 · a2e2341
2 parents 1b8ca50 + ca9194e
commit a2e2341
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 224 deletions.
diff --git a/doc/source/User_guide/edb_queries.rst b/doc/source/User_guide/edb_queries.rst
@@ -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
diff --git a/doc/source/User_guide/index.rst b/doc/source/User_guide/index.rst
@@ -52,9 +52,5 @@ You can obtain the same result with:
    :hidden:
    :maxdepth: 2
 
-   variables
-   modeler
-   mesh
-   setup
-   optimetrics
-   postprocessing
+   loading_layout
+   edb_queries
diff --git a/doc/source/User_guide/loading_layout.rst b/doc/source/User_guide/loading_layout.rst
@@ -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
+
diff --git a/doc/source/User_guide/mesh.rst b/doc/source/User_guide/mesh.rst
diff --git a/doc/source/User_guide/modeler.rst b/doc/source/User_guide/modeler.rst
diff --git a/doc/source/User_guide/optimetrics.rst b/doc/source/User_guide/optimetrics.rst
diff --git a/doc/source/User_guide/postprocessing.rst b/doc/source/User_guide/postprocessing.rst
diff --git a/doc/source/User_guide/setup.rst b/doc/source/User_guide/setup.rst
diff --git a/doc/source/User_guide/variables.rst b/doc/source/User_guide/variables.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -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.
 
             +++
 
@@ -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
 
@@ -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.
 
                     +++
@@ -137,7 +116,6 @@ Indices and tables
 
        Getting_started/index
        User_guide/index
-       API/index
        EDBAPI/index
        {% if run_examples %}
        examples/index