Annotation of /yoda/README

Install procedure 3.0 - Nagni 04 April 2006

To install YODA you can either use traditional Makefile (deprecated) or ANT tool (suggested).

/**************/
 USING Makefile
/**************/

1) check that you have installed ROOT and your enviroment have defined
   
#-----YODA's Environment-----------------------
# this variable define where YODA will write the managed files
export YODA_DATA= YourPathToStoreUnpackedFiles
#-----YODA's Environment-----------------------
 
#-----Cern's ROOT Environment-----------------------
export ROOTSYS=/usr/share/root
export PATH=$ROOTSYS/bin:$PATH
export LD_LIBRARY_PATH=$ROOTSYS/lib
#-----Cern's ROOT Environment-----------------------

2) check that you have installed
   ---->log4cxx (jakarta logger for c++ programs)
   ---->g77     (GNU FORTRAN Compiler)
   ---->LIBTOOL (compiler utility)

3) create a directory (say YOUR_YODA) and copy the source into it

4) execute the following commands (please customize the ./configure line according to your system)

$ cd $YODA_ROOT
$ autoheader
$ libtoolize       (eventually "libtoolize --force")
$ export CFLAGS="-g -O4"
$ export FFLAGS="-g -O0 -keepC"
$ export CXXFLAGS="-g -O4"
$ aclocal
$ automake -a
$ autoconf
$ ./configure --prefix=/path/where/you/want/to/install --with-log4cxx=/opt/log4cxx --enable-gprof=no
$ make

that a look at the configure options
$ ./configure --help

$ ./configure

$ make

then became ROOT user to install YODA

$ make install

if everthing has been correct typing

$ yoda

the program should reply something like below

You have forgotten the file name.
Try '-help' for more information.


/**************/
   USING ANT
/**************/

For this you should have installed moreover the ANT tool also the ant-contrib package. Once you have edited and configured the "value"s of the following parameters in the build.xml file

<!--Here is where all the stuff will be installed-->
<property name="pamSoftware" value="${env.HOME}/pamela"/>
        
<!-- CERN's ROOT base directory -->
<property name="root"    value="/opt/root"/>
        
<!-- LOG4CXX base directory -->
<property name="log4cxx" value="/opt/log4cxx"/>
        
<!-- ant-contrib base directory -->
<property name="ant-contrib.lib"  value="/opt/ant-contrib/lib"/>
        
you can run (in the same folder of build.xml)

ant compileYoda

once you verified that everithing is ok run

ant deployYoda

At the end you will have into the "pamSoftware" folder a structure like
./bin/yoda
./lib/libyoda.so
./include/several ".h" files

Check the funzionality typing 

/"pamSoftware"/bin/yoda


-----> Troubleshoting <----
If you get a kind of "libxxxx.so" not found check that 

log4cxx/lib, root/lib, /"pamSoftware"/lib/

are in your LD_LIBRARY_PATH environment.


------>NOTE 1<------
On the source code is supplied also a tipical configuratin file for the Log4cxx tool.
The file is named log4cxx.conf and is designed to be put into the YODA_DATA directory.
Notice that to set the output detail level you have to modify the log4cxx.conf
according to your needs.

------>NOTE 2<------
Because of major changes in ROOT, Trees produced with a version of ROOT greater than 4.01/02 
cannot be read by older ROOT versions.

