.. _Chap:GettingStarted:

Getting Started
===============

The MFIX-Exa source code is periodically released publicly as a tarball through 
`the website <https://mfix.netl.doe.gov/products/mfix-exa/>`_.  Please visit the 
`download page <https://mfix.netl.doe.gov/products/mfix-exa/download/>`_ 
for instructions on downloading and unzipping the code.  

.. note::

   Please register as a member of NETL's Multiphase Flow Science website to 
   view the download instructions. 

MFIX-Exa is also dependent on the AMReX and AMReX-Hydro git repositories.
For cmake builds these repositories may be cloned as part of the configuration.
Details are included in the sections below.

Once you have obtained the source code, the following sections describe the
source code contents, compiling, running a simple simulation, and visualizing
the simulations results.

.. toctree::
   :maxdepth: 1
   :hidden:

   Building MFIX-Exa <quick_start/BuildingMFIX>
   Running your first simulation <quick_start/FirstSimulation>
   Visualizing results <quick_start/Visualization>
