Install Moltres

1. Install the Conda MOOSE Environment

Moltres relies on the MOOSE framework. We suggest that users install the latest MOOSE environment using Conda packages by following the instructions in the "Conda MOOSE Environment" and "Install MOOSE" sections of the MOOSE installation guide. We cannot guarantee compatibility with older MOOSE builds and their corresponding Conda environments. The latest MOOSE Conda environment is usually compatible unless the MOOSE team introduces significant changes to the dependencies. We encourage you to post a GitHub issue if you encounter compatibility issues so that we can rectify it as soon as possible.

2. Clone Moltres

The Moltres GitHub repository already contains MOOSE and Squirrel as Git submodules, therefore there is no need to clone and compile MOOSE separately.

Abiding by MOOSE's instructions for setting up a projects directory for MOOSE-related content, users can clone Moltres and download MOOSE as a submodule by running the commands:

mkdir ~/projects
cd ~/projects
git clone https://github.com/arfc/moltres.git
cd moltres
git checkout master
git submodule init
git submodule update

3. Compile and Test Moltres

Before proceeding with this step, check that the Conda MOOSE environment is activated in your current terminal. This is achieved by running the following command every time you open a new terminal:

conda activate moose

Finally, compile Moltres and run tests to check your installation using the following commands:

make -j8
./run_tests -j8

If you encounter any problems with installation, please post on our GitHub Discussions page along with the full error message so that we can help you troubleshoot your installation.

4. Running Moltres Simulations

If you have successfully completed the previous step, you should have a moltres-opt executable in the ~\projects\moltres directory. To run a Moltres input file, use the following command:

~/projects/moltres/moltres-opt -i input-file.i

To run an input file on more than one processor, use the mpirun command as follows:

mpirun -n 8 ~/projects/moltres/moltres-opt -i input-file.i

As above, replace 8 with the number of processors available on your machine.