Ansys API for EDB (gRPC interface)

0.3.0 verified Fri May 01 auth: no python

Autogenerated Python gRPC interface package for Ansys Electronics Database (EDB). Provides protobuf and gRPC stubs used by pyedb-core. Version 0.3.0, released April 2026, with active development including dev releases (0.4.dev0).

pip install ansys-api-edb

Common errors

error ModuleNotFoundError: No module named 'ansys.api.edb' ↓

cause ansys-api-edb not installed or installed in wrong environment.

fix

pip install ansys-api-edb

error ImportError: cannot import name 'EdbGrpcStub' from 'ansys.api.edb.v1.edb_messages_pb2_grpc' ↓

cause Service/stub names differ per version; the correct stub may have a different suffix.

fix

List the contents of the pb2_grpc module: dir(grpc_module) and use the correct class name.

error AttributeError: module 'ansys.api.edb' has no attribute 'v1' ↓

cause Package version mismatch or corrupted install.

fix

Check installed version with pip show ansys-api-edb; reinstall if necessary.

Warnings

gotcha This library provides only gRPC stubs and protobuf messages. It does NOT provide high-level Python EDB APIs; use pyedb-core or pyaedt for that. ↓

fix Install pyedb-core (or pyaedt) for a user-friendly API.

breaking The package is autogenerated; import paths changed between major versions. Always check the exact .proto files for message and service names. ↓

fix Refer to ansys/api/edb/v1/ for current structure, not older import paths like ansys.api.edb.v0.

deprecated Older v0.2.x releases used different proto packages; avoid mixing versions of ansys-api-edb and pyedb-core. ↓

fix Upgrade to >=0.3.0 and ensure pyedb-core is compatible.

Imports

EdbGrpcClient
wrong
```
import ansys_api_edb
```
correct
```
from ansys.api.edb.v1.edb_messages_pb2_grpc import EdbGrpcStub
```
The package exposes no top-level import; stubs are under ansys.api.edb.v1.*

Quickstart

Connect to a running EDB gRPC server and fetch version.

import grpc
from ansys.api.edb.v1.edb_messages_pb2_grpc import EdbGrpcStub
from ansys.api.edb.v1.edb_messages_pb2 import Empty
channel = grpc.insecure_channel('localhost:50051')
stub = EdbGrpcStub(channel)
response = stub.GetVersion(Empty())
print(response)