From 72ac4872005797545f2bcab32a92e45d74050735 Mon Sep 17 00:00:00 2001
From: deserevi <deserevi@nptool>
Date: Tue, 1 Sep 2009 20:59:08 +0000
Subject: [PATCH] * Update information in INSTALL/README/HOWTO files
* Add information header to the previous files
---
HOWTO | 34 +++++++++++++++++++------
INSTALL | 20 ++++++++++++++-
NPLib/INSTALL | 24 +++++++++++++++++-
NPLib/README | 69 ++++++++++++++++++++++++++++++++++++++++++++++-----
README | 28 ++++++++++++++++++++-
5 files changed, 158 insertions(+), 17 deletions(-)
diff --git a/HOWTO b/HOWTO
index aa2cf483e..1d05aa1da 100644
--- a/HOWTO
+++ b/HOWTO
@@ -1,5 +1,23 @@
-This file describes how to use the NPTool package.
-
+/*****************************************************************************
+ * Copyright (C) 2009 this file is part of the NPTool Project *
+ * *
+ * For the licensing terms see $NPTOOL/Licence/NPTool_Licence *
+ * For the list of contributors see $NPTOOL/Licence/Contributors *
+ *****************************************************************************/
+
+/*****************************************************************************
+ * Original Author: N. de Sereville contact address: deserevi@ipno.in2p3.fr *
+ * *
+ * Creation Date : 01/09/09 *
+ * Last update : *
+ *---------------------------------------------------------------------------*
+ * Decription: *
+ * This file describes how to use the NPTool package *
+ *---------------------------------------------------------------------------*
+ * Comment: *
+ * *
+ * *
+ *****************************************************************************/
I) NPSIMULATION
I.a) HOW TO RUN THE G4 SIMULATION
@@ -10,8 +28,9 @@ To invoke the G4 simulation module do the following:
where xxx.reaction is one of the available event generator and
yyy.detector is one of the available detector geometry
-I.b) EVENT GENERATORS
-All the event generators are and should be located in the directory:
+I.b) EVENT GENERATORS CONFIGURATION FILES
+All the event generators configuration files are and should be located in the
+directory:
NPTool/Inputs/Reaction
Several event generators are available for the moment:
+ isotropic.source
@@ -25,8 +44,9 @@ Several event generators are available for the moment:
+ 11Li.beam
... ...
-I.c) DETECTOR GEOMETRIES
-All the detector geometries are and should be located in the directory:
+I.c) DETECTOR GEOMETRIES CONFIGURATION FILES
+All the detector geometries configuration files are and should be located in
+the directory:
NPTool/Inputs/DetectorConfiguration
As the first release of the NPTool package several detectors are available:
+ MUST2
@@ -35,8 +55,6 @@ As the first release of the NPTool package several detectors are available:
+ Eurogam, Exogam will come soon
+ EDEN will come soon
-I.d) MESSENGERS
-
II) NPANALYSIS
diff --git a/INSTALL b/INSTALL
index ffa5b1333..acd0b7ebb 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,23 @@
-This file describes the installation steps of the NPTool package
+/*****************************************************************************
+ * Copyright (C) 2009 this file is part of the NPTool Project *
+ * *
+ * For the licensing terms see $NPTOOL/Licence/NPTool_Licence *
+ * For the list of contributors see $NPTOOL/Licence/Contributors *
+ *****************************************************************************/
+/*****************************************************************************
+ * Original Author: N. de Sereville contact address: deserevi@ipno.in2p3.fr *
+ * *
+ * Creation Date : 01/09/09 *
+ * Last update : *
+ *---------------------------------------------------------------------------*
+ * Decription: *
+ * This file describes the installation steps of the NPTool package *
+ *---------------------------------------------------------------------------*
+ * Comment: *
+ * *
+ * *
+ *****************************************************************************/
I) REQUIREMENTS
The NPTool package depends on 4 third-party softwares:
diff --git a/NPLib/INSTALL b/NPLib/INSTALL
index 7a985d98b..891fc0f35 100644
--- a/NPLib/INSTALL
+++ b/NPLib/INSTALL
@@ -1,5 +1,23 @@
-This file describes the installation procedure of the NPLib
+/*****************************************************************************
+ * Copyright (C) 2009 this file is part of the NPTool Project *
+ * *
+ * For the licensing terms see $NPTOOL/Licence/NPTool_Licence *
+ * For the list of contributors see $NPTOOL/Licence/Contributors *
+ *****************************************************************************/
+/*****************************************************************************
+ * Original Author: N. de Sereville contact address: deserevi@ipno.in2p3.fr *
+ * *
+ * Creation Date : 01/09/09 *
+ * Last update : *
+ *---------------------------------------------------------------------------*
+ * Decription: *
+ * This file describes the installation procedure of the NPLib *
+ *---------------------------------------------------------------------------*
+ * Comment: *
+ * *
+ * *
+ *****************************************************************************/
In order to build all the libraries of the NPLib module, use the two
following commands:
@@ -15,3 +33,7 @@ following commands:
to each library are copied to the lib directory. If you are using
a Mac OS system a symbolic link *.dylib is done with respect to
each *.so library.
+
+ Important note:
+ You need a working installation of GSL when compiling the
+ NPEnergyLoss.{h,cxx} library in the Tools directory.
diff --git a/NPLib/README b/NPLib/README
index c6a575308..c6deacdc5 100644
--- a/NPLib/README
+++ b/NPLib/README
@@ -1,8 +1,26 @@
-This file describes the content of the NPLib directory
+/*****************************************************************************
+ * Copyright (C) 2009 this file is part of the NPTool Project *
+ * *
+ * For the licensing terms see $NPTOOL/Licence/NPTool_Licence *
+ * For the list of contributors see $NPTOOL/Licence/Contributors *
+ *****************************************************************************/
-This directory contains a set of libraries which are used
-both in the NPSimulation and the NPAnalysis modules.
-The structure of this directory is:
+/*****************************************************************************
+ * Original Author: N. de Sereville contact address: deserevi@ipno.in2p3.fr *
+ * *
+ * Creation Date : 01/09/09 *
+ * Last update : *
+ *---------------------------------------------------------------------------*
+ * Decription: *
+ * This file describes the content of the NPLib directory *
+ *---------------------------------------------------------------------------*
+ * Comment: *
+ * *
+ * *
+ *****************************************************************************/
+
+This directory contains a set of libraries which are used both in the
+NPSimulation and the NPAnalysis modules. The structure of this directory is:
NPLib / include
/ lib
/ IORoot
@@ -14,25 +32,64 @@ NPLib / include
/ GASPARD
/ VDetector
-A description of each library follows.
+A description of each directory follows.
I) include directory
-
+ When compiling NPLib (see INSTALL file) all the headers of the libraries
+ are copied to this directory
II) lib directory
+ When compiling NPLib (see INSTALL file) all the shared libraries are
+ copied to this directory
III) IORoot
+ This directory includes one library:
+ libIORoot.so
+ This library contains two singleton classes (RootOutput and RootInput) used
+ both in NPSimulation and NPAnalysis.
+ These classes are used to deal with the input and output ROOT files and trees.
IV) Tools
V) InitialConditions
+ This directory includes one library:
+ libInitialConditions.so
+ This library records all the information concerning the event generators,
+ e.g. vertex of interaction, angles of emitted particles...
+ This class derives from TObject (ROOT) and its aim is to be stored in the
+ output TTree of the G4 simulation
VI) InteractionCoordinates
+ This directory includes one library:
+ libInteractionCoordinates.so
+ This library mainly records the coordinates of interaction between a particle
+ and a detector.
+ This class derives from TObject (ROOT) and its aim is to be stored in the
+ output TTree of the G4 simulation.
VII) MUST2
VIII) AnnularS1
+ This directory includes one library:
+ libAnnularS1Data.so
+ This library stores the results of the G4 simulation for the S1 detector.
+ The format is the same as the one which is used for the GANIL experiments after
+ conversion of the raw data with GRU. Ask N. de Sereville and J. Burgunder
+ (burgunder@ganil.fr) for more informations.
+ This class derives from TObject (ROOT) and its aim is to be stored in the
+ output TTree of the G4 simulation.
IX) GASPARD
+ This directory includes two libraries:
+ libGaspardData.so
+ libGaspardPhysics.so
+ libGaspardData.so:
+ This library stores the results of the G4 simulation for the tracker part
+ of the Gaspard detector.
+ The format mimics what was used for the GANIL experiments after conversion
+ of the raw data with GRU. Ask N. de Sereville for more informations.
+ libGaspardPhysics.so:
+ This library deals with the treatment applied to the ROOT output file
+ obtained from NPSimulation. This library is *only* used by NPAnalysis.
X) VDetector
diff --git a/README b/README
index 59b42e543..62cca3139 100644
--- a/README
+++ b/README
@@ -1,5 +1,23 @@
-This file describes the content of the NPTool package
+/*****************************************************************************
+ * Copyright (C) 2009 this file is part of the NPTool Project *
+ * *
+ * For the licensing terms see $NPTOOL/Licence/NPTool_Licence *
+ * For the list of contributors see $NPTOOL/Licence/Contributors *
+ *****************************************************************************/
+/*****************************************************************************
+ * Original Author: N. de Sereville contact address: deserevi@ipno.in2p3.fr *
+ * *
+ * Creation Date : 01/09/09 *
+ * Last update : *
+ *---------------------------------------------------------------------------*
+ * Decription: *
+ * This file describes the content of the NPTool package *
+ *---------------------------------------------------------------------------*
+ * Comment: *
+ * *
+ * *
+ *****************************************************************************/
The NPTool package has basically three modules: the NPSimulation
module in charge of performing the G4 simulation, the NPAnalysis
@@ -26,8 +44,16 @@ I) NPLib
directory.
II) NPSimulation
+ This directory contains all the files needed to run the
+ G4 simulation software. The structure of this directory
+ is the typical structure for G4 programs with a src and
+ include directory.
III) NPAnalysis
+ This directory contains everything related to the analysis
+ program treating the output ROOT file from NPSimulation.
+ An example of such a program can be found in the subdirectory
+ Template which deals with the MUST2 detector.
IV) Inputs
This directory contains all the input files needed for
--
GitLab