Our community is here to help. Please report installation problems in case you should get stuck.
Choose one of the installation methods below to get started:
If want to use ImpactX on a specific high-performance computing (HPC) systems, jump directly to our HPC system-specific documentation.
Using the Conda Package
A package for ImpactX is available via the Conda package manager.
conda create -n impactx -c conda-forge impactx conda activate impactx
impactx conda package does not yet provide GPU support.
Using the Spack Package
Using the PyPI Package
Using the Brew Package
From Source with CMake
After installing the ImpactX dependencies, you can also install ImpactX from source with CMake:
# get the source code git clone https://github.com/ECP-WarpX/impactx.git $HOME/src/impactx cd $HOME/src/impactx # configure cmake -S . -B build # optional: change configuration ccmake build # compile # on Windows: --config Release cmake --build build -j 4 # executables for ImpactX are now in build/bin/
We document the details in the developer installation.
Tips for macOS Users
Before getting started with package managers, please check what you manually installed in
If you find entries in
lib/ et al. that look like you manually installed MPI, HDF5 or other software in the past, then remove those files first.
If you find software such as MPI in the same directories that are shown as symbolic links then it is likely you brew installed software before.
If you are trying annother package manager than
brew, run brew unlink … on such packages first to avoid software incompatibilities.
See also: A. Huebl, Working With Multiple Package Managers, Collegeville Workshop (CW20), 2020