Documentation

AMReX documentation

Start with the AMReX user documentation, follow guided tutorials for common workflows, or jump into the Doxygen API reference for detailed source-level documentation.

Resources

Documentation links

User Documentation

Read the Sphinx user guide for AMReX concepts, build instructions, runtime parameters, solvers, I/O, GPUs, particles, embedded boundaries, and other core topics.

Open user documentation

Tutorials

Work through Sphinx tutorials covering basic AMReX usage, AMR examples, GPU programming, particles, embedded boundaries, linear solvers, FFTs, and related workflows.

Open tutorials

Doxygen API Reference

Browse generated Doxygen documentation for AMReX classes, files, namespaces, functions, and source-level API details.

Open API reference