Directory Structure

#Introduction This information is valid for the dev branch only.

#Files ##.gitignore This is the ignore file for git. It contains all of the types of files that we are not going to keep track of.

##CMakeLists.txt This is the main file that cmake uses when building. There is a CMakeLists .txt file in a lot of the folders that we have. We will not go in to depth about each one.

##COPYRIGHT This file contains the copyright information for the software. It should be distributed with each release.

##LICENSE This file contains the licensing information for the software. It should be distributed with any distribution or piece of the code.

##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.

#Directories Each of these directories will contain one or more sub-directories. Sub-directories that contain a source and include folder are where you will find the source code for the various programs and classes.

##Acquisition This folder contains programs and classes that are used to interface with the Pixie-16 modules.

###Interface Contains classes that are used by all of the acquisition software to interface with the Pixie-16 modules.

###MCA Contains classes related to the use of the MCA program.

###Poll Contains the main polling program.

###PxiDump A misnamed directory that contains the set2root program.

###Setup Contains programs that were built with the original PixieSuite software. ####Traces Contins scripts that are useful for looking at traces from Pixie-16 modules.

##Analysis This folder contains classes and programs that are used to analyze data taken from the Pixie-16 modules. ###Resources Contains resources that are useful across all of the analysis programs.

###ScanLibraries Contains core libraries used by all of the analysis programs.

###Scanor This contains the source code necessary to compile the analysis software with the HRIBF libraries.

###Utilities This contains analysis related utility programs such as scope.

###Utkscan This is the main analysis program. ####analyzers This contains classes that are related to trace analysis. ####core Contains classes related to core functionality of utkscan, along with the main program. ####experiment Contains classes that are used for experiment specific data processing. ####processors Contains classes that provide basic functionality for various detector types..
####share/utkscan Contains user submitted configuration files, banana gates for DAMM and scripts that are useful for running the program.

##Cmake/modules Contains modules that are used by cmake to find packages that are necessary for compilation of the programs.

##Core Contains classes that are useful to many different programs. Examples include the CTerminal and hribf_buffers.

##Doc This directory contains the Doxyfile. Doxygen generated documentation will appear in the html/ sub-folder. ###pages Contains doxygen related pages that are not automatically generated. ###pics Contains pictures that are referenced in the doxygen documentation.

##Resources Contains source code for various classes, functions, enumerations, constants, etc. that will be useful in multiple places in the software.

##Share ###modulefiles Contains modulefiles to be used with the environment-modules package. ###plx Files related to the automatic loading of PLX drivers with either init.d or systemd. Most modern systems use systemd. ####init.d Scripts for loading PLX with init.d. ####systemd Scripts for loading PLX with systemd.

##ThirdParty This folder contains all of the Third Party software that is compiled with our programs.