.. _amrex_doc_indx:

Welcome to AMReX's documentation
================================

AMReX is a software framework containing all the functionality needed to write
massively parallel, block-structured adaptive mesh refinement (AMR)
applications. AMReX is freely available `on GitHub
<https://github.com/AMReX-Codes/amrex>`_.

AMReX is a project of the `High Performance Software Foundation (HPSF)
<https://hpsf.io/>`_, which is part of the nonprofit `Linux Foundation
<https://www.linuxfoundation.org/>`_.

All of AMReX's development is done in the GitHub repository under the
development branch; anyone can see the latest updates. A monthly release is tagged at the beginning
of each month.

We are always happy to have users contribute to the AMReX source code. To
contribute, issue a pull request against the development branch (details `here
<https://help.github.com/articles/creating-a-pull-request/>`_).  Changes at any
level are welcome: documentation, bug fixes, new test problems, new solvers,
etc.  To obtain help, simply post a
`discussion <https://github.com/AMReX-Codes/amrex/discussions>`_
or an `issue <https://github.com/AMReX-Codes/amrex/issues>`_
on the AMReX GitHub webpage.

To learn AMReX, there are walk-through guides and small stand-alone example codes that
demonstrate how to use different parts of the AMReX functionality. Extensive documentation
is available at `AMReX Guided Tutorials and Example Codes`_.

.. _`AMReX Guided Tutorials and Example Codes`: https://amrex-codes.github.io/amrex/tutorials_html/

Besides this documentation, there is API documentation generated by `Doxygen
<https://amrex-codes.github.io/amrex/doxygen>`_.

Documentation on migration from BoxLib is available in the AMReX repository at Docs/Migration.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   Introduction
   GettingStarted_Chapter
   BuildingAMReX_Chapter
   Basics_Chapter
   ManagingGridHierarchy_Chapter
   AmrCore_Chapter
   AmrLevel_Chapter
   ForkJoin
   IO_Chapter
   LinearSolvers_Chapter
   Particle_Chapter
   Fortran_Chapter
   Python_Chapter
   EB_Chapter
   FFT_Chapter
   TimeIntegration_Chapter
   GPU_Chapter
   Visualization_Chapter
   Post_Processing_Chapter
   Debugging
   RuntimeParameters
   AMReX_Profiling_Tools_Chapter
   External_Profiling_Tools_Chapter
   External_Frameworks_Chapter
   Regression_Testing_Chapter
   Faq
   Governance

.. toctree::
   :maxdepth: 1
   :caption: API

The copyright notice for AMReX is included in the AMReX home directory
as ``README.md``.
Your use of this software is subject to the 3-clause BSD license; the license agreement is included in the
AMReX home directory as ``LICENSE``.

For a PDF version of this documentation, click :download:`here <amrex.pdf>`.