Directory Structure

When cloning the scan from the github page you will obtain the following list of files and directories.

##Files ####Confix.xml This is a symbolic link to one of the configuration files in config/. You can change the configuration for the program by changing where this link points. ####COPYRIGHT This file contains the copyright information for the software. It should be distributed with each release. ####Config.xml This is a symbolic link pointing to a configuration that was used during testing. ####LICENSE This file contains the licensing information for the software. It should be distributed with any distribution or piece of the code. ####Makefile This is a GNU Makefile, and is responsible for compilation of the program. ####Makefile.obj An include file for the Makefile that defines all of the objects that will be built during compilation. ####README.md The README contains useful information about how to get started (such as making this documentation). It also contains information on who to contact with issues or questions. ####TODO The TODO contains exactly what you think. If you have suggestions, or tackle one of the projects in this directory please let us know! ####start.cmd This is a symbolic link to a script in the scripts directory to load a color map and start up a window for DAMM.

##Directories ####bananas/ This directory contains a test banana file that can be used as a template to use bananas with the scan code. ####config/ This directory contains some of the user contributed configuration files. These files contain all of the configuration information that is necessary to analyze data. For an example file, see XML Based Configuration File. ####doc/ This directory contains the Doxyfile, and the other files necessary for the generation of this documentation. Once the documentation has been generated it will be located in the sub directories: html/ and latex/ ####ide/ This is a directory that contains the files for use with the Code::Blocks IDE. ####include/ This directory contains all of the ".hpp" files. ####scan/ This directory contains all of the ".f" files. In principle, it is never necessary for a general user (or even a developer) to modify these files. ####scripts/ This directory contains useful scripts for using the program, either for the running of files, or scripts useful for the use of DAMM. ####src/ This directory contains all of the ".cpp" files.