------>NOTE 3<------
If you are doing an upgrading and you are installing it in a different location be careful to not use in the LD_LIBRARY_PATH both new and old yodalib.so.
1	kusanagi	6.1	Install procedure 3.0 - Nagni 04 April 2006
2	kusanagi	1.1
3	kusanagi	6.1	To install YODA you can either use traditional Makefile (deprecated) or ANT tool (suggested).
4
5			/**************/
6			USING Makefile
7			/**************/
8	kusanagi	1.1
9			1) check that you have installed ROOT and your enviroment have defined
10
11			#-----YODA's Environment-----------------------
12			# this variable define where YODA will write the managed files
13			export YODA_DATA= YourPathToStoreUnpackedFiles
14			#-----YODA's Environment-----------------------
15
16			#-----Cern's ROOT Environment-----------------------
17			export ROOTSYS=/usr/share/root
18			export PATH=$ROOTSYS/bin:$PATH
19			export LD_LIBRARY_PATH=$ROOTSYS/lib
20			#-----Cern's ROOT Environment-----------------------
21
22			2) check that you have installed
23	kusanagi	1.3	---->log4cxx (jakarta logger for c++ programs)
24	kusanagi	1.1	---->g77 (GNU FORTRAN Compiler)
25			---->LIBTOOL (compiler utility)
26
27			3) create a directory (say YOUR_YODA) and copy the source into it
28
29	kusanagi	5.1	4) execute the following commands (please customize the ./configure line according to your system)
30	kusanagi	1.1
31			$ cd $YODA_ROOT
32	kusanagi	2.1	$ autoheader
33	kusanagi	1.2	$ libtoolize (eventually "libtoolize --force")
34	kusanagi	5.1	$ export CFLAGS="-g -O4"
35			$ export FFLAGS="-g -O0 -keepC"
36			$ export CXXFLAGS="-g -O4"
37	kusanagi	1.1	$ aclocal
38			$ automake -a
39			$ autoconf
40	kusanagi	5.1	$ ./configure --prefix=/path/where/you/want/to/install --with-log4cxx=/opt/log4cxx --enable-gprof=no
41			$ make
42	kusanagi	1.1
43			that a look at the configure options
44			$ ./configure --help
45
46			$ ./configure
47
48	kusanagi	2.3	$ make
49	kusanagi	1.1
50	kusanagi	2.3	then became ROOT user to install YODA
51	kusanagi	1.1
52	kusanagi	2.3	$ make install
53	kusanagi	1.1
54	kusanagi	2.5	if everthing has been correct typing
55
56			$ yoda
57
58			the program should reply something like below
59
60			You have forgotten the file name.
61	kusanagi	6.1	Try '-help' for more information.
62
63
64			/**************/
65			USING ANT
66			/**************/
67
68			For this you should have installed moreover the ANT tool also the ant-contrib package. Once you have edited and configured the "value"s of the following parameters in the build.xml file
69
70			<!--Here is where all the stuff will be installed-->
71			<property name="pamSoftware" value="${env.HOME}/pamela"/>
72
73			<!-- CERN's ROOT base directory -->
74			<property name="root" value="/opt/root"/>
75
76			<!-- LOG4CXX base directory -->
77			<property name="log4cxx" value="/opt/log4cxx"/>
78
79			<!-- ant-contrib base directory -->
80			<property name="ant-contrib.lib" value="/opt/ant-contrib/lib"/>
81
82			you can run (in the same folder of build.xml)
83
84			ant compileYoda
85
86			once you verified that everithing is ok run
87
88			ant deployYoda
89
90			At the end you will have into the "pamSoftware" folder a structure like
91			./bin/yoda
92			./lib/libyoda.so
93			./include/several ".h" files
94
95			Check the funzionality typing
96
97			/"pamSoftware"/bin/yoda
98
99
100			-----> Troubleshoting <----
101			If you get a kind of "libxxxx.so" not found check that
102
103			log4cxx/lib, root/lib, /"pamSoftware"/lib/
104	kusanagi	2.5
105	kusanagi	6.1	are in your LD_LIBRARY_PATH environment.
106	kusanagi	2.5
107
108	kusanagi	1.1
109	kusanagi	2.2	------>NOTE 1<------
110			On the source code is supplied also a tipical configuratin file for the Log4cxx tool.
111	kusanagi	2.4	The file is named log4cxx.conf and is designed to be put into the YODA_DATA directory.
112			Notice that to set the output detail level you have to modify the log4cxx.conf
113			according to your needs.
114	kusanagi	1.1
115	kusanagi	2.3	------>NOTE 2<------
116			Because of major changes in ROOT, Trees produced with a version of ROOT greater than 4.01/02
117	kusanagi	2.4	cannot be read by older ROOT versions.
118
119			------>NOTE 3<------
120	kusanagi	6.1	If you are doing an upgrading and you are installing it in a different location be careful to not use in the LD_LIBRARY_PATH both new and old yodalib.so.