Introduction



This document result from the effort lead by the Photon Group at SUBATECH to organize within the PHOS collaboration the software needed for the performance and physics simulation of PHOS and for the reconstruction of the raw data (presently simulated one's and real data in the future).

The PHOS software is a package of AliRoot, the off line project for ALICE. Before doing anything you should carefully read the general AliRoot documentation. The current stable version is V3.02. This is the last version which still includes the old structure. The higher versions (the branch tagged as HEAD in the CVS server) are a major rewriting of the entire package. It has been rewritten to follow the lines defined by the AliRoot project.

Rules

During the development phase any participant to the PHOS collobaration is a potentiel developper. To keep consistency within the PHOS package and the AliRoot project, the following rules must be obeyed:

  1. The AliRoot offline policy must be followed.
  2. SUBATECH represented by Yves Schutz is the librarian of the PHOS contribution to AliRoot.
  3. Any modification to the existing software or any new piece of software must be approved by the librarian who is in charge of the updates.
  4. Developpers must used CVS to download the official software from the CERN repository.
  5. Developpers must comply with the Coding AliRoot coding convention.
  6. FORTRAN is a strictly prohibited language.
  7. Any new piece of code must be documented along the line: what is the purpose, how is it done, how to use it. You can start any new class from a canevas, available in the PHOS package:

canevas.h

#ifndef ALIPHOSXXX_H
#define ALIPHOSXXX_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */

//_________________________________________________________________________
//  Base Class for PHOS     
//                  
//*-- Author: (SUBATECH)


// --- ROOT system ---

// --- Standard library ---

// --- AliRoot header files ---

class AliPHOSxxx {

public:
  AliPHOSxxx() ;          // ctor

  virtual ~AliPHOSxxx() ; // dtor

private:

  ClassDef(AliPHOSxxx,1)  // description 

};

#endif // AliPHOSXXX_H
    

canevas.cxx

/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/

/* $Id$ */

//_________________________________________________________________________
// Short description  
//
//*-- Author :  (SUBATECH) 
//////////////////////////////////////////////////////////////////////////////

// --- ROOT system ---

// --- Standard library ---

// --- AliRoot header files ---

#include "AliPHOSxxx.h"

ClassImp(AliPHOSxxx)


//____________________________________________________________________________ 
  AliPHOSxxx::AliPHOSxxx() 
{
  // ctor

}

//____________________________________________________________________________ 
  AliPHOSxxx::~AliPHOSxxx()
{
  // ctor

}
    


The PHOS package is organized along two directions which we will try to keep as independent as possible. The simulation is the first one, the reconstruction the second one.

use case diagram

Figure 1.: Use case diagram of the simulation and reconstruction for PHOS (click on image for full size)

© >Groupe Photons Subatech (Yves SCHUTZ) [Go to the GPS Home Page]
Last modified: Sun Mar 26 17:34:20 CEST 2000