2.1. Setup Guide

This section explains how to install binary packages for MFiX.

2.1.1. Register

MFiX is an open-source multiphase flow solver and is free to download and use. A one-time no-cost registration is required prior to downloading the software. To register, go to https://mfix.netl.doe.gov/register and submit your account information. Your application will be manually been reviewed and accepted, so please allow for 2-3 business days for your registration to be processed. You will receive a confirmation email when you can login.

Potential users may find reviewing the Frequently Asked Questions section of the MFiX website useful before downloading the code.

2.1.2. OS Support

MFiX has been developed and tested on the following operating systems:

  • Linux
    • Ubuntu 17.10
    • openSUSE 10.4
    • openSUSE Leap 42.2
  • macOS
    • 10.13 (latest)
  • Windows
    • Windows 7
    • Windows 10

Other recent releases of Linux and macOS are likely to work. MFiX has not been tested on Windows 8, but it is likely to work there as well. If you find MFiX works on other platforms, please report your experiences to Mailing List.

2.1.3. Prerequisites

The MFiX GUI requires an installation of Python. The Anaconda distribution of Python is the recommended way of installing MFiX. For information on installing MFiX in other Python environments, see Building/installing with setuptools.

If Python isn’t available, the MFiX solver can still be used from a source tarball (as in previous releases). See Build from Source (for Developers) and Batch Solver.

2.1.3.1. Install Miniconda

Download Miniconda or Anaconda for your platform (Linux, macOS, or Windows).

Note

Miniconda is a minimalist version of Anaconda with no packages installed by default, and is therefore a smaller initial download.

The 64-bit version is required.

The Python 3.6 version is required.

Note

MFiX 17.3 no longer supports Python 2. If you have any issues using Python 3 with MFiX on your platform, notify the developer team via the mailing list.

Install Miniconda/Anaconda,

On Mac/Linux, add the conda bin directory to your PATH at the end of the install. Restart your shell and run conda to check that it’s in your PATH.

On Windows, use the default settings during installation. You can leave
“Add Anaconda to my PATH environment variable” unchecked and “Register Anaconda as my default python 3.6” checked. You can skip the “Learn more about Anaconda cloud”. After installation, under the Start Menu, type “Anaconda Prompt”, select the Anaconda Prompt to open the Anaconda prompt. The prompt will be used to enter commands to install additional dependencies and to install mfix.

2.1.3.2. Installing Build Dependencies

Note

If you just want to try MFiX and run tutorial cases with the default solver, you can skip installing a compiler.

You need a compiler installed to build the MFiX solver if you:

If you’re using a cluster, you probably have a compiler installed already. Contact your system administrator.

Currently only GNU Fortran (gfortran) compiler is supported. Other Fortran compilers may be supported in the future.

Building the MFiX solver requires:

  • GNU GCC/GFortran (other compilers may be supported in the future)
  • GNU Make
  • CMake (will be installed as a conda dependency)
  • An MPI implementation if you want to use DMP (mainly tested with OpenMPI)

2.1.3.2.1. Linux

To install these dependencies on Ubuntu Linux:

> sudo apt install gcc gfortran make g++
> sudo apt install libopenmpi-dev openmpi-bin # For DMP

You may need to enable the “Universe” repository:

> sudo add-apt-repository universe
> sudo apt-get update

For other Linux distributions, consult your distribution documentation or contact your system administrator.

2.1.3.2.2. macOS

On Mac, installing the conda package will install a conda GCC and GNU Make packages.

To install these dependencies manually (probably not needed unless you are an MFiX developer), run the following command in the Terminal:

> conda install gcc make

DMP/MPI on Mac is not supported.

2.1.3.2.3. Windows

On Windows, installing the conda package will install MinGW, a minimalist GCC compiler for Windows.

To install this dependency manually (probably not needed unless you are an MFiX developer), run the following command in the Anaconda prompt:

C:\> conda install m2w64-toolchain

Note

MFiX 17.1 and 17.2 depended on MSYS2 (in addition to MinGW), but 17.3 not longer needs a bash environment to build on Windows. However, if you are used to the Unix command line, you may find it convenient to install MSYS2 with conda install m2-base.

DMP/MPI on Windows is not supported.

2.1.4. Install MFiX

  • Browse to the MFiX Download (requires registration)

  • Copy the conda install command

  • Paste the conda install command into your Linux or Mac terminal, or into your Anaconda Prompt on Windows

    The conda command will look similar to this, but with your own individual username and hexadecimal token:

    conda_install

  • Execute the install command

The installation will download other dependencies and MFiX. The process will take a few minutes to complete. When it finishes, you can now proceed to ready to proceed to Getting Started!

2.1.5. Update MFiX

If MFiX is already installed, the conda install command in Install MFiX will update to the latest version.

2.1.6. Uninstall MFiX

To uninstall MFiX, use the following command:

> conda uninstall mfix