GETDocCompilation.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETDocCompilation.hh
 *
 *  Documentation page for compilation.
 */
//======================================================================


//======================================================================
/*! \page get_page_compilation GET libraries compilation and OS environment
 *
 *
 *  \par Operating system requirements
 *
 *  Only Linux OS are supported (currently, I could install the libraries
 *  on Scientific Linux, CentOS, Fedora, Ubuntu).
 *
 *  In order to build and use the GET library, the following libraries
 *  must be installed:
 *  - Linux system libraries:
 *    - the ROOT / CERN package (environment variable \b ROOTSYS must be defined):
 *    - the Xerces-c library (check if environment variable \b XERCESCROOT exists
 *      and define \b XERCESC_INC and \b XERCESC_LIB environment variables)
 *      for XML configuration files parsing
 *  - GANIL/GET libraries
 *    - the MFM library for Meta Frames (L. Legeard, GANIL)\n
 *      \global_docs_dir/GETdoc/MFM_15_10_22c/html/index.html
 *    - the TinyXML library (needed by MFM library)
 *  - J.G. libraries (contact giovinaz@cenbg.in2p3.fr): the environment variable
 *    \b SYSTEM must be defined for compilation identification (it is used for
 *    the following libraries - see specific documentations):
 *    - the GCpp library (C++ general purpose library)\n
 *      \global_docs_dir/JGlibs/GCpp\version/html/index.html
 *    - the GRootTools library (useful functions and classes to be used within
 *      ROOT environment - requires to define the \b ROOT_VERSION environment
 *      variable)\n
 *      \global_docs_dir/JGlibs/GRootTools\groot_version/html/index.html
 *    - (the GFFT library is now part of the GCpp and GRootTools libraries)\n
 *
 *  For a full step-by-step installation of all packages, refer to the
 *  page \ref GETFullInstallationGuide.txt.
 *
 *  All the required packages can be found there:
 *  <A HREF=\global_docs_dir/libs_download.html>Libraries download page</A>
 *
 *
 *  \warning
 *  - only ROOT version up to 5.34 are supported
 *  - scripts for compilation options and configuration defined only
 *    for \b csh / \b tcsh.
 *
 *  Before compilation, be sure the required libraries are properly
 *  installed and corresponding environment variables are defined.
 *
 *  After compilation, the configuration files for OS environment must
 *  be called (see below how to set configuration in the shell
 *  configuration script).
 *
 *
 *  \par Extraction of the archive file in the required directory
 *
 *  The archive file must be extracted in the required directory,
 *  noted <base_dir>, in a shell:
 *  \code
 *  [shell] cp <GETx.x>_<archive_date>.tgz <base_dir>
 *  [shell] cd <base_dir>
 *  [shell] tar zxvf <GETx.x>_<archive_date>.tgz
 *  \endcode
 *
 *  A subdirectory <GETx.x> is created (where x.x is the library version).
 *
 *
 *  \par Compilation of the main library
 *
 *  \code
 *  [shell] cd <base_dir>/<GETx.x>/src
 *  [shell] make
 *  \endcode
 *
 *  The compilation also creates shell scripts in order to easily get
 *  the options for compilation of programs with the library, and a
 *  shell script to define environment variables.
 *
 *  This shell configuration script may be called in the shell configuration
 *  script.
 *
 *  For \b csh / \b tcsh, add the following line (exact command is printed out
 *  at the end of compilation) to the \b $HOME/.cshrc file:
 *  \code
 *  # define environment variables and scripts for use of GET library
 *    source <base_dir>/<GETx.x>/bin/${SYSTEM}_r${ROOT_VERSION}/get_config.csh
 *  \endcode
 *
 *
 *  \par Compilation of the additional library for specific ROOT analysis
 *
 *  Before compiling the additional library for ROOT analysis, the shell
 *  must be updated to take into account the GET environment variables:
 *
 *  For \b csh / \b tcsh:
 *  \code
 *  [shell] source $HOME/.cshrc
 *  \endcode
 *
 *  Then compile the library
 *  \code
 *  [shell] cd <base_dir>/<GETx.x>/root/src
 *  [shell] make
 *  \endcode
 *
 *  Here also, the configuration script should be added to the shell
 *  configuration file.
 *
 *  For \b csh / \b tcsh (\b $HOME/.cshrc file):
 *  \code
 *  # define environment vfor use of GET additional library for ROOT
 *    source <base_dir>/<GETx.x>/bin/${SYSTEM}_r${ROOT_VERSION}/get_root_config.csh
 *  \endcode
 *
 *  Finally, the shell configuration must be updated:
 *  \code
 *  [shell] source $HOME/.cshrc
 *  \endcode
 *
 *
 *  \par Compilation of the ACTAR TPC reader library and program
 *
 *  The <B>Event Analysis</B> library must be installed in order to compile
 *  the ACTAR TPC data reader class and program.
 *  Then, the library can be build from the GETActarEventReader class and
 *  the default program GETActarRead is compiled.
 *  The library is stored with the main GET library, and the program is
 *  stored in the GET library associated executable files (bin directory).
 *
 *  \code
 *  [shell] cd <base_dir>/<GETx.x>/tools/GETActarReader
 *  [shell] make
 *  \endcode
 */

//======================================================================
/*! \example GETFullInstallationGuide.txt
 *
 *  <B>IMPORTANT NOTE</B>
 *
 *  <B>The tools and libraries proposed here have been developed for my needs
 *  in the data analysis.</B>
 *  - there is no warranty that they are bug-free
 *  - I am not a computing developer, so there are many possible improvements
 *    (and for instance computation speed...)
 *
 *  <B>I make the codes available despite it is not part of the GET project itself,
 *  but I would <I>REALLY APPRECIATE</I> if users of the code may mention it somewhere
 *  when used for analysis.
 *
 *  And please, let me know...</B>
 *
 *  \n
 *
 */