Skip to content

Commit ecc91ad

Browse files
update the documentation
1 parent 522e815 commit ecc91ad

File tree

1 file changed

+55
-5
lines changed

1 file changed

+55
-5
lines changed

README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ make test
3838
```
3939
2. Set several required shell variables, needed during the installation and running of the
4040
different software packages. Put these in your shell's rc file (~/.bashrc or ~/.cshrc).
41-
4241
For bash:
4342
```bash
4443
export SIMPATH=~/AlFa
@@ -50,8 +49,6 @@ setenv SIMPATH ~/AlFa
5049
setenv FAIRROOTPATH $SIMPATH/FairRoot
5150
```
5251

53-
#### Minumum installtion (reconstruction only installation)
54-
5552
This installaiton will exclude:
5653

5754
1. Simulation engines (Geant3/4)
@@ -60,7 +57,7 @@ This installaiton will exclude:
6057

6158

6259
##### Step by step installation
63-
Edit the recoonly file in alfa_src, and set your compiler and installation directory.
60+
Edit the "recoonly.conf" file in alfa_src, and set your compiler and installation directory.
6461
(if you went to use ROOT 6 switch it on!)
6562

6663
```bash
@@ -108,7 +105,6 @@ To run the tests do:
108105
# To run test: make new shell, do not define SIMPATH
109106
cd FairRoot/build
110107
make test
111-
112108
```
113109

114110
### Install the [AliceO2](https://github.com/AliceO2Group/AliceO2) software
@@ -117,6 +113,59 @@ If you choosed the minimum installation for ALFA before (in step one above) Alic
117113

118114
Set the variable SIMPATH to your FairSoft/alfasoft installation directory
119115

116+
This installaiton will exclude:
117+
1. Simulation engines (Geant3/4)
118+
2. Event generators (Pythia6/8)
119+
3. VGM, VMC
120+
##### Step by step installation
121+
Edit the recoonly file in alfa_src, and set your compiler and installation directory.
122+
(if you went to use ROOT 6 switch it on!)
123+
```bash
124+
compiler= <your compiler>
125+
debug=yes
126+
optimize=no
127+
geant4_download_install_data_automatic=no
128+
geant4_install_data_from_dir=no
129+
build_root6=no
130+
build_python=no
131+
install_sim=no
132+
SIMPATH_INSTALL= <ALFA_installation_dir>
133+
```
134+
135+
1. Install FairSoft
136+
```bash
137+
git clone https://github.com/FairRootGroup/FairSoft.git alfa_src
138+
cd alfa_src
139+
./configure.sh recoonly
140+
```
141+
2. Install [FairRoot](http://fairroot.gsi.de/?q=node/82)
142+
143+
```bash
144+
# Set the shell variable SIMPATH to the installation directory
145+
export SIMPATH= ALFA_installation_dir
146+
[setenv SIMPATH ALFA_installation_dir]
147+
148+
git clone -b dev https://github.com/FairRootGroup/FairRoot.git
149+
cd FairRoot
150+
mkdir build
151+
cd build
152+
cmake -DCMAKE_INSTALL_PREFIX="FairRoot_installation_dir" ..
153+
make
154+
make install
155+
```
156+
157+
To run the tests do:
158+
```bash
159+
# To run test: make new shell, do not define SIMPATH
160+
cd FairRoot/build
161+
make test
162+
```
163+
164+
### Install the [AliceO2](https://github.com/AliceO2Group/AliceO2) software
165+
166+
If you choosed the minimum installation for ALFA before (in step one above) AliceO2 will not include the simulation and reconstruction packages.
167+
168+
Set the variable SIMPATH to your FairSoft/alfasoft installation directory
120169
```bash
121170
export SIMPATH=ALFA_installation_dir
122171
export FAIRROOTPATH=FairRoot_installation_dir
@@ -146,3 +195,4 @@ To include custom DDS location in the compilation, provide DDS_PATH flag when ca
146195
cmake -DDDS_PATH="/home/username/DDS/0.11.27.g79f48d4/" ..
147196
```
148197

198+

0 commit comments

Comments
 (0)