.. _start-install:


Install Guide
=============

To use Nodeworks as a plugin to MFiX, MFiX needs to be installed first, using
the `MFiX install instructions`_. Once MFiX is installed successfully, install
Nodeworks in the created MFiX environment by first activating the environment
with::

  activate mfix-20.2

Next install Nodeworks by:

  - Browse to the `Nodeworks Download Page`_
  - Copy the conda install command. The conda command will look similar to this,
    but with your own individual username and hexadecimal token (please do not
    share these unique tokens)::

     conda install nodeworks -c mfix -c https://mfix.netl.doe.gov/s3/HEX/HEX/conda/dist

  - Paste the conda install command into your Linux or Mac terminal, or into your
    `Anaconda Prompt` on Windows and Execute the install command.

The installation will download other dependencies and Nodeworks. The process
will take a few minutes to complete. Once completed, the application can be
started by entering the following command into your Linux or Mac terminal, or
into your `Anaconda Prompt` on Windows::

  nodeworks

Or, you can run MFiX and the `Nodeworks` mode will be enabled. Clicking the
`Nodeworks` mode button will take you to the Nodeworks environment embedded
inside MFiX.

.. Note::
  You can install both `mfix` and `nodeworks` at the same time with::

   conda install mfix nodeworks -c mfix -c https://mfix.netl.doe.gov/s3/HEX/HEX/conda/dist

.. _`MFiX install instructions`: https://mfix.netl.doe.gov/doc/mfix/latest/getting_started/index.html
.. _`Nodeworks Download Page`: https://mfix.netl.doe.gov/mfix/download-nodeworks