.. _install-mfix-pip:

Pip Installation
----------------

As of MFiX 20.1, Python wheels are available for installation with Pip.
(Installation via the Conda packages will continue to be supported.)

The Pip package includes the MFiX GUI and the MFiX solver source. It does not
include a local copy of the `MFiX documentation
<https://mfix.netl.doe.gov/doc/mfix/latest>`__ or a binary version of the
solver. If you install MFiX with Pip, you will need to :ref:`build a solver yourself <build-custom>`.

The Pip package should work on any platform, so long you have Python, CMake, GNU
Make, and a Fortran compiler.


Install MFiX
""""""""""""

Make sure Python 3.7 or later is installed, either from your system package
manager or from `Python.org <https://www.python.org>`_.

    #.  Browse to `MFiX Download <https://mfix.netl.doe.gov/mfix/download-mfix>`__ (requires registration and login)
    #.  Go to the Source tab
    #.  Download either the source tarball or the wheel (``*.whl``) file.
    #.  Install the downloaded file with pip.

.. code-block:: bash
    :substitutions:

    > python3 -m pip install mfix-|version|.tar.gz
    #  <or>
    > python3 -m pip install mfix-|version|-py3-none-any.whl


MFiX runs the same whether installed from a source tarball or wheel. The source
tarball is better for looking at the source. The wheel file installs slightly
faster.

.. warning:: The install command assumes your intended Python command is
             ``python``. If ``python`` on your system is Python 2.x or for any
             other reason is not your intended Python version, then edit the
             pasted command in your shell to start with ``python3``,
             ``python3.8``, or whatever the full path is to your intended Python
             distribution to remove any uncertainty.


.. _install-build-dependencies-pip:

Install Solver Build Dependencies (optional)
""""""""""""""""""""""""""""""""""""""""""""

The MFiX wheel is a pure Python package, and does not include a solver binary. To actually run the solver, you will need:

    - Fortran 2003 compiler (GFortran 4.8 or later recommended)
    - GNU Make
    - CMake
    - For DMP support, an MPI implementation (such as OpenMPI)

Installing the compiler, CMake, and Make through your system package manager
(such as ``apt`` or ``yum``) is recommended.

.. note:: If your system package manager has an old version of CMake, you can
          install a recent version with ``python -m pip install cmake``.

On Windows, the `Scoop <https://scoop.sh>`__ tool can be used to install build
dependencies for MFiX.

    .. code-block:: batch

        > scoop install gcc  # install full MinGW installation, including MinGW Make
        > scoop install cmake

.. _run-pip:

Run MFiX
""""""""

To run MFiX:

    #.  Open a terminal
    #.  Run ``mfix⏎`` to start MFiX

You are now ready to proceed to the :ref:`user-guide` and :ref:`tutorials`.

Uninstall MFiX
""""""""""""""

To uninstall MFiX:

.. code-block:: bash

    > pip uninstall mfix