From 1fe02357f025c30215a3d30979e2784817021086 Mon Sep 17 00:00:00 2001 From: Mohammad Al-Turany Date: Tue, 13 Oct 2015 14:36:02 +0200 Subject: [PATCH 1/4] update the documentation --- README.md | 134 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 105 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 3e0cd6b27ef64..5a47e826c60a4 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,124 @@ + AliceO2 ======= Alice O2 project software. Simulation and reconstraction software for the ALICE experiment at CERN based on ALFA and the FairRoot software. -### Step by Step installation +### Installation of Alfasoft (FairSoft) +Before start installing please be sure that your system has all the required libraries (see [FairSoft/DEPENDENCIES](https://github.com/FairRootGroup/FairSoft/blob/master/DEPENDENCIES)) for details. -1. Install [FairSoft/AlFa](https://github.com/FairRootGroup/FairSoft/tree/dev) +#### Full installation: +The full installation will install all packages on [FairSoft](https://github.com/FairRootGroup/FairSoft/tree/dev) + [DDS](https://github.com/FairRootGroup/DDS) + [FairRoot](https://github.com/FairRootGroup/FairRoot/tree/dev) and [AliROOT]() - we use here "alfa_src" as a directory name, you can change it to what ever you like +This installation: +* Need a fast network connection +* will take the __development__ branches for all above packages. +* It will install Geant4 Data files +* Need about __10 GByte__ of disk space (8.1 for the source and objects files, etc and 2.2 GByte for the installation) - git clone https://github.com/FairRootGroup/FairSoft.git alfa_src - cd alfa_src - ./alfaconfig.sh - # 1) gcc (on Linux) 5) Clang (on OSX) - # 1) No Debug Info - # 2) Internet (install G4 files from internet) - # path: ~/AlFa +##### Step by step installation +1. Install [FairSoft/AlFa](https://github.com/FairRootGroup/FairSoft/tree/dev) - To run the tests do: +we use here "alfa_src" as a directory name, you can change it to what ever you like - cd alfa_src/FairRoot/build_for_alfa/ - make test +```bash +git clone https://github.com/FairRootGroup/FairSoft.git alfa_src +cd alfa_src +./alfaconfig.sh +# 1) gcc (on Linux) 5) Clang (on OSX) +# 1) No Debug Info +# 2) Internet (install G4 files from internet) +# path: ~/AlFa +``` +To run the tests do: +```bash +cd alfa_src/FairRoot/build_for_alfa/ +make test +``` 2. Set several required shell variables, needed during the installation and running of the - different software packages. Put these in your shell's rc file (~/.bashrc or ~/.cshrc). - For bash: +different software packages. Put these in your shell's rc file (~/.bashrc or ~/.cshrc). +For bash: +```bash +export SIMPATH=~/AlFa +export FAIRROOTPATH=$SIMPATH/FairRoot +``` +or for csh: +```bash +setenv SIMPATH ~/AlFa +setenv FAIRROOTPATH $SIMPATH/FairRoot +``` - export SIMPATH=~/AlFa - export FAIRROOTPATH=$SIMPATH/FairRoot +#### Minumum installtion (reconstruction only installation) +This installaiton will exclude: +1. Simulation engines (Geant3/4) +2. Event generators (Pythia6/8) +3. VGM, VMC +##### Step by step installation +Edit the recoonly file in alfa_src, and set your compiler and installation directory. +(if you went to use ROOT 6 switch it on!) +```bash +compiler= +debug=yes +optimize=no +geant4_download_install_data_automatic=no +geant4_install_data_from_dir=no +build_root6=no +build_python=no +install_sim=no +SIMPATH_INSTALL= +``` - or for csh: +1. Install FairSoft +```bash +git clone https://github.com/FairRootGroup/FairSoft.git alfa_src +cd alfa_src +./configure.sh recoonly +``` +2. Install [FairRoot](http://fairroot.gsi.de/?q=node/82) - setenv SIMPATH ~/AlFa - setenv FAIRROOTPATH $SIMPATH/FairRoot +```bash +# Set the shell variable SIMPATH to the installation directory +export SIMPATH= ALFA_installation_dir +[setenv SIMPATH ALFA_installation_dir] + +git clone -b dev https://github.com/FairRootGroup/FairRoot.git +cd FairRoot +mkdir build +cd build +cmake -DCMAKE_INSTALL_PREFIX="FairRoot_installation_dir" .. +make +make install +``` +To run the tests do: + +```bash +# To run test: make new shell, do not define SIMPATH +cd FairRoot/build +make test +``` + +### Install the [AliceO2](https://github.com/AliceO2Group/AliceO2) software -3. Install the [AliceO2] (https://github.com/AliceO2Group/AliceO2) software +If you choosed the minimum installation for ALFA before (in step one above) AliceO2 will not include the simulation and reconstruction packages. - git clone https://github.com/AliceO2Group/AliceO2.git - cd AliceO2 - mkdir build_o2 - cd build_o2 - cmake ../ - # -DBUILD_DOXYGEN=ON ( add this option to cmake to generate the doxygen documentation) - make - . config.sh [or source config.csh] +Set the variable SIMPATH to your FairSoft/alfasoft installation directory + +```bash +export SIMPATH=ALFA_installation_dir +export FAIRROOTPATH=FairRoot_installation_dir +``` + +```bash +git clone https://github.com/AliceO2Group/AliceO2.git +cd AliceO2 +mkdir build_o2 +cd build_o2 +cmake ../ +# -DBUILD_DOXYGEN=ON ( add this option to cmake to generate the doxygen documentation) +make +. config.sh [or source config.csh] +``` ### Generating the doxygen documentation @@ -57,3 +132,4 @@ To include custom DDS location in the compilation, provide DDS_PATH flag when ca ```bash cmake -DDDS_PATH="/home/username/DDS/0.11.27.g79f48d4/" .. ``` + From 522e81543ab5975060b01c8d7416637972be4c85 Mon Sep 17 00:00:00 2001 From: Mohammad Al-Turany Date: Tue, 13 Oct 2015 14:38:53 +0200 Subject: [PATCH 2/4] Correct some layout issues --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5a47e826c60a4..15ec0287981ef 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ make test ``` 2. Set several required shell variables, needed during the installation and running of the different software packages. Put these in your shell's rc file (~/.bashrc or ~/.cshrc). + For bash: ```bash export SIMPATH=~/AlFa @@ -50,13 +51,18 @@ setenv FAIRROOTPATH $SIMPATH/FairRoot ``` #### Minumum installtion (reconstruction only installation) + This installaiton will exclude: -1. Simulation engines (Geant3/4) -2. Event generators (Pythia6/8) -3. VGM, VMC + + 1. Simulation engines (Geant3/4) + 2. Event generators (Pythia6/8) + 3. VGM, VMC + + ##### Step by step installation Edit the recoonly file in alfa_src, and set your compiler and installation directory. (if you went to use ROOT 6 switch it on!) + ```bash compiler= debug=yes @@ -67,16 +73,21 @@ build_root6=no build_python=no install_sim=no SIMPATH_INSTALL= + ``` 1. Install FairSoft + ```bash git clone https://github.com/FairRootGroup/FairSoft.git alfa_src cd alfa_src ./configure.sh recoonly + ``` + 2. Install [FairRoot](http://fairroot.gsi.de/?q=node/82) + ```bash # Set the shell variable SIMPATH to the installation directory export SIMPATH= ALFA_installation_dir @@ -89,6 +100,7 @@ cd build cmake -DCMAKE_INSTALL_PREFIX="FairRoot_installation_dir" .. make make install + ``` To run the tests do: @@ -96,6 +108,7 @@ To run the tests do: # To run test: make new shell, do not define SIMPATH cd FairRoot/build make test + ``` ### Install the [AliceO2](https://github.com/AliceO2Group/AliceO2) software From ecc91ade276c36d50cb24478010665f22ce9930b Mon Sep 17 00:00:00 2001 From: Mohammad Al-Turany Date: Tue, 13 Oct 2015 14:36:02 +0200 Subject: [PATCH 3/4] update the documentation --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 55 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 15ec0287981ef..c565d90d0f044 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ make test ``` 2. Set several required shell variables, needed during the installation and running of the different software packages. Put these in your shell's rc file (~/.bashrc or ~/.cshrc). - For bash: ```bash export SIMPATH=~/AlFa @@ -50,8 +49,6 @@ setenv SIMPATH ~/AlFa setenv FAIRROOTPATH $SIMPATH/FairRoot ``` -#### Minumum installtion (reconstruction only installation) - This installaiton will exclude: 1. Simulation engines (Geant3/4) @@ -60,7 +57,7 @@ This installaiton will exclude: ##### Step by step installation -Edit the recoonly file in alfa_src, and set your compiler and installation directory. +Edit the "recoonly.conf" file in alfa_src, and set your compiler and installation directory. (if you went to use ROOT 6 switch it on!) ```bash @@ -108,7 +105,6 @@ To run the tests do: # To run test: make new shell, do not define SIMPATH cd FairRoot/build make test - ``` ### 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 Set the variable SIMPATH to your FairSoft/alfasoft installation directory +This installaiton will exclude: +1. Simulation engines (Geant3/4) +2. Event generators (Pythia6/8) +3. VGM, VMC +##### Step by step installation +Edit the recoonly file in alfa_src, and set your compiler and installation directory. +(if you went to use ROOT 6 switch it on!) +```bash +compiler= +debug=yes +optimize=no +geant4_download_install_data_automatic=no +geant4_install_data_from_dir=no +build_root6=no +build_python=no +install_sim=no +SIMPATH_INSTALL= +``` + +1. Install FairSoft +```bash +git clone https://github.com/FairRootGroup/FairSoft.git alfa_src +cd alfa_src +./configure.sh recoonly +``` +2. Install [FairRoot](http://fairroot.gsi.de/?q=node/82) + +```bash +# Set the shell variable SIMPATH to the installation directory +export SIMPATH= ALFA_installation_dir +[setenv SIMPATH ALFA_installation_dir] + +git clone -b dev https://github.com/FairRootGroup/FairRoot.git +cd FairRoot +mkdir build +cd build +cmake -DCMAKE_INSTALL_PREFIX="FairRoot_installation_dir" .. +make +make install +``` + +To run the tests do: +```bash +# To run test: make new shell, do not define SIMPATH +cd FairRoot/build +make test +``` + +### Install the [AliceO2](https://github.com/AliceO2Group/AliceO2) software + +If you choosed the minimum installation for ALFA before (in step one above) AliceO2 will not include the simulation and reconstruction packages. + +Set the variable SIMPATH to your FairSoft/alfasoft installation directory ```bash export SIMPATH=ALFA_installation_dir export FAIRROOTPATH=FairRoot_installation_dir @@ -146,3 +195,4 @@ To include custom DDS location in the compilation, provide DDS_PATH flag when ca cmake -DDDS_PATH="/home/username/DDS/0.11.27.g79f48d4/" .. ``` + From 3e661c382bce9308d302e2617e3efe787120586d Mon Sep 17 00:00:00 2001 From: Mohammad Al-Turany Date: Wed, 14 Oct 2015 11:33:16 +0200 Subject: [PATCH 4/4] doxygen exclude dictionaries from documentation correct style in the main README.md --- README.md | 5 ++++- doxygen/doxyfile.in | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c565d90d0f044..4a9359c5195dd 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,11 @@ This installation: ##### Step by step installation 1. Install [FairSoft/AlFa](https://github.com/FairRootGroup/FairSoft/tree/dev) -we use here "alfa_src" as a directory name, you can change it to what ever you like +we use here "alfa_src" as a directory name, you can change it to what ever you like. + ```bash + git clone https://github.com/FairRootGroup/FairSoft.git alfa_src cd alfa_src ./alfaconfig.sh @@ -29,6 +31,7 @@ cd alfa_src # 1) No Debug Info # 2) Internet (install G4 files from internet) # path: ~/AlFa + ``` To run the tests do: diff --git a/doxygen/doxyfile.in b/doxygen/doxyfile.in index 748c7adbc9dcf..5456fc72d5d72 100644 --- a/doxygen/doxyfile.in +++ b/doxygen/doxyfile.in @@ -108,7 +108,7 @@ EXCLUDE = .git/ \ html-docs/ \ doxygen cmake config gconfig geometry input parameters .svn vis EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = G__* ClassImp build_* EXCLUDE_SYMBOLS = EXAMPLE_PATH = EXAMPLE_PATTERNS =