Welcome to PyEDB 0.79.1#

Note

  • Default gRPC Backend: PyEDB now selects the gRPC backend by default if no flag is specified.

  • gRPC Compatibility: PyEDB gRPC support requires Ansys release 2026.1 or higher. If you specify gRPC with Ansys release 2025.2 or lower, an error message stating that this backend is not supported for this version.

  • Fast Mode (Service Pack 2026.1.2): PyEDB gRPC introduced “fast mode” with Service Pack 2026.1.2. Speed is significantly improved thanks to bypassing network traffic and treating all processing in memory.

  • Optional DotNet Dependency: The PyEDB DotNet library is now optional. Running pip install pyedb installs only the base package. If grpc=False, an error is issued saying installs only the base package. If you try to set grpc=False, you are going to get an error saying that the DLL failed to initialize. To use the DotNet backend, run pip install pyedb[dotnet].

Useful links: Installation | Source Repository | Issues

PyEDB is a Python client library that provides a high-level interface to create, modify, and analyze PCB designs by communicating with the PyEDB-Core.

Getting started

New to PyEDB? This section provides the information that you need to get started with PyEDB.

Getting started
User guide

This section provides in-depth information on PyEDB key concepts.

User guide
API reference

This section contains descriptions of the functions and modules included in PyEDB. It describes how the methods work and the parameters that can be used.

API reference
Examples

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

Examples
Contribute

Learn how to contribute to the PyEDB codebase or documentation.

Contribution
Configuration guides

Learn the configuration-file architecture and the programmatic builder API.

Configuration guides