This is the parent repository of MOOSE simulator. It contains core (written in C++) of MOOSE, it's python scripting interface, and its graphical user interface (GUI) as git-submodules.

You can find detailed description of each MOOSE component in respective README.md in their repositories below:

• MOOSE with python support
• GUI
• Examples and Demos

MOOSE Packages

The easiest way of installing MOOSE on your system is to use pre-compiled packages.

Debian/Ubuntu

MOOSE has a PPA.

You can use it on Ubuntu 12.04, 14.04, 14.10, and 15.04.

Terminal

sudo -E add-apt-repository ppa:bhallalab/moose
sudo apt-get update
sudo apt-get install moose-python moose-gui

For more information on how to use PPA with package manager, see What are PPAs and how to use them

RPM/Fedora and others

There are packages for other distributions as well, especially Feodra, CentOS and OpenSuse. We are using Open Build Service to build these packages. Download and installation instructions can be found here.

Build and install using cmake

See the instructions here. Once all the listed dependencies are installed, you can use the following script to build and install MOOSE on your system.

cmake .
make 
sudo make install

Fine tuning build process

The cmake can be passed command line arguments to fine-tune the build process. For example, we don't build documentation by default. If you want to build documentation, use -DWITH_DOC=ON option as following:

$ cmake -DWITH_DOC=ON ..
$ make

Building documentation requires python-sphinx and doxygen. TODO: Document cmake options.

Uninstalling

To uninstall moose, run the following command in the same directory where you ran previous make install command.

sudo make uninstall

Reporting issues

Please report all build and packaging related issues here. For development issue, bugs and feature request, please use the respective repositories

• MOOSE C++ and python bindings
• PyQt GUI of MOOSE
• Example snippets and tutorial scripts