PAC-Suite 2.0(r200)

PAC-Suite API Documentation

Introduction

This documentation covers the source code of all applications belonging to the PAC-Suite and the libraries and plugins belonging to this set of software. Up to now there is no separate user documentation besides this software documentation and the readme files in the source directory covering the installation of PAC-Suite available. If questions concerning the setup and use of PAC-Suite arise please consult the main developer via email.

Resources

Applications

Please note that each application has separate documentation. All parts are available via these direct links:

The main applications belonging to this suite are:

Additionally there exist some tools, mostly used to edit .pacevents files:

The analysis plugins loaded by PacMan and PacMaster for energy and time determination:

The following libraries are used by several parts of the PAC-Suite:

Data Formats

PacMaster produces binary files with the extension .pacevents containing energy and time information for each recorded gamma photon. The .pacevents file format is extensively documented on the page about libPaceventsWriter.

The format of the network data transmission between PacMan and PacMaster is defined in the PacNetCom classes belonging to both applications.

SpectraPac can save the current evaluation state in xml format (.spectrapac files) and exports results as tab-separated values (TSV or CSV) files. R(t) spectra can also be exported in a format suitable for WinFit.

Installation

Linux

INSTALL.linux

(C) Matthias Nagl, Uni-Göttingen, 2011-07-14
=============================================================================

Compiling the PacSuite for Linux

=============================================================================

After installing all required dependencies (see README.linux) the pac-suite can be compiled.

Please run qmake -r first. If you would like to change the installation prefix
(default: /usr/local) use the command

qmake -set PREFIX /usr/local

with the desired path (rerun qmake -r after this step!!)

after qmake the usual

make
make install

is required. Afterwards you can run the pac-suite application from the bin folder below the
installation prefix. If libraries are not found please run ldconfig.

README.linux

(C) Matthias Nagl, Uni-Göttingen, 2011-07-14
=============================================================================

Prerequisites of the PacSuite for Linux

=============================================================================

Prerequisites (oldest versions tested, newer should work):

- Qt 4.6.2
- Minuit2 5.24
- QWT 5.2.1
- GSL 1.13
- FFTW 3.2.2
- The Agilent drivers and libs
- libiowkit (http://www.codemercs.com/index.php?id=161&L=1)

After changing SpectraPac's fit formula the rebuilding of the formula
images also requires the following programs to be available. For normal
builds they are not needed as precreated images are contained in the
source package / repository:
- pdflatex
- pdfcrop
- ImageMagick

=============================================================================

Older versions might work but were not tested.

Refer to INSTALL.linux for instructions on how to compile this package.

Please see the doxygen documentation for detailed API and format information.

Windows

INSTALL.win

(C) Matthias Nagl, Uni-Göttingen, 2011-07-14
=============================================================================

Installing the PacSuite for Windows (binary release)

=============================================================================

Simply unpack the zip file and start the Applications by double-clicking the
exe files.

You can find instructions on how to build PAC-Suite for Windows from source
in the file README.win.

README.win

(C) by Matthias Nagl, Uni-Göttingen, 2011-07-14
=============================================================================

Compiling the PacSuite for Windows

=============================================================================

1. Download and install the Qt SDK for Windows from http://qt.nokia.com/downloads/sdk-windows-cpp

2. Download and install QWT 5.2.1 or newer from http://sourceforge.net/projects/qwt/files/

3. Download additional MingW and MSYS packages from http://sourceforge.net/projects/mingw/files/ as needed for the compilation of Minuit2 (especially autoconf)

4. Download Minuit2 from https://project-mathlibs.web.cern.ch/project-mathlibs/minuit/index.html or use the version contained in svn, decompress it and build it using MingW. Use the following commands in the MSYS shell:

MAKE="mingw32-make" ./configure --disable-openmp --prefix=/usr
mingw32-make
mingw32-make install

5. Download GSL from ftp://ftp.gnu.org/gnu/gsl/ or use the version contained in svn, decompress it and build it using MingW. Use the following commands in the MSYS shell:

MAKE="mingw32-make" ./configure --prefix=/usr
mingw32-make
mingw32-make install

Note: As of GSL 1.14 the compilation only works if the directory path does not contain any spaces ("Documents and Settings"...)

6. Decompress the PDCurses dll and header from the zip file in pac-suite's base dir into your MingW lib and include dirs.

7. Download and decompress Agilent driver CD. Install libs/headers and drivers.

8. Call qmake -r and MingW-make from the QT command line or via Qt-Creator

9. At least the following DLLs should be shipped together with the .exe files to make them work on most systems:

AqDrv4.dll
fouriercomponent.dll
iowkit.dll
libfftw3-3.dll
libgcc_s_dw2-1.dll
libgsl-0.dll
libgslcblas-0.dll
mingwm10.dll
paceventsmetainfo.dll
paceventswriter.dll
pacplot.dll
pdcurses.dll
propertybranches.dll
QtCore4.dll
QtGui4.dll
QtNetwork4.dll
QtXml4.dll
qwt5.dll
transmittableproperties.dll

=============================================================================

Refer to INSTALL.win for instructions on how to compile this package.

Please see the doxygen documentation for detailed API and format information.
 All Classes Namespaces Files Functions Enumerations Enumerator Defines