diff --git a/doc/source/_static/custom.css b/doc/source/_static/custom.css index 5c9ebf2a51..4a591be968 100644 --- a/doc/source/_static/custom.css +++ b/doc/source/_static/custom.css @@ -54,3 +54,19 @@ nav.bd-links ul li.toctree-l4 > a { font-size: .8rem; text-indent: 3px; } +/* Two-column layout */ +.multi-column { + display: flex; + gap: 20px; +} + +.column { + flex:1; /* Distribute width equally */ +} + +/* Optional: Responsive behavior */ +@media (max-width: 768px) { + .multi-column { + flex-direction: column; + } +} \ No newline at end of file diff --git a/doc/source/api/SimulationConfigurationV2.rst b/doc/source/api/SimulationConfigurationV2.rst deleted file mode 100644 index 6ce83c60de..0000000000 --- a/doc/source/api/SimulationConfigurationV2.rst +++ /dev/null @@ -1,155 +0,0 @@ -Simulation configuration v2.0 -============================= -These classes are the containers of simulation configuration constructors V2.0 for the EDB. - - -.. currentmodule:: pyedb.configuration.cfg_boundaries - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgBoundaries - -.. currentmodule:: pyedb.configuration.cfg_common - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgBase - -.. currentmodule:: pyedb.configuration.cfg_components - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgComponent - CfgComponents - -.. currentmodule:: pyedb.configuration.cfg_data - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgData - -.. currentmodule:: pyedb.configuration.cfg_general - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgGeneral - -.. currentmodule:: pyedb.configuration.cfg_nets - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgNets - -.. currentmodule:: pyedb.configuration.cfg_operations - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgCutout - CfgOperations - -.. currentmodule:: pyedb.configuration.cfg_package_definition - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgPackage - CfgHeatSink - CfgPackageDefinitions - -.. currentmodule:: pyedb.configuration.cfg_padstacks - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgPadstacks - -.. currentmodule:: pyedb.configuration.cfg_pin_groups - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgPinGroups - CfgPinGroup - -.. currentmodule:: pyedb.configuration.cfg_ports_sources - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgTerminalInfo - CfgCoordianteTerminalInfo - CfgNearestPinTerminalInfo - CfgSources - CfgPorts - CfgCircuitElement - CfgPort - CfgSource - -.. currentmodule:: pyedb.configuration.cfg_s_parameter_models - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgSParameterModel - -.. currentmodule:: pyedb.configuration.cfg_setup - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgSetup - CfgSIwaveACSetup - CfgSIwaveDCSetup - CfgHFSSSetup - CfgSetups - -.. currentmodule:: pyedb.configuration.cfg_spice_models - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgSpiceModel - -.. currentmodule:: pyedb.configuration.cfg_stackup - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - CfgMaterial - CfgLayer - CfgStackup - -.. currentmodule:: pyedb.configuration.configuration - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - - Configuration - - - - - diff --git a/doc/source/api/dotnet/CoreEdb.rst b/doc/source/dotnet_api/dotnet/CoreEdb.rst similarity index 100% rename from doc/source/api/dotnet/CoreEdb.rst rename to doc/source/dotnet_api/dotnet/CoreEdb.rst diff --git a/doc/source/api/dotnet/SiWave.rst b/doc/source/dotnet_api/dotnet/SiWave.rst similarity index 100% rename from doc/source/api/dotnet/SiWave.rst rename to doc/source/dotnet_api/dotnet/SiWave.rst diff --git a/doc/source/api/dotnet/XmlControlFile.rst b/doc/source/dotnet_api/dotnet/XmlControlFile.rst similarity index 100% rename from doc/source/api/dotnet/XmlControlFile.rst rename to doc/source/dotnet_api/dotnet/XmlControlFile.rst diff --git a/doc/source/api/dotnet/edb_data/EdbValue.rst b/doc/source/dotnet_api/dotnet/edb_data/EdbValue.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/EdbValue.rst rename to doc/source/dotnet_api/dotnet/edb_data/EdbValue.rst diff --git a/doc/source/api/dotnet/edb_data/HfssExtentInfo.rst b/doc/source/dotnet_api/dotnet/edb_data/HfssExtentInfo.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/HfssExtentInfo.rst rename to doc/source/dotnet_api/dotnet/edb_data/HfssExtentInfo.rst diff --git a/doc/source/api/dotnet/edb_data/LayerData.rst b/doc/source/dotnet_api/dotnet/edb_data/LayerData.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/LayerData.rst rename to doc/source/dotnet_api/dotnet/edb_data/LayerData.rst diff --git a/doc/source/api/dotnet/edb_data/NetData.rst b/doc/source/dotnet_api/dotnet/edb_data/NetData.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/NetData.rst rename to doc/source/dotnet_api/dotnet/edb_data/NetData.rst diff --git a/doc/source/api/dotnet/edb_data/PadstackData.rst b/doc/source/dotnet_api/dotnet/edb_data/PadstackData.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/PadstackData.rst rename to doc/source/dotnet_api/dotnet/edb_data/PadstackData.rst diff --git a/doc/source/api/dotnet/edb_data/PortsData.rst b/doc/source/dotnet_api/dotnet/edb_data/PortsData.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/PortsData.rst rename to doc/source/dotnet_api/dotnet/edb_data/PortsData.rst diff --git a/doc/source/api/dotnet/edb_data/PrimitivesData.rst b/doc/source/dotnet_api/dotnet/edb_data/PrimitivesData.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/PrimitivesData.rst rename to doc/source/dotnet_api/dotnet/edb_data/PrimitivesData.rst diff --git a/doc/source/api/dotnet/edb_data/RaptorXSimulationSetup.rst b/doc/source/dotnet_api/dotnet/edb_data/RaptorXSimulationSetup.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/RaptorXSimulationSetup.rst rename to doc/source/dotnet_api/dotnet/edb_data/RaptorXSimulationSetup.rst diff --git a/doc/source/api/dotnet/edb_data/SourceData.rst b/doc/source/dotnet_api/dotnet/edb_data/SourceData.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/SourceData.rst rename to doc/source/dotnet_api/dotnet/edb_data/SourceData.rst diff --git a/doc/source/api/dotnet/edb_data/Utilities.rst b/doc/source/dotnet_api/dotnet/edb_data/Utilities.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/Utilities.rst rename to doc/source/dotnet_api/dotnet/edb_data/Utilities.rst diff --git a/doc/source/api/dotnet/edb_data/Variables.rst b/doc/source/dotnet_api/dotnet/edb_data/Variables.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/Variables.rst rename to doc/source/dotnet_api/dotnet/edb_data/Variables.rst diff --git a/doc/source/api/dotnet/edb_data/index.rst b/doc/source/dotnet_api/dotnet/edb_data/index.rst similarity index 100% rename from doc/source/api/dotnet/edb_data/index.rst rename to doc/source/dotnet_api/dotnet/edb_data/index.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/adaptive_frequency_data.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/adaptive_frequency_data.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/adaptive_frequency_data.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/adaptive_frequency_data.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/index.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/index.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/index.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/index.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/mesh_operation.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/mesh_operation.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/mesh_operation.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/mesh_operation.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/settings.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/settings.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/settings.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/settings.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/sim_setup_info.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/sim_setup_info.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/sim_setup_info.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/sim_setup_info.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/simulation_settings.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/simulation_settings.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/simulation_settings.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/simulation_settings.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/siw_dc_ir_settings.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/siw_dc_ir_settings.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/siw_dc_ir_settings.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/siw_dc_ir_settings.rst diff --git a/doc/source/api/dotnet/sim_setup_data/data/sweep_data.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/data/sweep_data.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/data/sweep_data.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/data/sweep_data.rst diff --git a/doc/source/api/dotnet/sim_setup_data/io/index.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/io/index.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/io/index.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/io/index.rst diff --git a/doc/source/api/dotnet/sim_setup_data/io/siwave.rst b/doc/source/dotnet_api/dotnet/sim_setup_data/io/siwave.rst similarity index 100% rename from doc/source/api/dotnet/sim_setup_data/io/siwave.rst rename to doc/source/dotnet_api/dotnet/sim_setup_data/io/siwave.rst diff --git a/doc/source/api/dotnet/utilities/heatsink.rst b/doc/source/dotnet_api/dotnet/utilities/heatsink.rst similarity index 100% rename from doc/source/api/dotnet/utilities/heatsink.rst rename to doc/source/dotnet_api/dotnet/utilities/heatsink.rst diff --git a/doc/source/api/dotnet/utilities/hfss_simulation_setup.rst b/doc/source/dotnet_api/dotnet/utilities/hfss_simulation_setup.rst similarity index 100% rename from doc/source/api/dotnet/utilities/hfss_simulation_setup.rst rename to doc/source/dotnet_api/dotnet/utilities/hfss_simulation_setup.rst diff --git a/doc/source/api/dotnet/utilities/index.rst b/doc/source/dotnet_api/dotnet/utilities/index.rst similarity index 100% rename from doc/source/api/dotnet/utilities/index.rst rename to doc/source/dotnet_api/dotnet/utilities/index.rst diff --git a/doc/source/api/dotnet/utilities/simulation_setup.rst b/doc/source/dotnet_api/dotnet/utilities/simulation_setup.rst similarity index 100% rename from doc/source/api/dotnet/utilities/simulation_setup.rst rename to doc/source/dotnet_api/dotnet/utilities/simulation_setup.rst diff --git a/doc/source/api/dotnet/utilities/siwave_simulation_setup.rst b/doc/source/dotnet_api/dotnet/utilities/siwave_simulation_setup.rst similarity index 100% rename from doc/source/api/dotnet/utilities/siwave_simulation_setup.rst rename to doc/source/dotnet_api/dotnet/utilities/siwave_simulation_setup.rst diff --git a/doc/source/api/index.rst b/doc/source/dotnet_api/index.rst similarity index 97% rename from doc/source/api/index.rst rename to doc/source/dotnet_api/index.rst index 4c9923058b..3c693cf0cb 100644 --- a/doc/source/api/index.rst +++ b/doc/source/dotnet_api/index.rst @@ -39,6 +39,5 @@ If EDB is launched within the ``HfssdLayout`` class, EDB is accessible in read-o dotnet/sim_setup_data/io/index dotnet/utilities/index dotnet/SiWave - SimulationConfigurationv2 diff --git a/doc/source/grpc_api/grpc/database/components.rst b/doc/source/grpc_api/grpc/database/components.rst new file mode 100644 index 0000000000..c7e1800233 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/components.rst @@ -0,0 +1,12 @@ +Components +========== +These class is the containers of Components. + + +.. currentmodule:: pyedb.grpc.database + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + components.Components diff --git a/doc/source/grpc_api/grpc/database/control_file.rst b/doc/source/grpc_api/grpc/database/control_file.rst new file mode 100644 index 0000000000..4cb36639e5 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/control_file.rst @@ -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 + + diff --git a/doc/source/grpc_api/grpc/database/definitions.rst b/doc/source/grpc_api/grpc/database/definitions.rst new file mode 100644 index 0000000000..a19aaf89c5 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/definitions.rst @@ -0,0 +1,12 @@ +Definitions +=========== +This class is the container for definitions. + + +.. currentmodule:: pyedb.grpc.database + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + definitions.Definitions \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/hfss.rst b/doc/source/grpc_api/grpc/database/hfss.rst new file mode 100644 index 0000000000..3d62f817bd --- /dev/null +++ b/doc/source/grpc_api/grpc/database/hfss.rst @@ -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 diff --git a/doc/source/grpc_api/grpc/database/index.rst b/doc/source/grpc_api/grpc/database/index.rst new file mode 100644 index 0000000000..fcbff3d0a6 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/index.rst @@ -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 + diff --git a/doc/source/grpc_api/grpc/database/layout_validation.rst b/doc/source/grpc_api/grpc/database/layout_validation.rst new file mode 100644 index 0000000000..fc29a7dd54 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/layout_validation.rst @@ -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 diff --git a/doc/source/grpc_api/grpc/database/modeler.rst b/doc/source/grpc_api/grpc/database/modeler.rst new file mode 100644 index 0000000000..1f16d684a3 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/modeler.rst @@ -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() + + ... diff --git a/doc/source/grpc_api/grpc/database/nets.rst b/doc/source/grpc_api/grpc/database/nets.rst new file mode 100644 index 0000000000..5e9efe4c62 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/nets.rst @@ -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 diff --git a/doc/source/grpc_api/grpc/database/padstacks.rst b/doc/source/grpc_api/grpc/database/padstacks.rst new file mode 100644 index 0000000000..9aca5c0824 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/padstacks.rst @@ -0,0 +1,12 @@ +Padstacks +========= +Class managing Padstacks. + + +.. currentmodule:: pyedb.grpc.database + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + padstacks.Padstacks diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst new file mode 100644 index 0000000000..b708aa0851 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/component_def.rst @@ -0,0 +1,12 @@ +Component Definition +==================== +These class is the containers of Component definition. + + +.. currentmodule:: pyedb.grpc.database.definition.component_def + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + ComponentDef diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/definition/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/index.rst new file mode 100644 index 0000000000..2f8a227f89 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/index.rst @@ -0,0 +1,15 @@ +================== +Definition classes +================== + +This section describes Definition classes. + + +.. toctree:: + :maxdepth: 2 + + component_def + materials + package_def + padstack_def + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst new file mode 100644 index 0000000000..348711171e --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/materials.rst @@ -0,0 +1,14 @@ +Component Definition +==================== +These class is the containers of Component definition. + + +.. currentmodule:: pyedb.grpc.database.definition.materials + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + MaterialProperties + Material + Materials diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst new file mode 100644 index 0000000000..43ea733ecf --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/package_def.rst @@ -0,0 +1,12 @@ +Package Definition +================== +These class is the containers of package definition. + + +.. currentmodule:: pyedb.grpc.database.definition.package_def + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PackageDef diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst new file mode 100644 index 0000000000..5efdb8dc96 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/definition/padstack_def.rst @@ -0,0 +1,13 @@ +Padstack Definition +=================== +These class is the containers of padstack definition. + + +.. currentmodule:: pyedb.grpc.database.definition.padstack_def + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PadProperties + PadstackDef diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst new file mode 100644 index 0000000000..3d6f14d2dc --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/arc_data.rst @@ -0,0 +1,12 @@ +Arc Data +======== +This class manages arc data. + + +.. currentmodule:: pyedb.grpc.database.geometry.arc_data + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + ArcData diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/index.rst new file mode 100644 index 0000000000..78ce9471e3 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/index.rst @@ -0,0 +1,15 @@ +================ +Geometry classes +================ + +This section describes EDB geometry classes. + + +.. toctree:: + :maxdepth: 2 + + arc_data + point_3d_data + point_data + polygon_data + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_3d_data.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_3d_data.rst new file mode 100644 index 0000000000..5def9d115d --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_3d_data.rst @@ -0,0 +1,12 @@ +Point 3D data +============= +These class manages point 3D data. + + +.. currentmodule:: pyedb.grpc.database.geometry.point_3d_data + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Point3DData diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_data.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_data.rst new file mode 100644 index 0000000000..d09627986c --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/point_data.rst @@ -0,0 +1,12 @@ +Point Data +========== +These class manages geometry point data. + + +.. currentmodule:: pyedb.grpc.database.geometry.point_data + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PointData diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/polygon_data.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/polygon_data.rst new file mode 100644 index 0000000000..c033478da5 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/geometry/polygon_data.rst @@ -0,0 +1,12 @@ +Polygon Data +============ +This class manages polygon data. + + +.. currentmodule:: pyedb.grpc.database.geometry.polygon_data + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PolygonData diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/component.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/component.rst new file mode 100644 index 0000000000..5d8672cd49 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/component.rst @@ -0,0 +1,13 @@ +Component +========= +This class is managing EDB component. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.component + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Component + ICDieProperty diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/index.rst new file mode 100644 index 0000000000..e6e9454bae --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/index.rst @@ -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 + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/model.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/model.rst new file mode 100644 index 0000000000..f2b1b69ca7 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/model.rst @@ -0,0 +1,12 @@ +Model +===== +This class is managing EDB model. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.model + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Model diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst new file mode 100644 index 0000000000..ae771f9576 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/netlist_model.rst @@ -0,0 +1,12 @@ +Netlist Model +============= +This class is managing EDB netlist model. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.netlist_model + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + NetlistModel diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst new file mode 100644 index 0000000000..e16abbb05a --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pin_pair_model.rst @@ -0,0 +1,12 @@ +Pin Pair Model +============== +This class is managing EDB pin pair model. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.pin_pair_model + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PinPairModel diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst new file mode 100644 index 0000000000..e984a5ca0e --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/pingroup.rst @@ -0,0 +1,12 @@ +Pingroup +======== +This class is managing EDB pingroup. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.pingroup + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PinGroup diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst new file mode 100644 index 0000000000..e4433c33f2 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/s_parameter_model.rst @@ -0,0 +1,12 @@ +S-Parameter model +================= +This class is managing EDB s-parameter model. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.s_parameter_model + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + SparamModel diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst new file mode 100644 index 0000000000..24a56ce4cf --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/hierarchy/spice_model.rst @@ -0,0 +1,12 @@ +Spice Model +=========== +This class is managing EDB spice model. + + +.. currentmodule:: pyedb.grpc.database.hierarchy.spice_model + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + SpiceModel diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/index.rst new file mode 100644 index 0000000000..ca5ed9b02e --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/index.rst @@ -0,0 +1,23 @@ +======= +EDB lib +======= + +This section describes PyEDB libraries. + + +.. toctree:: + :maxdepth: 2 + + definition/index + geometry/index + hierarchy/index + layers/index + layout/index + net/index + ports/index + primitive/index + simulation_setup/index + utility/index + terminal/index + utility/index + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layers/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layers/index.rst new file mode 100644 index 0000000000..d4d1d048a7 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layers/index.rst @@ -0,0 +1,12 @@ +============== +Layers classes +============== + +This section describes EDB layers classes. + + +.. toctree:: + :maxdepth: 3 + + layer + stackup_layer \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layers/layer.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layers/layer.rst new file mode 100644 index 0000000000..cbefa79244 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layers/layer.rst @@ -0,0 +1,12 @@ +Layer +===== +This class is managing EDB layer. + + +.. currentmodule:: pyedb.grpc.database.layers.layer + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Layer diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layers/stackup_layer.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layers/stackup_layer.rst new file mode 100644 index 0000000000..5e2c2c789d --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layers/stackup_layer.rst @@ -0,0 +1,12 @@ +Stackup Layer +============= +This class is managing EDB stackup layer. + + +.. currentmodule:: pyedb.grpc.database.layers.stackup_layer + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + StackupLayer diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layout/cell.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/cell.rst new file mode 100644 index 0000000000..433945ad2f --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/cell.rst @@ -0,0 +1,12 @@ +Cell +==== +This class is managing EDB cell. + + +.. currentmodule:: pyedb.grpc.database.layout.cell + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Cell diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layout/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/index.rst new file mode 100644 index 0000000000..bf290ec25a --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/index.rst @@ -0,0 +1,13 @@ +============== +Layout classes +============== + +This section describes EDB layout classes. + + +.. toctree:: + :maxdepth: 3 + + cell + layout + voltage_regulator \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layout/layout.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/layout.rst new file mode 100644 index 0000000000..5063e66527 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/layout.rst @@ -0,0 +1,12 @@ +Layout +====== +This class is managing EDB layout. + + +.. currentmodule:: pyedb.grpc.database.layout.layout + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Layout diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/layout/voltage_regulator.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/voltage_regulator.rst new file mode 100644 index 0000000000..2470c05f53 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/layout/voltage_regulator.rst @@ -0,0 +1,13 @@ +Voltage Regulator +================= +This class is managing EDB voltage regulator. + + +.. currentmodule:: pyedb.grpc.database.layout.voltage_regulator + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + VoltageRegulator + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/net/differential_pair.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/net/differential_pair.rst new file mode 100644 index 0000000000..8bd6e368c0 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/net/differential_pair.rst @@ -0,0 +1,13 @@ +Differential Pair +================= +This class is managing EDB differential pair. + + +.. currentmodule:: pyedb.grpc.database.net.differential_pair + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + DifferentialPair + DifferentialPairs diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/net/extended_net.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/net/extended_net.rst new file mode 100644 index 0000000000..26f7dfa73f --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/net/extended_net.rst @@ -0,0 +1,13 @@ +Extended net +============ +This class is managing EDB extended net. + + +.. currentmodule:: pyedb.grpc.database.net.extended_net + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + ExtendedNet + ExtendedNets diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/net/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/net/index.rst new file mode 100644 index 0000000000..6fac7e9571 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/net/index.rst @@ -0,0 +1,14 @@ +=========== +Net classes +=========== + +This section describes EDB net classes. + + +.. toctree:: + :maxdepth: 3 + + differential_pair + extended_net + net + net_class \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/net/net.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/net/net.rst new file mode 100644 index 0000000000..682f6e9858 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/net/net.rst @@ -0,0 +1,12 @@ +Net +=== +This class is managing EDB net. + + +.. currentmodule:: pyedb.grpc.database.net.net + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Net diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/net/net_class.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/net/net_class.rst new file mode 100644 index 0000000000..2cfaa7d055 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/net/net_class.rst @@ -0,0 +1,12 @@ +Net Class +========= +This class is managing EDB net class. + + +.. currentmodule:: pyedb.grpc.database.net.net_class + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + NetClass \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/ports/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/ports/index.rst new file mode 100644 index 0000000000..f06ffdc98c --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/ports/index.rst @@ -0,0 +1,11 @@ +============ +Port classes +============ + +This section describes EDB port classes. + + +.. toctree:: + :maxdepth: 3 + + ports \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/ports/ports.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/ports/ports.rst new file mode 100644 index 0000000000..ad78c0be8a --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/ports/ports.rst @@ -0,0 +1,17 @@ +Ports +===== +This class is managing EDB ports. + + +.. currentmodule:: pyedb.grpc.database.ports.ports + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + GapPort + CircuitPort + WavePort + ExcitationSources + BundleWavePort + CoaxPort diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/bondwire.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/bondwire.rst new file mode 100644 index 0000000000..ec16d5f5a4 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/bondwire.rst @@ -0,0 +1,13 @@ +Bondwire +======== +This class is managing EDB bondwire. + + +.. currentmodule:: pyedb.grpc.database.primitive.bondwire + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Bondwire + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/circle.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/circle.rst new file mode 100644 index 0000000000..8f5f27ecd9 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/circle.rst @@ -0,0 +1,13 @@ +Circle +====== +This class is managing EDB circle. + + +.. currentmodule:: pyedb.grpc.database.primitive.circle + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Circle + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/index.rst new file mode 100644 index 0000000000..83ee7a711b --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/index.rst @@ -0,0 +1,17 @@ +================= +Primitive classes +================= + +This section describes EDB primitive classes. + + +.. toctree:: + :maxdepth: 2 + + bondwire + circle + padstack_instance + path + polygon + primitive + rectangle \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/padstack_instance.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/padstack_instance.rst new file mode 100644 index 0000000000..6a6ed40346 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/padstack_instance.rst @@ -0,0 +1,13 @@ +Pad-stack Instance +================= +This class is managing EDB padstack instance. + + +.. currentmodule:: pyedb.grpc.database.primitive.padstack_instance + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PadstackInstance + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/path.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/path.rst new file mode 100644 index 0000000000..f2355305c2 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/path.rst @@ -0,0 +1,13 @@ +Path +==== +This class is managing EDB path. + + +.. currentmodule:: pyedb.grpc.database.primitive.path + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Path + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/polygon.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/polygon.rst new file mode 100644 index 0000000000..041672dfb2 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/polygon.rst @@ -0,0 +1,13 @@ +Polygon +======= +This class is managing EDB polygon. + + +.. currentmodule:: pyedb.grpc.database.primitive.polygon + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Polygon + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/primitive.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/primitive.rst new file mode 100644 index 0000000000..864c763352 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/primitive.rst @@ -0,0 +1,13 @@ +Primitive +========= +This class is managing EDB primitive. + + +.. currentmodule:: pyedb.grpc.database.primitive.primitive + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Primitive + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/rectangle.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/rectangle.rst new file mode 100644 index 0000000000..b76927da7a --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/primitive/rectangle.rst @@ -0,0 +1,13 @@ +Rectangle +========= +This class is managing EDB rectangle. + + +.. currentmodule:: pyedb.grpc.database.primitive.rectangle + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Rectangle + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/adaptive_frequency.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/adaptive_frequency.rst new file mode 100644 index 0000000000..da3ef9ac52 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/adaptive_frequency.rst @@ -0,0 +1,13 @@ +Adaptive frequency +================== +This class is managing EDB adaptive frequency. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.adaptive_frequency + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + AdaptiveFrequency + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_advanced_meshing_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_advanced_meshing_settings.rst new file mode 100644 index 0000000000..b7fd09dc95 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_advanced_meshing_settings.rst @@ -0,0 +1,13 @@ +HFSS advanced meshing settings +============================== +This class is managing EDB HFSS advanced meshing settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_advanced_meshing_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSAdvancedMeshingSettings + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_advanced_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_advanced_settings.rst new file mode 100644 index 0000000000..79950fd671 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_advanced_settings.rst @@ -0,0 +1,13 @@ +HFSS advanced settings +============================== +This class is managing EDB HFSS advanced settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_advanced_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSAdvancedSettings + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_dcr_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_dcr_settings.rst new file mode 100644 index 0000000000..55f52b99c1 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_dcr_settings.rst @@ -0,0 +1,13 @@ +HFSS dcr settings +================= +This class is managing EDB HFSS dcr settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_dcr_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSDCRSettings + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_general_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_general_settings.rst new file mode 100644 index 0000000000..cdc7fca2ff --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_general_settings.rst @@ -0,0 +1,13 @@ +HFSS general settings +===================== +This class is managing EDB HFSS general settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_general_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSGeneralSettings + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_settings_options.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_settings_options.rst new file mode 100644 index 0000000000..6a03501426 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_settings_options.rst @@ -0,0 +1,13 @@ +HFSS settings options +===================== +This class is managing EDB HFSS settings options. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_settings_options + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSSettingsOptions + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_simulation_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_simulation_settings.rst new file mode 100644 index 0000000000..a310cd075d --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_simulation_settings.rst @@ -0,0 +1,13 @@ +HFSS simulation settings +======================== +This class is managing EDB HFSS simulation settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_simulation_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSSimulationSettings + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_simulation_setup.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_simulation_setup.rst new file mode 100644 index 0000000000..9e66b5cee8 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_simulation_setup.rst @@ -0,0 +1,13 @@ +HFSS simulation setup +===================== +This class is managing EDB HFSS simulation setup. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_simulation_setup + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HfssSimulationSetup + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_solver_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_solver_settings.rst new file mode 100644 index 0000000000..b41b6528cb --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/hfss_solver_settings.rst @@ -0,0 +1,13 @@ +HFSS solver settings +==================== +This class is managing EDB HFSS solver settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.hfss_solver_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HFSSSolverSettings + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/index.rst new file mode 100644 index 0000000000..c7c6a6de59 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/index.rst @@ -0,0 +1,26 @@ +======================== +Simulation setup classes +======================== + +This section describes EDB simulation setup classes. + + +.. toctree:: + :maxdepth: 2 + + adaptive_frequency + hfss_advanced_meshing_settings + hfss_advanced_settings + hfss_dcr_settings + hfss_general_settings + hfss_settings_options + hfss_simulation_settings + hfss_simulation_setup + hfss_solver_settings + raptor_x_advanced_settings + raptor_x_general_settings + raptor_x_simulation_settings + raptor_x_simulation_setup + siwave_dcir_simulation_setup + siwave_simulation_setup + sweep_data \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/mesh_operation.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/mesh_operation.rst new file mode 100644 index 0000000000..0449c16ea1 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/mesh_operation.rst @@ -0,0 +1,13 @@ +Mesh operation +============== +This class is managing EDB mesh operation. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.mesh_operation + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + MeshOperation + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_advanced_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_advanced_settings.rst new file mode 100644 index 0000000000..c9d5fd4ebc --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_advanced_settings.rst @@ -0,0 +1,12 @@ +Raptor X advanced settings +========================== +This class is managing EDB raptor x advanced settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.raptor_x_advanced_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + RaptorXAdvancedSettings \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_general_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_general_settings.rst new file mode 100644 index 0000000000..ce18dbc536 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_general_settings.rst @@ -0,0 +1,12 @@ +Raptor X general settings +========================= +This class is managing EDB raptor x general settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.raptor_x_general_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + RaptorXGeneralSettings \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_settings.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_settings.rst new file mode 100644 index 0000000000..180e113fbf --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_settings.rst @@ -0,0 +1,12 @@ +Raptor X simulation settings +============================ +This class is managing EDB raptor x simulation settings. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.raptor_x_simulation_settings + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + RaptorXSimulationSettings \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_setup.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_setup.rst new file mode 100644 index 0000000000..7087d8d68b --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/raptor_x_simulation_setup.rst @@ -0,0 +1,12 @@ +Raptor X simulation setup +========================= +This class is managing EDB raptor X simulation setup. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.raptor_x_simulation_setup + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + RaptorXSimulationSetup \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/siwave_dcir_simulation_setup.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/siwave_dcir_simulation_setup.rst new file mode 100644 index 0000000000..0894f5360f --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/siwave_dcir_simulation_setup.rst @@ -0,0 +1,12 @@ +Siwave dcir simulation setup +============================ +This class is managing EDB siwave dcir simulation setup. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.siwave_dcir_simulation_setup + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + SIWaveDCIRSimulationSetup \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/siwave_simulation_setup.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/siwave_simulation_setup.rst new file mode 100644 index 0000000000..1fc790d1d7 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/siwave_simulation_setup.rst @@ -0,0 +1,12 @@ +Siwave simulation setup +======================= +This class is managing EDB siwave simulation setup. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.siwave_simulation_setup + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + SiwaveSimulationSetup \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/sweep_data.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/sweep_data.rst new file mode 100644 index 0000000000..62a54da3c3 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/simulation_setup/sweep_data.rst @@ -0,0 +1,12 @@ +Sweep data +========== +This class is managing EDB sweep data for frequency sweep. + + +.. currentmodule:: pyedb.grpc.database.simulation_setup.sweep_data + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + SweepData \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/bundle_terminal.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/bundle_terminal.rst new file mode 100644 index 0000000000..322f096ca8 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/bundle_terminal.rst @@ -0,0 +1,13 @@ +Bundle terminal +=============== +This class is managing EDB bundle terminal. + + +.. currentmodule:: pyedb.grpc.database.terminal.bundle_terminal + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + BundleTerminal + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/edge_terminal.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/edge_terminal.rst new file mode 100644 index 0000000000..52f23a86dd --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/edge_terminal.rst @@ -0,0 +1,13 @@ +Edge terminal +============= +This class is managing EDB edge terminal. + + +.. currentmodule:: pyedb.grpc.database.terminal.edge_terminal + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + EdgeTerminal + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/index.rst new file mode 100644 index 0000000000..7efe1fd0fc --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/index.rst @@ -0,0 +1,16 @@ +================ +Terminal classes +================ + +This section describes EDB terminal classes. + + +.. toctree:: + :maxdepth: 2 + + bundle_terminal + edge_terminal + padstack_instance_terminal + pingroup_terminal + point_terminal + terminal \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/padstack_instance_terminal.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/padstack_instance_terminal.rst new file mode 100644 index 0000000000..dfb34e7479 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/padstack_instance_terminal.rst @@ -0,0 +1,13 @@ +Padstack instance terminal +========================== +This class is managing EDB padstack instance terminal. + + +.. currentmodule:: pyedb.grpc.database.terminal.padstack_instance_terminal + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PadstackInstanceTerminal + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/pingroup_terminal.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/pingroup_terminal.rst new file mode 100644 index 0000000000..9580d98f4e --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/pingroup_terminal.rst @@ -0,0 +1,13 @@ +Pingroup terminal +================= +This class is managing EDB pingroup terminal. + + +.. currentmodule:: pyedb.grpc.database.terminal.pingroup_terminal + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PinGroupTerminal + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/point_terminal.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/point_terminal.rst new file mode 100644 index 0000000000..4f962d92e2 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/point_terminal.rst @@ -0,0 +1,13 @@ +Point terminal +============== +This class is managing EDB point terminal. + + +.. currentmodule:: pyedb.grpc.database.terminal.point_terminal + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + PointTerminal + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/terminal.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/terminal.rst new file mode 100644 index 0000000000..d22e9db310 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/terminal/terminal.rst @@ -0,0 +1,13 @@ +Terminal +======== +This class is managing EDB terminal. + + +.. currentmodule:: pyedb.grpc.database.terminal.terminal + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Terminal + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/heat_sink.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/heat_sink.rst new file mode 100644 index 0000000000..07831674fb --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/heat_sink.rst @@ -0,0 +1,13 @@ +Heat sink +========= +This class is managing EDB heat sink. + + +.. currentmodule:: pyedb.grpc.database.utility.heat_sink + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HeatSink + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/hfss_extent_info.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/hfss_extent_info.rst new file mode 100644 index 0000000000..d21b088f22 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/hfss_extent_info.rst @@ -0,0 +1,13 @@ +HFSS extent info +================ +This class is managing EDB HFSS extend info. + + +.. currentmodule:: pyedb.grpc.database.utility.hfss_extent_info + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + HfssExtentInfo + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/index.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/index.rst new file mode 100644 index 0000000000..4431ce06c8 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/index.rst @@ -0,0 +1,16 @@ +=============== +Utility classes +=============== + +This section describes EDB utility classes. + + +.. toctree:: + :maxdepth: 2 + + heat_sink + hfss_extent_info + layout_statistics + rlc + sources + xml_control_file \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/layout_statistics.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/layout_statistics.rst new file mode 100644 index 0000000000..35e88358b1 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/layout_statistics.rst @@ -0,0 +1,13 @@ +Layout statistics +================= +This class is managing EDB layout statistics. + + +.. currentmodule:: pyedb.grpc.database.utility.layout_statistics + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + LayoutStatistics + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst new file mode 100644 index 0000000000..9de564fa3d --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/rlc.rst @@ -0,0 +1,13 @@ +Rlc +=== +This class is managing EDB rlck. + + +.. currentmodule:: pyedb.grpc.database.utility.rlc + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Rlc + diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/sources.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/sources.rst new file mode 100644 index 0000000000..f4545bb357 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/sources.rst @@ -0,0 +1,18 @@ +Source +====== +This class is managing EDB sources. + + +.. currentmodule:: pyedb.grpc.database.utility.sources + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + Node + Source + CircuitPort + VoltageSource + CurrentSource + DCTerminal + ResistorSource \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst new file mode 100644 index 0000000000..62a8893f46 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/pyedb_lib/utility/xml_control_file.rst @@ -0,0 +1,28 @@ +XML control file +================ +This class is managing EDB xml control file. + + +.. currentmodule:: pyedb.grpc.database.utility.xml_control_file + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + ControlProperty + ControlFileMaterial + ControlFileDielectric + ControlFileLayer + ControlFileVia + ControlFileStackup + ControlFileImportOptions + ControlExtent + ControlCircuitPt + ControlFileComponent + ControlFileComponents + ControlFileBoundaries + ControlFileSweep + ControlFileMeshOp + ControlFileSetup + ControlFileSetups + ControlFile \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/database/siwave.rst b/doc/source/grpc_api/grpc/database/siwave.rst new file mode 100644 index 0000000000..48ecde0c0c --- /dev/null +++ b/doc/source/grpc_api/grpc/database/siwave.rst @@ -0,0 +1,12 @@ +Siwave +====== +Class managing Siwave. + + +.. currentmodule:: pyedb.grpc.database + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + siwave.Siwave diff --git a/doc/source/grpc_api/grpc/database/source_excitations.rst b/doc/source/grpc_api/grpc/database/source_excitations.rst new file mode 100644 index 0000000000..b659b991ad --- /dev/null +++ b/doc/source/grpc_api/grpc/database/source_excitations.rst @@ -0,0 +1,12 @@ +Sources excitations +=================== +Class managing source excitations. + + +.. currentmodule:: pyedb.grpc.database + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + source_excitations.SourceExcitation diff --git a/doc/source/grpc_api/grpc/database/stackup.rst b/doc/source/grpc_api/grpc/database/stackup.rst new file mode 100644 index 0000000000..20eea8eeb1 --- /dev/null +++ b/doc/source/grpc_api/grpc/database/stackup.rst @@ -0,0 +1,13 @@ +Stackup +======= +Class managing Stackup and layers. + + +.. currentmodule:: pyedb.grpc.database + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + stackup.LayerCollection + stackup.Stackup diff --git a/doc/source/grpc_api/grpc/edb.rst b/doc/source/grpc_api/grpc/edb.rst new file mode 100644 index 0000000000..3b3e6ae03c --- /dev/null +++ b/doc/source/grpc_api/grpc/edb.rst @@ -0,0 +1,15 @@ +.. _edb_main_class: + +Edb gRPC main class +=================== + +An AEDB database is a folder that contains the database representing any part of a PCB. +It can be opened and edited using the ``Edb`` class. + +.. currentmodule:: pyedb.grpc + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + edb.Edb \ No newline at end of file diff --git a/doc/source/grpc_api/grpc/index.rst b/doc/source/grpc_api/grpc/index.rst new file mode 100644 index 0000000000..d64288a56e --- /dev/null +++ b/doc/source/grpc_api/grpc/index.rst @@ -0,0 +1,12 @@ + +PyEDB +===== + +This section describes EDB gRPC main class. + + +.. toctree:: + :maxdepth: 2 + + edb + database/index diff --git a/doc/source/grpc_api/index.rst b/doc/source/grpc_api/index.rst new file mode 100644 index 0000000000..e9dbd61b67 --- /dev/null +++ b/doc/source/grpc_api/index.rst @@ -0,0 +1,56 @@ +================== +gRPC API reference +================== + +This section describes EDB functions, classes, and methods +for EDB gRPC applications and modules. Use the search feature or click links +to view API documentation. + +The PyEDB API includes classes for apps and modules. You must initialize the +``Edb`` class to get access to all modules and methods. All other classes and +methods are inherited into the ``Edb`` class. + +If EDB is launched within the ``HfssdLayout`` class, EDB is accessible in read-only mode. + +.. note:: PyEDB is now supporting gRPC + **Starting ANSYS release 2025.2 PyEDB is compatible with gRPC.** + The two main advantages are: + - Better compatibility with Linux + - PyEDB becomes ready to remote - client services + + If you want to know more about `gRPC `_. + + PyEDB gRPC is providing backward compatibility with previous versions. + + The default grpc flag value is `False` so by default uses PyEDB DotNet. + However, starting **ANSYS release 2026.1, we will start deprecating PyEDB DotNet version**. + PyEDB gRPC becomes the long term supported version and new features are only implemented + into this one. Therefore we highly encourage users migrating to gRPC when possible to get the + best user experience. + +to enable PyEDB gRPC you have two options. + - Explicit import + - Using grpc flag + +.. code:: python + + # Explicit import + from pyedb.grpc.edb import Edb + + # Using grpc flag + from pyedb import Edb + + edb = Edb(edbpath=r"my_edb_path", edbversion="2025.2", grpc=True) + +.. toctree:: + :maxdepth: 3 + + grpc/index + + + + + + + + diff --git a/doc/source/index.rst b/doc/source/index.rst index 05099b8a28..457436c8a5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,12 +24,20 @@ API to make scripting simpler. Understand how to use PyEDB by looking at some simple tutorials. - .. grid-item-card:: API reference :fa:`book-bookmark` + .. grid-item-card:: gRPC API reference :fa:`book-bookmark` :padding: 2 2 2 2 - :link: api/index + :link: grpc_api/index :link-type: doc - Understand PyEDB API endpoints, their capabilities, + Understand PyEDB gRPC API endpoints, their capabilities, + and how to interact with them programmatically. + + .. grid-item-card:: DotNet API reference :fa:`book-bookmark` + :padding: 2 2 2 2 + :link: dotnet_api/index + :link-type: doc + + Understand PyEDB DotNet API endpoints, their capabilities, and how to interact with them programmatically. .. grid-item-card:: Examples :fa:`scroll` @@ -53,7 +61,8 @@ API to make scripting simpler. getting_started/index user_guide/index - api/index + grpc_api/index + dotnet_api/index contributing Indices and tables diff --git a/doc/source/resources/from-chips-to-ships-hfss-flex-pcb.png b/doc/source/resources/from-chips-to-ships-hfss-flex-pcb.png new file mode 100644 index 0000000000..1f123cab54 Binary files /dev/null and b/doc/source/resources/from-chips-to-ships-hfss-flex-pcb.png differ diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt index 13d7785f2b..2777f734e0 100644 --- a/doc/styles/config/vocabularies/ANSYS/accept.txt +++ b/doc/styles/config/vocabularies/ANSYS/accept.txt @@ -46,4 +46,15 @@ S[Ii]wave SYZ (?i)stackup(?:\s3D|s)? vias -XML \ No newline at end of file +XML +grpc +gRPC +Edb +xml +Rlc +S-Parameter +netlist +Pingroup +pingroup +Padstack +Spice \ No newline at end of file diff --git a/src/pyedb/grpc/database/hierarchy/pin_pair_model.py b/src/pyedb/grpc/database/hierarchy/pin_pair_model.py index 0905ad5344..d0dbd29e76 100644 --- a/src/pyedb/grpc/database/hierarchy/pin_pair_model.py +++ b/src/pyedb/grpc/database/hierarchy/pin_pair_model.py @@ -27,7 +27,7 @@ class PinPairModel(GrpcPinPairModel): - """Manage pin pair model.""" + """Manage pin-pair model.""" def __init__(self, pedb, edb_object): self._pedb_comp = pedb diff --git a/src/pyedb/grpc/database/net/differential_pair.py b/src/pyedb/grpc/database/net/differential_pair.py index 343469458c..2c47e7e5ae 100644 --- a/src/pyedb/grpc/database/net/differential_pair.py +++ b/src/pyedb/grpc/database/net/differential_pair.py @@ -85,10 +85,11 @@ def auto_identify(self, positive_differentiator="_P", negative_differentiator="_ ------- list A list containing identified differential pair names. + Examples -------- >>> from pyedb import Edb - >>> edbapp = Edb("myaedbfolder", edbversion="2023.1") + >>> edbapp = Edb("myaedbfolder", edbversion="2025.2") >>> edb_nets = edbapp.differential_pairs.auto_identify() """ nets = self._pedb.nets.nets diff --git a/src/pyedb/grpc/database/source_excitations.py b/src/pyedb/grpc/database/source_excitations.py index c12515f403..301cba3b94 100644 --- a/src/pyedb/grpc/database/source_excitations.py +++ b/src/pyedb/grpc/database/source_excitations.py @@ -2635,16 +2635,16 @@ def create_current_source(self, terminal, ref_terminal): Parameters ---------- - terminal : :class:`EdgeTerminal `, - :class:`PadstackInstanceTerminal `, - :class:`PointTerminal `, - :class:`PinGroupTerminal `, - Positive terminal of the source. - ref_terminal : :class:`EdgeTerminal `, - :class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal`, - :class:`PadstackInstanceTerminal `, - :class:`PinGroupTerminal `, - Negative terminal of the source. + terminal : :class:`EdgeTerminal `or + :class:`PadstackInstanceTerminal ` or + :class:`PointTerminal ` or + :class:`PinGroupTerminal `. + Positive terminal of the source. + ref_terminal : :class:`EdgeTerminal ` or + :class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal` or + :class:`PadstackInstanceTerminal ` or + :class:`PinGroupTerminal `. + Negative terminal of the source. Returns ------- diff --git a/src/pyedb/grpc/edb.py b/src/pyedb/grpc/edb.py index 093170364b..4ca5c18d56 100644 --- a/src/pyedb/grpc/edb.py +++ b/src/pyedb/grpc/edb.py @@ -178,13 +178,13 @@ class Edb(EdbInit): Examples -------- - Create new EDB: + >>> # Create new EDB: >>> edb = Edb() - Open existing AEDB: + >>> # Open existing AEDB: >>> edb = Edb("myproject.aedb") - Import board file: + >>> # Import board file: >>> edb = Edb("my_board.brd") """ @@ -486,7 +486,7 @@ def ports(self) -> dict[str, GapPort]: Returns ------- - dict[str, Union[:class:`GapPort`, :class:`WavePort`, :class:`CoaxPort`]] + dict[str, list[:class:`GapPort` or :class:`WavePort` or :class:`CoaxPort`]] Port names and objects. """ terminals = [term for term in self.layout.terminals if not term.is_reference_terminal] @@ -572,7 +572,7 @@ def open(self, restart_rpc_server=False) -> bool: Examples -------- - Open an existing EDB database: + >>> # Open an existing EDB database: >>> edb = Edb("myproject.aedb") """ self.standalone = self.standalone @@ -763,10 +763,9 @@ def import_layout_file( Examples -------- - Import a BRD file: + >>> # Import a BRD file: >>> edb.import_layout_file("my_board.brd", r"C:/project") - - Import a GDS file with control file: + >>> # Import a GDS file with control file: >>> edb.import_layout_file("layout.gds", control_file="control.xml") """ self._components = None @@ -831,7 +830,7 @@ def export_to_ipc2581(self, ipc_path=None, units="MILLIMETER") -> str: Examples -------- - Export to IPC2581 format: + >>> # Export to IPC2581 format: >>> edb.export_to_ipc2581("output.xml") """ if units.lower() not in ["millimeter", "inch", "micron"]: # pragma no cover @@ -1238,7 +1237,7 @@ def close_edb(self) -> bool: """Close EDB and clean up resources. ..deprecated:: 0.51.0 - Use: func:`close` instead. + Use :func:`close` instead. Returns ------- @@ -1257,17 +1256,8 @@ def save_edb(self) -> bool: """Save current EDB database. ..deprecated:: 0.51.0 - Use: func:`save` instead. - - Returns - ------- - bool - True if successful, False otherwise. + Use :func:`save` instead. - Examples - -------- - Save the current EDB: - >>> edb.save_edb() """ warnings.warn("Use method save instead.", DeprecationWarning) return self.save() @@ -1276,22 +1266,7 @@ def save_edb_as(self, fname) -> bool: """Save EDB database to new location. ..deprecated:: 0.51.0 - Use: func:`save_as` instead. - - Parameters - ---------- - fname : str - New AEDB path. - - Returns - ------- - bool - True if successful, False otherwise. - - Examples - -------- - Save EDB to new location: - >>> edb.save_edb_as("new_location.aedb") + Use :func:`save_as` instead. """ warnings.warn("Use method save_as instead.", DeprecationWarning) return self.save_as(fname) @@ -1307,8 +1282,12 @@ def execute(self, func): # return self.edb_api.utility.utility.Command.Execute(func) pass - def import_cadence_file(self, inputBrd, WorkDir=None, anstranslator_full_path="", use_ppe=False): - """Import Cadence board file (Deprecated - use import_layout_file).""" + def import_cadence_file(self, inputBrd, WorkDir=None, anstranslator_full_path="", use_ppe=False) -> bool: + """Import Cadence board file. + + .. deprecated:: 0.50 + Use :func:`import_layout_file` instead. + """ if self.import_layout_pcb( inputBrd, working_dir=WorkDir, @@ -1707,10 +1686,9 @@ def cutout( Examples -------- - Create a basic cutout: + >>> # Create a basic cutout: >>> edb.cutout(signal_list=["Net1"], reference_list=["GND"]) - - Create cutout with custom polygon: + >>> # Create cutout with custom polygon: >>> custom_poly = [[0,0], [10e-3,0], [10e-3,10e-3], [0,10e-3]] >>> edb.cutout(custom_extent=custom_poly) """ @@ -2460,7 +2438,7 @@ def export_hfss( Examples -------- - Export to HFSS project: + >>> # Export to HFSS project: >>> edb.export_hfss(r"C:/output", net_list=["SignalNet"]) """ siwave_s = SiwaveSolve(self.edbpath, aedt_installer_path=self.base_path) @@ -2496,7 +2474,7 @@ def export_q3d( Examples -------- - Export to Q3D project: + >>> # Export to Q3D project: >>> edb.export_q3d(r"C:/output") """ siwave_s = SiwaveSolve(self.edbpath, aedt_installer_path=self.base_path) @@ -2539,7 +2517,7 @@ def export_maxwell( Examples -------- - Export to Maxwell project: + >>> # Export to Maxwell project: >>> edb.export_maxwell(r"C:/output") """ siwave_s = SiwaveSolve(self.edbpath, aedt_installer_path=self.base_path) @@ -2562,7 +2540,7 @@ def solve_siwave(self): Examples -------- - Solve with SIwave: + >>> # Solve with SIwave: >>> edb.solve_siwave() """ process = SiwaveSolve(self.edbpath, aedt_version=self.edbversion) @@ -2762,7 +2740,7 @@ def get_bounding_box(self) -> list[list[float, float], list[float, float]]: Returns ------- list - [[min_x, min_y], [max_x, max_y]] in meters. + list[list[min_x, min_y], list[max_x, max_y]] in meters. """ lay_inst_polygon_data = [obj_inst.get_bbox() for obj_inst in self.layout_instance.query_layout_obj_instances()] layout_bbox = GrpcPolygonData.bbox_of_polygons(lay_inst_polygon_data) @@ -2865,10 +2843,10 @@ def setups( Returns ------- - Dict[str,: class:`pyedb.grpc.database.simulation_setup.hfss_simulation_setup.HfssSimulationSetup`] or - Dict[str,: class:`pyedb.grpc.database.simulation_setup.siwave_simulation_setup.SiwaveSimulationSetup`] or - Dict[str,: class:`SIWaveDCIRSimulationSetup`] or - Dict[str,: class:`pyedb.grpc.database.simulation_setup.raptor_x_simulation_setup.RaptorXSimulationSetup`] + Dict[str,:class:`HfssSimulationSetup`] or + Dict[str,:class:`SiwaveSimulationSetup`] or + Dict[str,:class:`SIWaveDCIRSimulationSetup`] or + Dict[str,:class:`RaptorXSimulationSetup`] """ self._setups = {} @@ -2919,8 +2897,7 @@ def siwave_ac_setups(self) -> dict[str, SiwaveSimulationSetup]: Returns ------- - Dict[str,:class:`SiwaveSimulationSetup - `] + Dict[str,:class:`SiwaveSimulationSetup`] """ return {name: i for name, i in self.setups.items() if isinstance(i, SiwaveSimulationSetup)} @@ -2931,16 +2908,6 @@ def create_hfss_setup( . deprecated:: pyedb 0.30.0 Use :func:`pyedb.grpc.core.hfss.add_setup` instead. - - Parameters - ---------- - name : str, optional - Setup name. - - Returns - ------- - :class:`HfssSimulationSetup ` - """ warnings.warn( "`create_hfss_setup` is deprecated and is now located here " "`pyedb.grpc.core.hfss.add_setup` instead.", @@ -2964,8 +2931,7 @@ def create_raptorx_setup(self, name=None) -> RaptorXSimulationSetup: Returns ------- - :class:`RaptorXSimulationSetup - ` + :class:`RaptorXSimulationSetup` RaptorX setup or False if unsupported. """ from ansys.edb.core.simulation_setup.raptor_x_simulation_setup import ( @@ -3021,8 +2987,7 @@ def create_siwave_syz_setup(self, name=None, **kwargs) -> SiwaveSimulationSetup: Returns ------- - :class:`SiwaveSimulationSetup - ` + :class:`SiwaveSimulationSetup` SYZ analysis setup. """ if not name: @@ -3050,8 +3015,7 @@ def create_siwave_dc_setup(self, name=None, **kwargs) -> GrpcSIWaveDCIRSimulatio Returns ------- - :class:`SIWaveDCIRSimulationSetup - ` + :class:`SIWaveDCIRSimulationSetup` DC analysis setup. """ if not name: @@ -3095,8 +3059,8 @@ def calculate_initial_extent(self, expansion_factor): self.logger.info(f"The W factor is {expansion_factor}, The initial extent = {max_width}") return max_width - def copy_zones(self, working_directory=None): - """Copy multizone EDB project to one new edb per zone. + def copy_zones(self, working_directory=None) -> dict[str, tuple[int, GrpcPolygonData]]: + """Copy multi-zone EDB project to one new edb per zone. Parameters ---------- @@ -3105,7 +3069,8 @@ def copy_zones(self, working_directory=None): Returns ------- - dict[str, [int,: class:`PolygonData `]] + dict[str, tuple[int,:class:`PolygonData `]] + Return a dictionary with edb path as key and tuple Zone Id as first item and EDB polygon Data defining the region as second item. @@ -3124,7 +3089,7 @@ def copy_zones(self, working_directory=None): edb_zones = {} if not self.setups: self.siwave.add_siwave_syz_analysis() - self.save_edb() + self.save() for zone_primitive in zone_primitives: if zone_primitive: edb_zone_path = os.path.join(working_directory, f"{zone_primitive.id}_{os.path.basename(self.edbpath)}") @@ -3158,10 +3123,9 @@ def cutout_multizone_layout(self, zone_dict, common_reference_net=None): Returns ------- - Dict[str: str] or List[str] - first dictionary defined_ports with edb name as key and existing port name list as value. Those ports are the - ones defined before processing the multizone clipping. - second is the list of connected port. + dict[str: str] or list[str] + first dictionary defined_ports with edb name as key and existing port name list as value. Those ports are + the ones defined before processing the multizone clipping. the second is the list of connected port. """ terminals = {} @@ -3280,29 +3244,8 @@ def create_port(self, terminal, ref_terminal=None, is_circuit_port=False, name=N """Create a port. ..deprecated:: 0.51.0 - Use: func:`create_port` has been move to source_excitation.create_port. + Use :func:`create_port` has been moved to source_excitation.create_port. - Parameters - ---------- - terminal : class:`pyedb.dotnet.database.edb_data.terminals.EdgeTerminal`, - class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal`, - class:`pyedb.grpc.database.terminals.PointTerminal`, - class:`pyedb.grpc.database.terminals.PinGroupTerminal`, - Positive terminal of the port. - ref_terminal : class:`pyedb.grpc.database.terminals.EdgeTerminal`, - class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal`, - class:`pyedb.grpc.database.terminals.PointTerminal`, - class:`pyedb.grpc.database.terminals.PinGroupTerminal`, - optional - Negative terminal of the port. - is_circuit_port : bool, optional - Whether it is a circuit port. The default is ``False``. - name: str, optional - Name of the created port. The default is None, a random name is generated. - Returns - ------- - list: [:class:`GapPort , - :class:`WavePort `]. """ warnings.warn("Use create_port from edb.source_excitation.create_port", DeprecationWarning) @@ -3312,24 +3255,8 @@ def create_voltage_probe(self, terminal, ref_terminal): """Create a voltage probe. ..deprecated:: 0.50.0 - Use: func:`create_voltage_probe` located in edb.source_excitation.create_voltage_probe instead. - - Parameters - ---------- - terminal : :class:`EdgeTerminal `, - :class:`PadstackInstanceTerminal `, - :class:`PointTerminal `, - :class:`PinGroupTerminal `, - Positive terminal of the port. - ref_terminal : :class:`EdgeTerminal `, - :class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal`, - :class:`PadstackInstanceTerminal `, - :class:`PinGroupTerminal `, - Negative terminal of the probe. + Use :func:`create_voltage_probe` has been moved to edb.source_excitation.create_voltage_probe. - Returns - ------- - :class:`Terminal ` """ warnings.warn("Use create_voltage_probe located in edb.source_excitation instead", DeprecationWarning) return self.source_excitation.create_voltage_probe(terminal, ref_terminal) @@ -3338,24 +3265,8 @@ def create_voltage_source(self, terminal, ref_terminal): """Create a voltage source. ..deprecated:: 0.50.0 - Use: func:`create_voltage_source` located in edb.source_excitation.create_voltage_source instead. + Use: func:`create_voltage_source` has been moved to edb.source_excitation.create_voltage_source. - Parameters - ---------- - terminal : :class:`EdgeTerminal `, - :class:`PadstackInstanceTerminal `, - :class:`PointTerminal `, - :class:`PinGroupTerminal `, - Positive terminal of the source. - ref_terminal : :class:`EdgeTerminal `, - :class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal`, - :class:`PadstackInstanceTerminal `, - :class:`PinGroupTerminal `, - Negative terminal of the source. - - Returns - ------- - class:`ExcitationSources ` """ warnings.warn( "use create_voltage_source located in edb.source_excitation.create_voltage_source instead", @@ -3367,24 +3278,8 @@ def create_current_source(self, terminal, ref_terminal): """Create a current source. ..deprecated:: 0.50.0 - Use: func:`create_current_source` located in edb.source_excitation.create_current_source instead. + Use :func:`create_current_source` has been moved to edb.source_excitation.create_current_source. - Parameters - ---------- - terminal : :class:`EdgeTerminal `, - :class:`PadstackInstanceTerminal `, - :class:`PointTerminal `, - :class:`PinGroupTerminal `, - Positive terminal of the source. - ref_terminal : :class:`EdgeTerminal `, - :class:`pyedb.grpc.database.terminals.PadstackInstanceTerminal`, - :class:`PadstackInstanceTerminal `, - :class:`PinGroupTerminal `, - Negative terminal of the source. - - Returns - ------- - :class:`ExcitationSources ` """ warnings.warn( "use create_current_source located in edb.source_excitation.create_current_source instead", @@ -3396,22 +3291,7 @@ def get_point_terminal(self, name, net_name, location, layer): """Place terminal between two points. ..deprecated:: 0.50.0 - Use: func:`get_point_terminal` located in edb.source_excitation.get_point_terminal instead. - - Parameters - ---------- - name : str, - Name of the terminal. - net_name : str - Name of the net. - location : list - Location of the terminal. - layer : str, - Layer of the terminal. - - Returns - ------- - :class:`PointTerminal ` + Use: func:`get_point_terminal` has been moved to edb.source_excitation.get_point_terminal. """ warnings.warn( @@ -3487,14 +3367,13 @@ def auto_parametrize_design( -------- Parametrize design elements: >>> params = edb.auto_parametrize_design( - ... layers=True, - ... materials=True, - ... trace_net_filter=["Clock"] - ... ) + >>> layers=True, + >>> materials=True, + >>> trace_net_filter=["Clock"]) """ edb_original_path = self.edbpath if output_aedb_path: - self.save_edb_as(output_aedb_path) + self.save_as(output_aedb_path) if isinstance(trace_net_filter, str): trace_net_filter = [trace_net_filter] parameters = [] @@ -3682,10 +3561,10 @@ def _apply_variable(orig_name, orig_value): void.expand(expand_voids_size, round_corners=False) if not open_aedb_at_end and self.edbpath != edb_original_path: - self.save_edb() - self.close_edb() + self.save() + self.close() self.edbpath = edb_original_path - self.open_edb() + self.open() return parameters @staticmethod diff --git a/src/pyedb/grpc/edb_init.py b/src/pyedb/grpc/edb_init.py index ed249528f4..17e5c0c2ca 100644 --- a/src/pyedb/grpc/edb_init.py +++ b/src/pyedb/grpc/edb_init.py @@ -193,10 +193,12 @@ def close(self, terminate_rpc_session=True): Parameters ---------- terminate_rpc_session : bool, optional - + Terminate RPC session when closing the database. The default value is `True`. . note:: - Unsaved changes will be lost. + Unsaved changes will be lost. If multiple databases are open and RPC session is terminated, the connection + with all databases will be lost. You might be careful and set to `False` until the last open database + remains. """ self._db.close() self._db = None