Directory Structure
This page provides a brief explanation of the directory structure. It helps users understand where to find what they're looking for (hopefully).
This is the ignore file for git. It contains all of the types of files that we are not going to keep track of.
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.
This file contains the copyright information for the software. It should be distributed with each release.
This file contains the licensing information for the software. It should be distributed with any distribution or piece of the code.
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.
This folder contains programs and classes that are used to interface with the Pixie-16 modules.
Contains classes that are used by all of the acquisition software to interface with the Pixie-16 modules.
Contains classes related to the use of the MCA program.
Contains the main polling program.
A simple utility program that will generate a simple data file.
Contains programs that were built with the original PixieSuite software.
Contains scripts that are useful for looking at raw from Pixie-16 modules.
A program that converts set files into root or txt
This folder contains classes and programs that are used to analyze data taken from the Pixie-16 modules.
Contains resources that are useful across all of the analysis programs.
Contains core libraries used by all of the analysis programs.
This contains the source code necessary to compile the analysis software with the HRIBF libraries.
This contains analysis related utility programs such as scope.
Reads a data file and output individual events from the data file.
Takes a data file and outputs the header information
Reads a data file and outputs individual buffers in a hex format.
Scans a file and allows users to create ROOT histograms on the fly. Outputs a ROOT file when complete.
Handy program that allows users to read traces in a data file. Can attach to shared memory.
A program that can be used as a base to build custom scan programs
Does not get built or do much of anything useful at the moment.
This is the main analysis program.
This contains classes that are related to trace analysis.
Contains classes related to core functionality of utkscan, along with the main program.
Contains classes that are used for experiment specific data processing.
Contains classes that provide basic functionality for various detector types..
Contains user submitted configuration files, banana gates for DAMM and scripts that are useful for running the program.
Contains modules that are used by cmake to find packages that are necessary for compilation of the programs.
Contains classes that are useful to many different programs. Examples include the CTerminal and hribf_buffers.
This directory contains the Doxyfile. Doxygen generated documentation will appear in the html/ sub-folder.
Contains doxygen related pages that are not automatically generated.
Contains pictures that are referenced in the doxygen documentation.
Contains source code for various classes, functions, enumerations, constants, etc. that will be useful in multiple places in the software.
Contains modulefiles to be used with the environment-modules package.
Files related to the automatic loading of PLX drivers with either init.d or systemd. Most modern systems use systemd.
Scripts for loading PLX with init.d.
Scripts for loading PLX with systemd.
This folder contains all of the Third Party software that is compiled with our programs.