Users

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:

Using the Conda Package

A package for pyAMReX is available via the Conda package manager.

Tip

We recommend to configure your conda to use the faster libmamba dependency solver.

conda update -n base conda
conda install -n base conda-libmamba-solver
conda config --set solver libmamba

We recommend to deactivate that conda self-activates its base environment. This avoids interference with the system and other package managers.

conda config --set auto_activate_base false

conda create -n pyamrex -c conda-forge pyamrex
conda activate pyamrex

Note

The pyamrex conda package does not yet provide GPU support.

Using the Spack Package

Note

Coming soon.

Using the PyPI Package

Note

Coming soon.

Using the Brew Package

Note

Coming soon.

From Source with CMake

After installing the pyAMReX dependencies, you can also install pyAMReX from source with CMake:

# get the source code
git clone https://github.com/AMReX-Codes/pyamrex.git $HOME/src/pyamrex
cd $HOME/src/pyamrex

# configure
cmake -S . -B build

# optional: change configuration
ccmake build

# compile & install
#   on Windows:          --config Release
cmake --build build -j 4 --target pip_install

We document the details in the developer installation.

Tips for macOS Users

Tip

Before getting started with package managers, please check what you manually installed in /usr/local. If you find entries in bin/, 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.