Choose one of the install methods below to get started:


Using the Spack Package

A package for openPMD-api is available on the Spack package manager.

# optional:               +python ^python@3:
spack install openpmd-api
spack load --dependencies openpmd-api

Using the conda Package

A package for serial openPMD-api is available on the Conda package manager.

conda install -c conda-forge openpmd-api

From Source with CMake

You can also install openPMD-api from source with CMake. This requires that you have all dependencies installed on your system. The developer section on build options provides further details on variants of the build.

Linux & OSX

git clone

mkdir -p openPMD-api-build
cd openPMD-api-build

# optional: for full tests

# for own install prefix append:
# for options append:
#   -DopenPMD_USE_...=...
# e.g. for python support add:
cmake ../openPMD-api

cmake --build .

# optional

# sudo might be required required for system paths
cmake --build . --target install


Replace the last commands with:

cmake --build . --config Release

ctest -C Release

cmake --build . --config Release --target install

Post “From Source” Install

If you installed to a non-system path on Linux or OSX, you need to express where your newly installed library can be found.

Adjust the lines below accordingly, e.g. replace $HOME/somepath with your install location prefix in -DCMAKE_INSTALL_PREFIX=.... CMake will summarize the install paths for you before the build step.

# install prefix         |------------|

#                change path to your python MAJOR.MINOR version
export PYTHONPATH=$HOME/somepath/lib/python3.5/site-packages:$PYTHONPATH

Adding those lines to your $HOME/.bashrc and re-opening your terminal will set them permanently.

Set hints on Windows with the CMake printed paths accordingly, e.g.:

set PATH=C:\\Program Files\openPMD\Lib;%PATH%
set PYTHONPATH=C:\\Program Files\openPMD\Lib\site-packages;%PYTHONPATH%