Skip to content

DOCS: grpc doc final test #1302

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

Open
wants to merge 82 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
82 commits
Select commit Hold shift + click to select a range
00250e4
grpc transition PR#1005 tracker
svandenb-dev Mar 25, 2025
534a4fb
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 1, 2025
08ee4f6
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 1, 2025
80e56ea
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 2, 2025
ed9a6d8
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 2, 2025
10bda00
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 2, 2025
647b426
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 2, 2025
3d75f93
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 2, 2025
89e41a2
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 3, 2025
3bdbbb1
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 4, 2025
6d9b264
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 9, 2025
580f542
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 10, 2025
cd224b0
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 10, 2025
b5d4dbb
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 10, 2025
a1eb46d
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 10, 2025
00f5cae
grpc test_01a_setups_frequency_sweeps
svandenb-dev Apr 11, 2025
b8b8171
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 11, 2025
49deb6c
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 14, 2025
daa31dd
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 15, 2025
ae76f6e
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 16, 2025
8f70584
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 16, 2025
1c1be82
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 17, 2025
afaac7b
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 17, 2025
9335773
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 18, 2025
11989f8
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 22, 2025
a6f2472
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 22, 2025
c5719ac
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 22, 2025
873f21d
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 22, 2025
b430d3d
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 23, 2025
a9b7abf
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 23, 2025
f3fb121
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 25, 2025
8fcdfc6
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 25, 2025
0d3635f
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 25, 2025
37ca625
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 28, 2025
c009c60
Merge remote-tracking branch 'origin/main'
svandenb-dev Apr 30, 2025
8bcfb88
Merge remote-tracking branch 'origin/main'
svandenb-dev May 2, 2025
557f752
Merge remote-tracking branch 'origin/main'
svandenb-dev May 2, 2025
3c692e4
Merge remote-tracking branch 'origin/main'
svandenb-dev May 5, 2025
c75e276
Merge remote-tracking branch 'origin/main'
svandenb-dev May 5, 2025
28d6680
grpc test fix
svandenb-dev May 5, 2025
5577313
Merge remote-tracking branch 'origin/main'
svandenb-dev May 5, 2025
659b038
Merge remote-tracking branch 'origin/main'
svandenb-dev May 5, 2025
94407a2
Merge remote-tracking branch 'origin/main'
svandenb-dev May 6, 2025
c4a17bb
Merge remote-tracking branch 'origin/main'
svandenb-dev May 6, 2025
32bbe52
Merge remote-tracking branch 'origin/main'
svandenb-dev May 6, 2025
0f250a0
Merge remote-tracking branch 'origin/main'
svandenb-dev May 6, 2025
ae2043e
Merge remote-tracking branch 'origin/main'
svandenb-dev May 7, 2025
4021a4a
Merge remote-tracking branch 'origin/main'
svandenb-dev May 7, 2025
40f583c
Merge remote-tracking branch 'origin/main'
svandenb-dev May 9, 2025
c0ebe6a
Merge remote-tracking branch 'origin/main'
svandenb-dev May 9, 2025
4c2a0f0
Merge remote-tracking branch 'origin/main'
svandenb-dev May 19, 2025
c57005d
Merge remote-tracking branch 'origin/main'
svandenb-dev May 19, 2025
d1303aa
Merge remote-tracking branch 'origin/main'
svandenb-dev May 19, 2025
bfa109d
Merge remote-tracking branch 'origin/main'
svandenb-dev May 21, 2025
0d47568
Merge remote-tracking branch 'origin/main'
svandenb-dev May 21, 2025
4ddf579
Merge remote-tracking branch 'origin/main'
svandenb-dev May 21, 2025
3ff21cc
Merge remote-tracking branch 'origin/main'
svandenb-dev May 21, 2025
f53930f
Merge remote-tracking branch 'origin/main'
svandenb-dev May 22, 2025
d02a496
Merge remote-tracking branch 'origin/main'
svandenb-dev May 23, 2025
1178822
Merge remote-tracking branch 'origin/main'
svandenb-dev May 25, 2025
8a13daf
Merge remote-tracking branch 'origin/main'
svandenb-dev May 25, 2025
ed7780b
Merge remote-tracking branch 'origin/main'
svandenb-dev May 26, 2025
2d895c2
Merge remote-tracking branch 'origin/main'
svandenb-dev May 27, 2025
0f5202b
Merge remote-tracking branch 'origin/main'
svandenb-dev May 27, 2025
d137f06
some deprecation
svandenb-dev May 27, 2025
487c749
components
svandenb-dev May 27, 2025
fa081d3
definitions
svandenb-dev May 27, 2025
cc14ca5
hfss
svandenb-dev May 27, 2025
0ba9d00
layout validation
svandenb-dev May 27, 2025
70db3ba
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 2, 2025
66a0476
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 4, 2025
9d0859f
components returned typing
svandenb-dev Jun 4, 2025
a0fef75
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 9, 2025
6e82b25
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 11, 2025
b8b86b9
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 12, 2025
494074f
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 17, 2025
a376351
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 18, 2025
6a180a5
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 20, 2025
84791fc
Merge remote-tracking branch 'origin/main'
svandenb-dev Jun 23, 2025
fbef9c1
grpc doc test
svandenb-dev Jun 23, 2025
b075d18
cfg typo fix
svandenb-dev Jun 23, 2025
d1a411c
remove cfg from grpc
svandenb-dev Jun 23, 2025
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
2 changes: 1 addition & 1 deletion doc/source/api/SimulationConfigurationV2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ These classes are the containers of simulation configuration constructors V2.0 f
:nosignatures:

CfgTerminalInfo
CfgCoordianteTerminalInfo
CfgCoordinateTerminalInfo
CfgNearestPinTerminalInfo
CfgSources
CfgPorts
Expand Down
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/components.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Components
==========
These class is the containers of Components.


.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:

components.Components
31 changes: 31 additions & 0 deletions doc/source/api/grpc/database/control_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Control file
============
These classes are the containers of the GDS control file.


.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:


control_file.ControlFile
control_file.ControlProperty
control_file.ControlFileMaterial
control_file.ControlFileDielectric
control_file.ControlFileLayer
control_file.ControlFileVia
control_file.ControlFileStackup
control_file.ControlFileImportOptions
control_file.ControlExtent
control_file.ControlCircuitPt
control_file.ControlFileComponent
control_file.ControlFileComponents
control_file.ControlFileBoundaries
control_file.ControlFileSweep
control_file.ControlFileMeshOp
control_file.ControlFileSetup
control_file.ControlFileSetups


12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/definitions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Definitions
===========
This class is the container for definitions.


.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:

definitions.Definitions
15 changes: 15 additions & 0 deletions doc/source/api/grpc/database/hfss.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
HFSS
====

Class managing HFSS container
----------------------------
These classes are the containers of HFSS class.


.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:

hfss.Hfss
23 changes: 23 additions & 0 deletions doc/source/api/grpc/database/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
========
Database
========

This section describes EDB database classes.


.. toctree::
:maxdepth: 3

components
control_file
definitions
hfss
layout_validation
modeler
nets
padstacks
siwave
source_excitations
stackup
pyedb_lib/index

14 changes: 14 additions & 0 deletions doc/source/api/grpc/database/layout_validation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Layout validation
=================
These classes are the containers of Layout Validation.

.. autosummary::
:toctree: _autosummary

.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:

layout_validation.LayoutValidation
31 changes: 31 additions & 0 deletions doc/source/api/grpc/database/modeler.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Modeler & primitives
====================
These classes are the containers of primitives and all relative methods.
Primitives are planes, lines, rectangles, and circles.


Primitives properties
---------------------
These classes are the containers of data management for primitives and arcs.

.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:


modeler.Modeler


.. code:: python

from pyedb.grpc.edb import Edb

edb = Edb(myedb, edbversion="2025.2")

polygon = edbapp.modeler.polygons[0]
polygon.is_void
poly2 = polygon.clone()

...
23 changes: 23 additions & 0 deletions doc/source/api/grpc/database/nets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Sources and excitations
=======================
These classes are the containers of sources methods of the EDB for both HFSS and SIwave.


.. code:: python

from pyedb.grpc.edb import Edb

edb = Edb(myedb, edbversion="2025.2")

# this call returns the EDB excitations dictionary
edb.excitations
...


.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:

nets.Nets
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/padstacks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Padstacks
=========
Class managing Padstacks.


.. currentmodule:: pyedb.grpc.database

.. autosummary::
:toctree: _autosummary
:nosignatures:

padstacks.Padstacks
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Component Definition

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/definition/component_def.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/definition/component_def.rst#L1

[Google.Headings] 'Component Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Component Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/definition/component_def.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
====================
These class is the containers of Component definition.


.. currentmodule:: pyedb.grpc.database.definition.component_def

.. autosummary::
:toctree: _autosummary
:nosignatures:

ComponentDef
15 changes: 15 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/definition/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
==================
Definition classes
==================

