Python

These examples show how to use AMReX from Python, via pyAMReX. AMReX applications can also be interfaced to Python with the same logic.

Installation

In order to run the Python tutorials, you need to have pyAMReX installed. Please see the pyAMReX documentation for installation details.

Alternatively, you can build the ExampleCodes in this repository with -DTUTORIAL_PYTHON=ON added to the CMake configuration options, then install with cmake --build build --target pyamrex_pip_install, and pyAMReX will be installed for you.

Running

Python tutorials are written so they run the same way as their C++ counterparts: command line arguments after the script name are forwarded to AMReX, so an inputs file and key=value overrides can be passed as usual:

python3 main.py inputs

# with runtime parameter override(s)
python3 main.py inputs nsteps=20

# MPI-parallel
mpiexec -n 2 python3 main.py inputs

Tutorials

Guided tutorials:

  • MultiFab: define, fill and plot a MultiFab

  • Heat Equation: explicit heat equation solve with ghost cell exchanges and runtime parameters (run with inputs)

Example codes: