MOOSE Tools

The MOOSE code itself is written in C++, but everything around it that supports it is written in Python. Table 1 is a list of the tools/scripts developed in Python that are distributed with MOOSE and Python Source links to the source code documentation.

Table 1:

ToolDescription
TestHarnessTool testing that applications work correctly as code is developed.
Memory LoggerTool for gathering memory usage of a running process.
CSVDiff ToolTool for computing differences between comma separated value (CSV) files.
Method of Manufactured Solutions (MMS)Utilities for verifying solves with the method of manufactured solutions.
free_energy.pyTool for extracting MOOSE parsed function expressions from thermodynamic database files.
moosetreeTool for building and searching tree structures.
pyhitTool for reading, writing, and manipulating MOOSE input files.
Combine CSVTool for combining CSV files together.
MOOSE SQA ToolsTools for managing SQA documentation.
ReporterReaderTool for reading JSON output of Reporter data
Module Hash ToolTool for generating a hash suffix for our contribution modules.
MOOSE Documentation System (MooseDocs)Tool for creating documentation.
MooseControlTool for interacting with a WebServerControl

Setup

MOOSE includes various python packages within the python directory. In order to use these packages the python directory must be made available to the interpreter, which is accomplished by setting the PYTHONPATH environment variable. The following can be set on the command line or inserted into your bash environment.


export PYTHONPATH=$PYTHONPATH:~/projects/moose/python