diff --git a/docs/source_docs/user_guide/quick-start.rst b/docs/source_docs/user_guide/quick-start.rst index 0fafc9e2867e18ac32357b598839a9d5dc8832f7..d2fc66237668b9d49a5fa571782eff4ee3952539 100644 --- a/docs/source_docs/user_guide/quick-start.rst +++ b/docs/source_docs/user_guide/quick-start.rst @@ -3,18 +3,15 @@ Getting Started =============== -The MFIX-Exa source code currently lives in NETL's -`gitlab repository `_. The repository -can be cloned by using git: - -.. code-block:: shell - - > git clone https://mfix.netl.doe.gov/gitlab/exa/mfix.git +The MFIX-Exa source code is periodically released publicly as a tarball through +`the website `_. Please visit the +`download page `_ +for instructions on downloading and unzipping the code. .. note:: - Access to the repository is currently restricted to project members. As the - code matures, a distribution mechanism will be developed. + 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. @@ -26,7 +23,6 @@ the simulations results. .. toctree:: :maxdepth: 1 - :caption: FUCK THIS: :hidden: Building MFIX-Exa diff --git a/docs/source_docs/user_guide/quick_start/BuildingMFIX.rst b/docs/source_docs/user_guide/quick_start/BuildingMFIX.rst index 9bb7a96e5dbf888ea12138ecc9bf74524f0dec62..d8ddb2df91e7e9d29fa52d7e069257cd2fa14cfb 100644 --- a/docs/source_docs/user_guide/quick_start/BuildingMFIX.rst +++ b/docs/source_docs/user_guide/quick_start/BuildingMFIX.rst @@ -2,6 +2,9 @@ Building MFIX-Exa ================== This page gives the generic instructions for building MFIX-Exa using gmake and cmake. +The instructions assume you have already downloaded and unpacked the MFIX-Exa code +into a local ``mfix`` directory. If not, please visit the +`download page `_ first. For HPC cluser specific instructions, please refer to :ref:`GettingStarted:HPC`. @@ -9,14 +12,12 @@ Building 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: +clone amrex and AMReX-Hydro into a local directories: .. 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) @@ -128,8 +129,7 @@ Assuming no valid AMReX installation is present on the target system, and ``AMRe .. code:: shell - > git clone http://mfix.netl.doe.gov/gitlab/exa/mfix.git - > cd mfix + > cd mfix/ > mkdir build > cd build > cmake [mfix options] [amrex options] -DCMAKE_BUILD_TYPE=[Debug|Release|RelWithDebInfo|MinSizeRel] .. @@ -241,7 +241,7 @@ Clone and build MFIX-Exa: .. code:: shell - > git clone http://mfix.netl.doe.gov/gitlab/exa/mfix.git + > cd mfix/ > mkdir build > cd build > cmake -DCMAKE_BUILD_TYPE=[Debug|Release|RelWithDebInfo|MinSizeRel] [mfix options] -DAMReX_ROOT=/absolute/path/to/amrex/installdir ..