Installation

Prerequisites

You must have AEDT installed, the ansys-edb-core server service is included. The PyEDB client is a python package automatically installed with PyEDB and will automatically find and connect to the server.

Make sure you are running the latest ansys-edb-core client version compatible with your AEDT version.

pip install --upgrade ansys-edb-core

Install the PyEDB Client

The PyEDB Python client is installed via pip. It is highly recommended to use a virtual environment.

# Install the latest release from PyPI
pip install pyedb

# Install the latest development version from GitHub
pip install git+https://github.com/ansys/pyedb

Verifying the Installation

To test your installation and connection to the ansys-edb-core service, run the following Python script:

test_installation.py

from pyedb import Edb
edb = Edb(version="2025.2")