Getting Started

First you need to install the MOOSE framework. To do this, click the link below corresponding to your operating system/platform and follow the instructions:

When installation is complete, return to this page to continue.

Create an Application

MOOSE is designed for building custom applications, therefore if you plan on working with MOOSE then you should create an application.

Your application is where code and input files should be created for your particular problem.

To create an application, run the stork.sh script while sitting outside the MOOSE repository with a single argument providing the name you wish to use to name your application:


cd ~/projects
./moose/scripts/stork.sh YourAppName

Running this script will create a folder named "YourAppName" in the projects directory, this application will automatically link against MOOSE. Obviously, the "YourAppName" should be the name you want to give to your application; consider the use of an acronym. We prefer animal names for applications, but you are free to choose whatever name suits your needs.

note

You should not attempt to run this script while sitting inside the MOOSE repository. Doing so will result in an error.

Compile and Test Your Application


cd ~/projects/YourAppName
make -j4
./run_tests -j4

If your application is working correctly, you should see one passing test. This indicates that your application is ready to be further developed.

Learn More

Now that you have a working MOOSE Framework stack, there are several examples you can peruse to familiarize yourself with the components of the input file. The input file is what you will use to build problems for your Application (and MOOSE) to solve.

Join the Community

Join one of our mailing lists:

GMail users can just click the "Join group" button. Everyone else can join by sending an email to:

  • moose-users+subscribe@googlegroups.com

  • moose-announce+subscribe@googlegroups.com

You may also want to follow MOOSE developers on Twitter:

Troubleshooting

Please see our FAQ page for common issues. If your issue is not listed among our FAQs, this would be an excellent time to join us on our mailing list and ask for help!