Cuore Data Acquisition, Simulation and Reconstruction Software
==============================================================

Last update: Sep 29, 2008 MV

directory structure
===================

pkg:    contains Cuore code except montecarlo simulations
doc:    documentation of pkg (doxygen based. automatically generated by make)
cfg:    configuration files for diana (right now, possibly other codes in the future)
dbt:    data base tools and scripts
daqt:   daq tools and scripts

Environment requirements to compile and link.
================================================================================

All code is now written in C++. Eventually Fortran code will enter the system 
because of FLUKA. No C code please! 

* system: linux with probably almost any distribution. Tested on Debian, RedHat. 
          Mac OS X is not officially supported but it is used by many developers.
    
* shell:  all scripts will be prepared and tested using either bash or perl. 
          No other scripting language supported.

* c++:    g++ version from 3.3 through 4.2

* root:   version 5.18 [root.cern.ch]
          ROOTSYS variable must be properly set. Contact your system admin for 
          more infos. PATH variable should also contain $ROOTSYS/bin/
          script root-config must work properly

* gsl:    GNU Scientific Library version 1.8 or above [www.gnu.org/software/gsl]
          script gsl-config must be in PATH and work properly 

* postgreSQL: data base client version 7.3 or above [www.postgreSQL.org]
              script pg_config must be in PATH and work properly 

* Qt:     optional install, version 4.3.4 or greater.
          qmake must be in PATH and work properly


Makefile instruction
====================

* apollo (online daq software):
           enter directory pkg and type:
           -> make apollo

* diana (reconstruction code): 
           Setup the diana env type typing in the project home:
           -> source setup.sh
           Then type in the project home or in pkg:
           -> make diana
    
[Typing within pkg "make" will do diana and apollo]

* doc
           to produce LaTeX documents enter directory doc and type:
           -> make doc

           to produce code documentation (doxygen)a enter doc and type:
           -> make pkg_doc

           tod produce a full doc for a website enter doc and type
           -> make www_doc


Requirements for running code
============================

* apollo binaries: experts only.

* diana binaries: 
           If not set, setup the diana env in the project home typing:
           -> source setup.sh

           Then run diana:
           -> ./bin/diana       runs the program using config file cfg/diana.cfg
           -> ./bin/diana -h    list diana avalaible options


Resources
=========

* Code documentation:
           http://www.roma1.infn.it/exp/cuore/swdoc/