forked from alisw/AliRoot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL.txt
185 lines (141 loc) · 8.95 KB
/
INSTALL.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
############################################################################
# * Copyright(c) 1998-2014, ALICE Experiment at CERN, All rights reserved. *
# * *
# * Author: The ALICE Off-line Project. *
# * Contributors are mentioned in the code where appropriate. *
############################################################################
############################################################################
#AliRoot build and install documentation #
############################################################################
AliRoot, ALICE Off-line framework for simulation, reconstruction and analysis,
can be build and installed using CMake build system [http://www.cmake.org].
CMake is a cross-platform, open-source build system. One of the most important
features of CMake is the capability to build a project outside the source tree.
This enables the posibility to build different configurations from the same
source tree.
In order to build and install AliRoot 3 folders need to be defined.
1. Source tree - The folder which contains AliRoot sources / AliRoot Git clone
2. Build folder - The folder used for the actual build. This folder will contain
all intermediary files and generated build files
3. Installation folder - The folder when AliRoot libraries and binaries will be installed.
Minimum version of CMake for AliRoot is 2.8.11, but we recommend to stay up to date with
the latest stable version.
Important Note: All these 3 folders have to be in different locations.
Important Note: Developers information below
############################################################################
#Recommended workflow - Build and install #
############################################################################
For an easier AliRoot build and installation we recommend the following first time
AliRoot workflow. This workflow can be adapted to suit users purpose.
1. Create a work directory
$ mkdir $MY_WORK_DIR
$ cd $MY_WORK_DIR
2. Clone AliRoot repository inside your work directory.
If this is just a simple build and there is no need to change and submit code,
please use Git public interface
$ git clone http://github.com/alisw/AliRoot AliRoot
For development purpose please use the private interface, https or kerberos
$ git clone https://github.com/alisw/AliRoot AliRoot
3. Create the build folder. The worklow is creating a "build" folder but any name can be used.
$ mkdir build
4. Create the install folder. The workflow is creating an "install" folder but any name can be used.
$ mkdir install
We now have the complete configuration to start building AliRoot.
Note that the build does not require any environment variables. The only exception is DATE environment needed
for the generation of DAs (full documentation HERE -> link to daq documentation)
5. In order to configure and start the build we have to go inside the build folder
$ cd build
The full build is controlled by CMake configure variables, no environment variables are needed.
CMake variables are passed to the build system through -D configure paramenter. Example:
$ cmake -DCONFIGURE_PARAM1=ON -DCONFIGURE_PARAM2=/usr/some/location
The full list of AliRoot configuration parameters
- CMAKE_INSTALL_PREFIX - mandatory standard CMake paramenter. It points to AliRoot installation directory.
- ROOTSYS - mandatory Root installation directory.
- ALIEN - AliEn2 root installation directory. This configuration parameter is mandatory if Root was build with
AliEn2 support
- FASTJET - FastJet installation point
- ZEROMQ - ZeroMQ custom installation point. Not needed if ZeroMQ is installed on the system.
- DIMDIR - DIM installation directory
- ODIR - Platform for DIM, usually "linux"
- SHUTTLE - default value OFF. To enable Shuttle build it needs to be set to ON
- DATE_CONFIG - full location for date-config
Do not forget to source setup.sh before running AliRoot cmake
- AMORE_CONFIG - full location for amore-config
- DA - default value OFF. To enable the build of DAs set it to ON
- daqDA - location of daqDA libraries
- MDCRPM - enable alimdc rpm creation
- DARPM - enable DA rpm creation
A base cmake configuration would contain the following configuration parameters:
$ cmake
-DCMAKE_INSTALL_PREFIX=$MY_WORK_DIR/install
-DROOTSYS=$MY_ROOT_INSTALLATION_DIR
-DALIEN=$MY_ALIEN_INSTALLATION_DIR
$MY_WORK_DIR/AliRoot (or ../AliRoot)
If all configuration parameters point correctly to the different installations than the configure step will be
successul and we can move to the next step, the actual build. Before building please check that all information
reported by the configuration step is correct or what you are expecting to be.
If we need to change any configuration paramenter, for example the Root installation point set by ROOTSYS it
is mandatory to delete the $MY_WORK_DIR/build/CMakeCache.txt file and rerun the full "cmake" command
CMake offers general configuration options that can be set using CMAKE_BUILD_TYPE.
Possible values are empty, Debug, Release, RelWithDebInfo and MinSizeRel. This variable is only supported for
make based generators. If this variable is supported, then CMake will also provide initial values for the variables
with the name CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. For example, if CMAKE_BUILD_TYPE is Debug,
then CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.
CMAKE_BUILD_TYPE for AliRoot Grid packages is RelWithDebInfo.
5. Build AliRoot
After the configuration is done the build can be started. Inside the build directory we type
$ make
If the configuration permits parallel build than we can run
$ make -jNR_OF_PROCESSORS
For verbose output
$ export VERBOSE=1 # verbose mode enabled for futures make commands
$ make -j16
or
$ make -j16 VERBOSE=1 # verbose mode enabled only for this make command
Running "make" inside the root of the build directory will trigger the build of the full AliRoot.
Building per folder is possible. Just switch to the folder in question and run "make". This will
trigger the build of the current folder plus all its dependencies.
Example:
$ cd PWGJE/EMCALJetTasks
$ make -j16
6. Install AliRoot
If the build finished successfuly than AliRoot can be properly installed inside "install" folder
Inside the build folder run:
$ make -jNR_OF_PROCESSORS install
AliRoot installation follows "standard" installation directory structure.
- $MY_WORK_DIR/install/lib - libraries folder
- $MY_WORK_DIR/install/bin - binaries/executables folder
- $MY_WORK_DIR/install/include - header folder
AliRoot specific folders are used for
- $MY_WORK_DIR/install/da - DAs installation folder
- $MY_WORK_DIR/install/PWG** - different files related to PWG
############################################################################
#Recommended workflow - Running AliRoot #
############################################################################
Although the build and install procedure does not require any environment
variables, the actuall running of AliRoot needs to be aware of the different
locations of used libraries.
For properly running AliRoot we need to set at least 2 environment variables
1. PATH
Adding Root and AliRoot to PATH
$ export PATH=$MY_ROOT_INSTALLATION_DIR/bin:$MY_WORK_DIR/install/bin:$PATH
2. LD_LIBRARY_PATH
Adding Root, AliRoot and AliEn to PATH. If FASTJET or ZEROMQ enabled than
we need to add them too.
$ export LD_LIBRARY_PATH=$MY_ALIEN_INSTALLATION_DIR/lib:$MY_ALIEN_INSTALLATION_DIR/api/lib:$LD_LIBRARY_PATH
$ export LD_LIBRARY_PATH=$MY_ROOT_INSTALLATION_DIR/lib:$LD_LIBRARY_PATH
$ export LD_LIBRARY_PATH=$MY_WORK_DIR/install/lib:$LD_LIBRARY_PATH
############################################################################
#Recommended workflow - Developers #
############################################################################
Dear developers,
AliRoot build and install system follows standard CMake procedures.
Please keep a clean, separate distinction between source tree, build and install
directories.
For any change related to the CMake files please follow the instructions inside the
CMakeLists.txt files. Targets are accessible through standard CMake functions.
Try to organize your work in separate folders.
Do not forget to install all the folders/files that are needed at run time, remeber, source
tree and install directory are different locations.
For any question do not hesitate to contact us: aliroot-git-admins@cern.ch
Enjoy your AliRoot development!