Installation¶
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.
spack install openpmd-api # optional: +python
spack load --dependencies openpmd-api
Using the conda Package¶
Attention
Not yet implemented. Will be shipped via conda-forge.
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.
On Linux platforms:
git clone https://github.com/openPMD/openPMD-api.git
mkdir -p openPMD-api-build
cd openPMD-api-build
# optional for some tests
.travis/download_samples.sh
# for own install prefix append:
# -DCMAKE_INSTALL_PREFIX=$HOME/somepath
# for options append:
# -DopenPMD_USE_...=...
cmake ../openPMD-api
make -j
# optional
make test
# sudo is only required for system paths
sudo make install
On Windows platforms, replace the last steps with:
cmake -G "NMake Makefiles" ../openPMD-api
nmake
nmake install