Getting Started#


DPF supports Windows 10 and CentOS 7 and later. For more information, see Ansys Platform Support.

Client Server Compatibility#

The DPF server version depends on the Ansys installation version. The PyDPF-Core client used must be compatible with it according to the table below. Notice that starting with Ansys 2021 R2 one can use any PyDPF-Core >= 3.0. Only Ansys 2021 R1 requires a specific version of PyDPF-Core (0.2.*).

Future development will always try to ensure backward compatibility from the client to the server.

The ansys.grpc.dpf module should also be synchronized with the server version.

Client-Server Compatibility#

Ans.Dpf.Grpc.exe server version

ansys.dpf.gatebin binaries python module version

ansys.dpf.gate python module version

ansys.grpc.dpf python module version

ansys.dpf.core python module version

4.0 (Ansys 2022R2)





3.0 (Ansys 2022R1)





2.0 (Ansys 2021R2)





1.0 (Ansys 2021R1)





To start a server with Ans.Dpf.Grpc.bat or (used in the start_local_server function), please make sure that the environment variable AWP_ROOT{VER} with (VER=212, 221, …) is set.


DPF-Core is a Python gRPC client communicating with the Ans.Dpf.Grpc server. To use the native DPF server, you must have a local installation of Ansys 2021 R1 or higher. For more information on getting a licensed copy of Ansys, visit the Ansys website.


Installation with PIP#

Once Ansys 2021 R2 or later is installed, you can install PyDPF-Core with:

pip install ansys-dpf-core

This installs the latest version of PyDPF-Core and all necessary dependencies.

To use PyDPF-Core with Ansys 2021 R1, you must install PyDPF-Core with:

pip install ansys-dpf-core<0.3.0

If you are unable to install this module on the host machine due to network isolation, download the latest or a specific release wheel at PyDPF-Core GitHub or from PyPi at PyDPF-Core PyPi

Editable Installation (Development Mode)#

If you want to edit and potentially contribute to the DPF-Core module, clone the repository and install it using pip with the -e development flag:

git clone
cd pydpf-core
pip install -e .

Tryout Installation#

For a quick tryout installation, use:

from ansys.dpf.core import Model
from ansys.dpf.core import examples
model = Model(examples.simple_bar)


DPF Model
Static analysis
Unit system: Metric (m, kg, N, s, V, A)
Physics Type: Mecanic
Available results:
     -  displacement: Nodal Displacement
     -  element_nodal_forces: ElementalNodal Element nodal Forces
     -  elemental_volume: Elemental Volume
     -  stiffness_matrix_energy: Elemental Energy-stiffness matrix
     -  artificial_hourglass_energy: Elemental Hourglass Energy
     -  thermal_dissipation_energy: Elemental thermal dissipation energy
     -  kinetic_energy: Elemental Kinetic Energy
     -  co_energy: Elemental co-energy
     -  incremental_energy: Elemental incremental energy
     -  structural_temperature: ElementalNodal Temperature
DPF  Meshed Region:
  3751 nodes
  3000 elements
  Unit: m
  With solid (3D) elements
DPF  Time/Freq Support:
  Number of sets: 1
Cumulative     Time (s)       LoadStep       Substep
1              1.000000       1              1


DPF-Core dependencies are automatically checked when packages are installed. The package dependencies are:

Optional Dependencies#

Optional package dependencies can be installed for specific usage: