Unverified Commit 23e7a640 authored by William Fullmer's avatar William Fullmer Committed by GitHub
Browse files

Merge pull request #26 from drangara/hpc_build_instructions 

HPC specific build instructions
parents 1fa031e9 065ff577

.github/workflows/build.yml

+1 −1
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ jobs: 
        run: sudo apt install doxygen



      - name: Install Sphinx

        run: pip install sphinx sphinx-rtd-theme

        run: pip install sphinx sphinx-rtd-theme sphinx-tabs



      - name: Checkout code

        uses: actions/checkout@v2

README.md

+2 −2
Original line number Diff line number Diff line
@@ -21,14 +21,14 @@ can be built locally by: 
1. Install sphinx:



```shell

> pip install sphinx sphinx_rtd_theme

> pip install sphinx sphinx_rtd_theme sphinx-tabs

```



2. Build the documentation:



```shell

> mkdir build

> sphinx-build -b html docs/source/ build

> sphinx-build -b html docs/source_docs/ build

```



The HTML pages will now be located in the `build` directory. Open the

docs/source_docs/GettingStarted_Chapter.rst

+2 −3
Original line number Diff line number Diff line
@@ -27,8 +27,7 @@ the simulations results. 
.. toctree::

   :maxdepth: 1



   Source directory overview <getting_started/Structure>

   Compiling with gmake <getting_started/BuildingGMake>

   Compiling with cmake <getting_started/BuildingCMake>

   Building MFIX-Exa <getting_started/BuildingMFIX>

   Running your first simulation <getting_started/FirstSimulation>

   Visualizing simulation results <getting_started/Visualization>

   HPC <getting_started/Hpc>

docs/source_docs/conf.py

+2 −1
Original line number Diff line number Diff line
@@ -33,7 +33,8 @@ import sphinx_rtd_theme 
# ones.

extensions = ['sphinx.ext.mathjax',

              'sphinx.ext.githubpages',

              'sphinx.ext.viewcode']

              'sphinx.ext.viewcode',

              'sphinx_tabs.tabs']



# Add any paths that contain templates here, relative to this directory.

templates_path = ['ytemplates']

docs/source_docs/getting_started/BuildingGMake.rst

deleted100644 → 0
+0 −66
Original line number Diff line number Diff line 
Building MFIX-Exa with gmake

============================



If you want to use gmake to build MFIX_Exa, you will need to

clone amrex and AMReX-Hydro into a local directories, and also

clone mfix:



.. code:: shell



    > git clone https://github.com/AMReX-Codes/amrex.git

    > git clone https://github.com/AMReX-Codes/AMReX-Hydro.git

    > git clone http://mfix.netl.doe.gov/gitlab/exa/mfix.git

    > cd mfix/exec



Then, edit the GNUmakefile (or set an environment variable)

to define AMREX_HOME and AMREX_HYDRO_HOME

to be the path to the directories where you have put amrex

and AMReX-Hydro.  Note that the default locations of

AMREX_HOME and AMREX_HYDRO_HOME are in the subprojects directory,

which is where a cmake configuration may clone these repositories.

Other options that you can set include



+-----------------+----------------------------------+------------------+-------------+

| Option name     | Description                      | Possible values  | Default     |

|                 |                                  |                  | value       |

+=================+==================================+==================+=============+

| COMP            | Compiler (gnu or intel)          | gnu / intel      | gnu         |

+-----------------+----------------------------------+------------------+-------------+

| USE_MPI         | Enable MPI                       | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| USE_OMP         | Enable OpenMP                    | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| USE_CSG         | Enable CSG geometry file support | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| USE_CUDA        | Enable CUDA GPU support          | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| USE_HIP         | Enable HIP GPU support           | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| USE_DPCPP       | Enable DPCPP GPU support         | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| USE_HYPRE       | Enable HYPRE support             | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| DEBUG           | Create a DEBUG executable        | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| PROFILE         | Include profiling info           | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| TRACE_PROFILE   | Include trace profiling info     | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| COMM_PROFILE    | Include comm profiling info      | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| TINY_PROFILE    | Include tiny profiling info      | TRUE / FALSE     | FALSE       |

+-----------------+----------------------------------+------------------+-------------+

| DIM             | Dimensionality of problem        | 2 / 3            | 3           |

+-----------------+----------------------------------+------------------+-------------+



.. note::

   **Do not set both USE_OMP and USE_CUDA/HIP/DPCPP to true.**



Then type



.. code:: shell



    > make -j



An executable will appear; the executable name will reflect

some of the build options above.