.. _install-mfix-windows:

Windows Installation
--------------------

MFiX has been developed and tested on the following Windows versions:

    - Windows 10 (64-bit)

If you have an issue running MFiX works on your system, ask for help at
:ref:`support-forum`.

Install Anaconda
""""""""""""""""

**Download** the 64-bit, Python 3, Windows version of `Anaconda
<https://www.anaconda.com/products/individual>`__ (~500 MB download) or `Miniconda
<https://docs.conda.io/en/latest/miniconda.html>`__ (~50 MB download).

For instance, with the Anaconda installer:

    #.  Double-click on the downloaded file. (At the time of this writing,
        ``Anaconda3-2020.02-Windows-x86_64.exe``)
    #.  **Uncheck** "Add Anaconda to my PATH environment variable"
    #.  **Check** "Register Anaconda as my default Python"

Anaconda is now installed. To verify, open the Start Menu, and run ``Anaconda
Prompt⏎``.


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

After installing Anaconda, install MFiX with the following steps:

    #.  Open the Anaconda Prompt (Start Menu, type anaconda, enter)
    #.  Browse to `MFiX Download <https://mfix.netl.doe.gov/mfix/download-mfix>`__ (requires registration and login)
    #.  Copy the conda command.
    #.  Paste it in the Anaconda Prompt and hit enter.

.. note:: If you already installed MFiX, you may see the following message. Select ``y`` to confirm.

          .. code-block:: batch

              WARNING: A conda environment already exists
              Remove existing environment (y/[n])? y

MFiX will be installed in a new conda environment. The process will take a few
minutes to complete.


.. _create-environment-windows:

Run MFiX
""""""""

Open the Anaconda prompt by opening the Start Menu, type "Anaconda Prompt", and
selecting the Anaconda Prompt. Then run the following commands:

    #.  Run |conda_act_inline|
    #.  Run ``mfix⏎``

Your prompt should look something like this:

.. code-block:: batch
      :substitutions:

      C:\> conda create -n mfix-|version| mfix=|version| -c https://mfix.netl.doe.gov/....

      C:\> conda env list
      # conda environments:
      #
      base        *  C:\Users\user\anaconda3
      mfix-|version|      C:\Users\user\anaconda3\envs\mfix-|version|

      C:\> conda activate mfix-|version|

      C:\(mfix-|version|)> conda env list
      # conda environments:
      #
      base           C:\Users\user\anaconda3
      mfix-|version|   *  C:\Users\user\anaconda3\envs\mfix-|version|

      C:\> mfix

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


Deactivate Conda Environment
""""""""""""""""""""""""""""

After using MFiX you can just ``exit`` to leave the Anaconda Prompt. However, if
you need to deactivate the |conda_env_inline| conda environment, you can do so with:

.. code-block:: batch
    :substitutions:

    C:\(mfix-|version|)> deactivate
    C:\>

This returns to the base conda environment.


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

To uninstall MFiX from a conda environment:

.. code-block:: batch
    :substitutions:

    C:\(mfix-|version|)> conda uninstall mfix

To remove the conda environment (if you have the environment activated,
deactivate it first):

.. code-block:: batch
    :substitutions:

    C:\(mfix-|version|)> conda deactivate
    C:\> conda env remove -n mfix-|version|

To uninstall Anaconda entirely, go to "Add or remove programs" under Windows
Control Panel, and uninstall Anaconda.

.. note::

    To learn more about managing conda environments, visit the `conda documentation
    <https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`__ .