7e57dedc17294280cb40ebd787e955aae9ad6360
[u/mrichter/AliRoot.git] / 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 Photon Group at SUBATECH
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#"a>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         <br><h3> canevas.h </h3> 
60         <pre>
61 #ifndef ALIPHOSXXX_H
62 #define ALIPHOSXXX_H
63 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
64  * See cxx source for full Copyright notice                               */
65
66 /* $Id$ */
67
68 //_________________________________________________________________________
69 //  Base Class for PHOS     
70 //                  
71 //*-- Author: (SUBATECH)
72
73
74 // --- ROOT system ---
75
76 // --- Standard library ---
77
78 // --- AliRoot header files ---
79
80 class AliPHOSxxx {
81
82 public:
83   AliPHOSxxx() ;          // ctor
84
85   virtual ~AliPHOSxxx() ; // dtor
86
87 private:
88
89   ClassDef(AliPHOSxxx,1)  // description 
90
91 };
92
93 #endif // AliPHOSXXX_H
94         </pre>
95         <br><h3>canevas.cxx </h3>
96         <pre>
97 /**************************************************************************
98  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
99  *                                                                        *
100  * Author: The ALICE Off-line Project.                                    *
101  * Contributors are mentioned in the code where appropriate.              *
102  *                                                                        *
103  * Permission to use, copy, modify and distribute this software and its   *
104  * documentation strictly for non-commercial purposes is hereby granted   *
105  * without fee, provided that the above copyright notice appears in all   *
106  * copies and that both the copyright notice and this permission notice   *
107  * appear in the supporting documentation. The authors make no claims     *
108  * about the suitability of this software for any purpose. It is          *
109  * provided "as is" without express or implied warranty.                  *
110  **************************************************************************/
111
112 /* $Id$ */
113
114 //_________________________________________________________________________
115 // Short description  
116 //
117 //*-- Author :  (SUBATECH) 
118 //////////////////////////////////////////////////////////////////////////////
119
120 // --- ROOT system ---
121
122 // --- Standard library ---
123
124 // --- AliRoot header files ---
125
126 #include "AliPHOSxxx.h"
127
128 ClassImp(AliPHOSxxx)
129
130
131 //____________________________________________________________________________ 
132   AliPHOSxxx::AliPHOSxxx() 
133 {
134   // ctor
135
136 }
137
138 //____________________________________________________________________________ 
139   AliPHOSxxx::~AliPHOSxxx()
140 {
141   // ctor
142
143 }
144         </pre>
145       </li>
146     </ol>
147     <br><br>
148     The PHOS package is organized along two directions which we will try to
149     keep as independent as possible. The simulation is the first one, the reconstruction
150     the second one. 
151     <p>
152       <center>
153       <a href="usecase.gif">
154         <img src="usecase.gif" alt="use case diagram" height=334 width=470>
155       </a>      
156       <br><br>
157       <b> Figure 1.: </b> <i> Use case diagram of the simulation and reconstruction for PHOS (click on image for full size)</i>
158       </center>
159     </p>
160
161 <hr>
162 <address class="left">
163       &copy; <a href="mailto:schutz@in2p3.fr">>Groupe Photons Subatech (Yves SCHUTZ)</a>
164       <a href="http://www-subatech.in2p3.fr/~photons/subatech/en_index.shtml">[Go
165         to the GPS Home Page]</a>
166 </address>
167 <!-- Created: Wed Nov 17 12:16:58 CET 1999 -->
168 <!-- hhmts start -->
169 Last modified: Tue Mar 14 16:21:55 CET 2000
170 <!-- hhmts end -->
171 <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>
172
173
174 </body>
175 </html>
176