Pre-Built MOOSE

Install Conda

Follow the steps below depending on your platform to install Miniforge. If you run into issues during these steps, please visit our Conda Troubleshooting guide.

• Linux Users:

  
  curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
  bash Miniforge3-Linux-x86_64.sh -b -p ~/miniforge
  

• Macintosh Users with Intel processors:

  
  curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-x86_64.sh
  bash Miniforge3-MacOSX-x86_64.sh -b -p ~/miniforge
  

• Macintosh Users with Apple Silicon processors:

  
  curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh
  bash Miniforge3-MacOSX-arm64.sh -b -p ~/miniforge
  

With Miniforge installed in your home directory, export PATH so that it may be used:

export PATH=$HOME/miniforge/bin:$PATH

Now that we can execute conda, initialize it and then exit the terminal:

conda init --all
exit

Upon restarting your terminal, you should see your prompt prefixed with (base). This indicates you are in the base environment, and Conda is ready for operation:

$ (base) ~>

The next thing you should do after a fresh install, is perform an update to the base Conda environment:

conda update --all --yes

Add INL's public channel to gain access to INL's Conda package library:

conda config --add channels https://conda.software.inl.gov/public

Install MOOSE

conda create -n moose moose

After the installation completes, activate the new environment:

conda activate moose

Verify moose is available:

moose --help

Should produce the help page. This simple command demonstrates that you have successfully installed the MOOSE Conda package.

Run an Example

You may query the executable for the available inputs with the following:

moose-opt --show-copyable-inputs

which will show something like this:

The following directories are installable into a user-writeable directory:

chemical_reactions combined contact electromagnetics external_petsc_solver fluid_properties framework fsi functional_expansion_tools geochemistry heat_transfer level_set misc navier_stokes optimization peridynamics phase_field porous_flow ray_tracing rdg reactor reactor_tutorial richards scalar_transport solid_mechanics solid_properties stochastic_tools tensor_mechanics thermal_hydraulics xfem

To install one or more directories of inputs, execute the binary with the "--copy-inputs" flag. e.g.:
$ moose-opt --copy-inputs chemical_reactions

For now, lets copy heat_transfer into a safe location for editing:

mkdir -p ~/projects/examples
cd ~/projects/examples
moose-opt --copy-inputs heat_transfer
  <output trimmed>
Directory successfully copied into ./moose/heat_transfer/

With heat_transfer's examples and inputs copied, move into the heat_transfer directory and instruct moose to run the tests:

cd ./moose/heat_transfer
moose-opt --run -j 6

Testing will commence and take a few moments to finish. There may be several skipped tests for one reason or another. This is normal. However none of the tests should fail.

Next, we will run a single input file manually, to demonstrate how you will ultimately use moose-opt. Peruse the subdirectories and find an input file you wish to run:

# be sure to be in the heat_transfer's directory
find . -name '*.i'

# cd into the directory containing the input file you wish to run
moose-opt -i <the input file you chose>.i --mesh-only

You will see some information scroll by, and ultimately end back at your prompt. If you perform a directory listing (ls) you should see an exodus file was generated in the process (a file with the same input filename but with _in.e suffix).

Viewing Results

The easiest solution is to open two terminal windows. While in one, you have moose activated. While in the other, you have paraview activated. Open a new terminal window now, and create the new paraview environment:

conda activate base # just in case you have `moose` auto-activating
conda create -n paraview paraview
conda activate paraview

With paraview installed, you can now open <the input file you chose>_in.e with the following command:

paraview <the input file you chose>_in.e

More Examples