Framework Code Directory Structure

From MantidProject

The Mantid Framework Code directory is structured as follows:

Directory	Description
Mantid	Top level Directory
Algorithms	Algorithms sub project directory (The same subdirectorires are present for all sub projects). This contains standard data reduction algorithms.
inc	Code Header Files (.h)
src	Code Source Files (.cpp)
test	Unit test code files (.h)
API	API sub project directory. This contains the main classes that are exposed through the API.
Build	Build script directory. Principally used by the Build Servers.
Plugins	Scons builds the UserAlgorithms library, which is used in the unit tests, to here.
Tests	Build location for unit tests built by Scons.
DataHandling	DataHandling sub project directory. This contains data handling commands to load and save various data formats.
DataObjects	DataObjects sub project directory. This contains concrete implmentations of data objects used in Mantid.
debug	Debug build directory.
Geometry	Geometry sub project directory. This code to detail the location and structure of objects within an instrument.
Kernel	Kernel sub project directory. This contains basic framework elements that are used by all of the sub projects.
Main	Main sub project directory. This contains a main entry point and compiles to a .exe, This contains benchmark code and temporary debugging scripts.
PythonAPI	PythonAPI sub project directory. A specialized API for Python bindings.
Properties	Location of the properties files used for release purposes.
release	Release (default) build directory.
UserAlgorithms	UserAlgorithms sub project directory. This contains example algorithms as a starting point for users.