This section describes Definition classes.


.. toctree::
:maxdepth: 2

component_def
materials
package_def
padstack_def

14 changes: 14 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/definition/materials.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Component Definition

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/definition/materials.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/definition/materials.rst#L1

[Google.Headings] 'Component Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Component Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/definition/materials.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
====================
These class is the containers of Component definition.


.. currentmodule:: pyedb.grpc.database.definition.materials

.. autosummary::
:toctree: _autosummary
:nosignatures:

MaterialProperties
Material
Materials
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/definition/package_def.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Package Definition

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/definition/package_def.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/definition/package_def.rst#L1

[Google.Headings] 'Package Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Package Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/definition/package_def.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
==================
These class is the containers of package definition.


.. currentmodule:: pyedb.grpc.database.definition.package_def

.. autosummary::
:toctree: _autosummary
:nosignatures:

PackageDef
13 changes: 13 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/definition/padstack_def.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Padstack Definition

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/definition/padstack_def.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/definition/padstack_def.rst#L1

[Google.Headings] 'Padstack Definition' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Padstack Definition' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/definition/padstack_def.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
===================
These class is the containers of padstack definition.


.. currentmodule:: pyedb.grpc.database.definition.padstack_def

.. autosummary::
:toctree: _autosummary
:nosignatures:

EDBPadProperties
PadstackDef
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/geometry/arc_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Arc Data

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/geometry/arc_data.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/geometry/arc_data.rst#L1

[Google.Headings] 'Arc Data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Arc Data' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/geometry/arc_data.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
========
This class manages arc data.


.. currentmodule:: pyedb.grpc.database.geometry.arc_data

.. autosummary::
:toctree: _autosummary
:nosignatures:

ArcData
15 changes: 15 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/geometry/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
================
Geometry classes
================

This section describes EDB geometry classes.


.. toctree::
:maxdepth: 2

arc_data
point_3d_data
point_data
polygon_data

12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/geometry/point_3d_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Point 3D data

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/geometry/point_3d_data.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/geometry/point_3d_data.rst#L1

[Google.Headings] 'Point 3D data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Point 3D data' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/geometry/point_3d_data.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
=============
These class manages point 3D data.


.. currentmodule:: pyedb.grpc.database.geometry.point_3d_data

.. autosummary::
:toctree: _autosummary
:nosignatures:

Point3DData
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/geometry/point_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Point Data

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/geometry/point_data.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/geometry/point_data.rst#L1

[Google.Headings] 'Point Data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Point Data' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/geometry/point_data.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
==========
These class manages geometry point data.


.. currentmodule:: pyedb.grpc.database.geometry.point_data

.. autosummary::
:toctree: _autosummary
:nosignatures:

PointData
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/geometry/polygon_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Polygon Data

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/geometry/polygon_data.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/geometry/polygon_data.rst#L1

[Google.Headings] 'Polygon Data' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Polygon Data' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/geometry/polygon_data.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
============
This class manages polygon data.


.. currentmodule:: pyedb.grpc.database.geometry.polygon_data

.. autosummary::
:toctree: _autosummary
:nosignatures:

PolygonData
13 changes: 13 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/hierarchy/component.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Component
=========
This class is managing EDB component.


.. currentmodule:: pyedb.grpc.database.hierarchy.component

.. autosummary::
:toctree: _autosummary
:nosignatures:

Component
ICDieProperty
18 changes: 18 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/hierarchy/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=================
Hierarchy classes
=================

This section describes EDB hierarchy classes.


.. toctree::
:maxdepth: 2

component
model
netlist_model
pin_pair_model
pingroup
s_parameter_model
spice_model

12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/hierarchy/model.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Model
=====
This class is managing EDB model.


.. currentmodule:: pyedb.grpc.database.hierarchy.model

.. autosummary::
:toctree: _autosummary
:nosignatures:

Model
12 changes: 12 additions & 0 deletions doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Netlist Model

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst#L1

[Vale.Terms] Use 'netlist' instead of 'Netlist'.
Raw output
{"message": "[Vale.Terms] Use 'netlist' instead of 'Netlist'.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}

Check failure on line 1 in doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst#L1

[Google.Headings] 'Netlist Model' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Netlist Model' should use sentence-style capitalization.", "location": {"path": "doc/source/api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
=============
This class is managing EDB netlist model.


.. currentmodule:: pyedb.grpc.database.hierarchy.netlist_model

.. autosummary::
:toctree: _autosummary
:nosignatures:

NetlistModel
Loading
Loading