PHOS/PHOS-HTML/introduction.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
   2                "http://www.w3.org/TR/REC-html40/loose.dtd">
   3 <html>
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   6     <meta name="GENERATOR" content="Mozilla/4.51 [en] (X11; I; Linux 2.2.5-15 i686) [Netscape]">
   7     <title>PHOS Geometry in AliRoot</title>
   8     <link REL="stylesheet" href="http://www-subatech.in2p3.fr/~photons/gps_alice.css" type="text/css">
   9   <body>
  10
  11     <h1 class="page-header">
  12       Introduction
  13     </h1>
  14     <br><br>
  15     <p>
  16       This document result from the effort lead by the <a href="htpp://www-subatech.in2p3.fr/~photons">Photon Group at SUBATECH</a>
  17       to organize within the PHOS collaboration the software needed for the performance
  18       and physics simulation of PHOS and for the reconstruction of the raw data
  19       (presently simulated one's and real data in the future).
  20     </p>
  21     <p>
  22       The PHOS software is a package of AliRoot, the off line project for ALICE. Before doing
  23       anything you should carefully read the general AliRoot <a href="http://AliSoft.cern.ch/offline/">documentation</a>.
  24       The current stable version is V3.02. This is the last version which still includes the old structure. The higher
  25       versions (the branch tagged as <i>HEAD</i> in the CVS server) are a major rewriting of the entire package.
  26       It has been rewritten to follow the lines defined by the AliRoot project.
  27     </p>
  28     <h1>
  29       Rules
  30     </h1>
  31     During the development phase any participant to the PHOS collobaration is a potentiel developper. To keep
  32     consistency within the PHOS package and the AliRoot project, the following rules must be obeyed: <br><br>
  33     <ol>
  34       <li> The <a href="http://AliSoft.cern.ch/offline/offpol.html">AliRoot offline policy</a> must be followed.
  35       </li>
  36       <li>
  37         <a href="http://www-subatech.in2p3.fr/~photons/subatech/">SUBATECH</a>
  38         represented by <a href="mailto:schutz@in2p3.fr">Yves Schutz</a> is the
  39         librarian of the PHOS contribution to AliRoot.
  40       </li>
  41
  42       <li>
  43         Any modification to the existing software or any new piece of software
  44         must be approved by the librarian who is in charge of the updates.
  45       </li>
  46       <li>
  47         Developpers must used CVS to download the official software from the CERN
  48         repository.
  49       </li>
  50       <li>
  51         Developpers must comply with the <a href="http://AliSoft.cern.ch/offline/development.html#">Coding AliRoot coding convention</a>.
  52       </li>
  53       <li>
  54         FORTRAN is a strictly prohibited language.
  55       </li>
  56       <li>
  57         Any new piece of code must be documented along the line: what is the purpose,
  58         how is it done, how to use it. You can start any new class from a canevas, available in the PHOS package:
  59       </li>
  60     </ol>
  61     <h3>
  62       canevas.h
  63     </h3>
  64     <pre>
  65 #ifndef ALIPHOSXXX_H
  66 #define ALIPHOSXXX_H
  67 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  68  * See cxx source for full Copyright notice                               */
  69
  70 /* $Id$ */
  71
  72 //_________________________________________________________________________
  73 //  Base Class for PHOS
  74 //
  75 //*-- Author: (SUBATECH)
  76
  77
  78 // --- ROOT system ---
  79
  80 // --- Standard library ---
  81
  82 // --- AliRoot header files ---
  83
  84 class AliPHOSxxx {
  85
  86 public:
  87   AliPHOSxxx() ;          // ctor
  88
  89   virtual ~AliPHOSxxx() ; // dtor
  90
  91 private:
  92
  93   ClassDef(AliPHOSxxx,1)  // description
  94
  95 };
  96
  97 #endif // AliPHOSXXX_H
  98     </pre>
  99         <br>
 100     <h3>
 101       canevas.cxx
 102     </h3>
 103     <pre>
 104 /**************************************************************************
 105  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 106  *                                                                        *
 107  * Author: The ALICE Off-line Project.                                    *
 108  * Contributors are mentioned in the code where appropriate.              *
 109  *                                                                        *
 110  * Permission to use, copy, modify and distribute this software and its   *
 111  * documentation strictly for non-commercial purposes is hereby granted   *
 112  * without fee, provided that the above copyright notice appears in all   *
 113  * copies and that both the copyright notice and this permission notice   *
 114  * appear in the supporting documentation. The authors make no claims     *
 115  * about the suitability of this software for any purpose. It is          *
 116  * provided "as is" without express or implied warranty.                  *
 117  **************************************************************************/
 118
 119 /* $Id$ */
 120
 121 //_________________________________________________________________________
 122 // Short description
 123 //
 124 //*-- Author :  (SUBATECH)
 125 //////////////////////////////////////////////////////////////////////////////
 126
 127 // --- ROOT system ---
 128
 129 // --- Standard library ---
 130
 131 // --- AliRoot header files ---
 132
 133 #include "AliPHOSxxx.h"
 134
 135 ClassImp(AliPHOSxxx)
 136
 137
 138 //____________________________________________________________________________
 139   AliPHOSxxx::AliPHOSxxx()
 140 {
 141   // ctor
 142
 143 }
 144
 145 //____________________________________________________________________________
 146   AliPHOSxxx::~AliPHOSxxx()
 147 {
 148   // ctor
 149
 150 }
 151     </pre>
 152     <br><br>
 153     The PHOS package is organized along two directions which we will try to
 154     keep as independent as possible. The simulation is the first one, the reconstruction
 155     the second one.
 156     <p>
 157       <center>
 158       <a href="./images/usecase.eps">
 159         <img src="./images/usecase.gif" alt="use case diagram" height=334 width=470>
 160       </a>
 161       <br><br>
 162       <b> Figure 1.: </b> <i> Use case diagram of the simulation and reconstruction for PHOS (click on image for full size)</i>
 163       </center>
 164     <hr>
 165     <address class="left">
 166       &copy; <a href="mailto:schutz@in2p3.fr">>Groupe Photons Subatech (Yves SCHUTZ)</a>
 167       <a href="http://www-subatech.in2p3.fr/~photons/subatech/en_index.shtml">[Go
 168         to the GPS Home Page]</a>
 169     </address>
 170     <!-- Created: Wed Nov 17 12:16:58 CET 1999 -->
 171     <!-- hhmts start -->
 172 Last modified: Sun Mar 26 17:34:20 CEST 2000
 173 <!-- hhmts end -->
 174     <!-- <div align=right><a href="http://validator.w3.org/check/referer"><img SRC="vh40.gif" ALT="Valid HTML 4.0!" BORDER=0 height=31 width=88></a><a href="http://jigsaw.w3.org/css-validator"><img SRC="vcss.gif" ALT="Valid CSS!" BORDER=0 height=31 width=88></a></div> -->
 175 </body>
 176 </html>
 177