Installation
Step One: Install Conda MOOSE Environment
In order to install MALAMUTE, the MOOSE developer environment must be installed. The installation procedure depends on your operating system, so click on the MOOSE website link below that corresponds to your operation system/platform and follow the instructions to the conda installation step named "Cloning MOOSE". Then, return to this page and continue with Step Two.
Advanced manual installation instructions for this environment are available via the MOOSE website.
If an error or other issue is experienced while using the conda environment, please see the MOOSE troubleshooting guide for Conda
Step Two: Clone MALAMUTE
MALAMUTE is hosted on GitHub, and should be cloned directly from there using git. As in the MOOSE directions, it is recommended that users create a directory named "projects" to put all of your MOOSE-related work.
To clone MALAMUTE, run the following commands in Terminal:
mkdir ~/projects
cd ~/projects
git clone [email protected]:idaholab/malamute.git
cd malamute
git checkout main
This guide assumes you have setup SSH with your GitHub account. If the git clone command above was not successful on your machine, you have the option of cloning via HTTPS using the following command:
git clone https://github.com/idaholab/malamute.git
which is sufficient if you only need to clone MALAMUTE on your local machine and do not intend to git push back to GitHub to save developed MALAMUTE code. If you do intend to push code to GitHub, we recommend you review the "About remote repositories" page on GitHub to learn how to setup a Personal Access Token for git push with HTTPS.
This sequence of commands downloads MALAMUTE from the GitLab server and checks out the "main" code branch. There are two code branches available:
"main", which is the current most-tested version of MALAMUTE for general usage, and
"devel", which is intended for code development (and may be more regularly broken as changes occur in MALAMUTE and MOOSE).
Developers wishing to add new features should create a new branch for submission off of the current "devel" branch.
Step Three: Build and Test MALAMUTE
To compile MALAMUTE, first make sure that the conda MOOSE environment is activated (and be sure to do this any time that a new Terminal window is opened):
conda activate moose
Then navigate to the MALAMUTE clone directory and download the MOOSE submodule:
cd ~/projects/malamute
git submodule update --init moose
The copy of MOOSE provided with MALAMUTE has been fully tested against the current MALAMUTE version, and is guaranteed to work with all current MALAMUTE tests.
Once all dependencies have been downloaded, MALAMUTE can be compiled and tested:
make -j8
./run_tests -j8
The -j8 flag in the above commands signifies the number of processor cores used to build the code and run the tests. The number in that flag can be changed to the number of physical and virtual cores on the workstation being used to build MALAMUTE.
If MALAMUTE is working correctly, all active tests will pass. This indicates that MALAMUTE is ready to be used and further developed.
Troubleshooting
If issues are experienced in installation and testing, several resources are available:
What next?
With installation and testing complete, proceed to Using MALAMUTE.