Commit 76603139 authored by Riccardo Longo's avatar Riccardo Longo
Browse files

Update README.md

parent 3751e268
Pipeline #128009 canceled with stages
#### Joint Calorimeter Prototype Analysis --- JCaPA   #### Joint ZeroDegree Calorimeter Prototype Analysis --- JCaPA  
#### Created by Y.Kulinich, R.Longo and C.Lantz on 12/12/2018 #### #### Created by Y.Kulinich, R.Longo and C.Lantz on 12/12/2018 ####
#### Migrated from CERN to UIUC Gitlab on 14th February 2019 ####
Basic structure defined and discussed during the Thursday meeting on 12/13/2018 Basic structure defined and discussed during the Thursday meeting on 12/13/2018
...@@ -20,19 +21,19 @@ The 2018_Utils folder will be meant to contain useful files for 2018 test beam a ...@@ -20,19 +21,19 @@ The 2018_Utils folder will be meant to contain useful files for 2018 test beam a
#### CMake and installation #### #### CMake and installation ####
To install the software using cmake will be trivial. To install the software using cmake will be trivial.
In the same folder where you have JCaPA, just do In the same folder where you have JZCaPA, just do
mkdir JCaPA_BUILD mkdir JZCaPA_BUILD
mkdir JCaPA_INSTALL mkdir JZCaPA_INSTALL
at this stage, remember to add to your environment at this stage, remember to add to your environment
export JCaPA=/path/to/your/JCaPA_INSTALL export JZCaPA=/path/to/your/JCaPA_INSTALL
cd JCaPA_BUILD cd JZCaPA_BUILD
cmake -DCMAKE_INSTALL_PREFIX=../JCaPA_INSTALL/ ../JCaPA cmake -DCMAKE_INSTALL_PREFIX=../JZCaPA_INSTALL/ ../JZCaPA
make -j8 make -j8
...@@ -60,7 +61,7 @@ Such changes have been implemented in order to allow also for backward compatibi ...@@ -60,7 +61,7 @@ Such changes have been implemented in order to allow also for backward compatibi
Please note that MonteCarlo support is *DISABLED* by default. This choice is meant to avoid people not interested in MC to install Geant4 and the other dependencies. Please note that MonteCarlo support is *DISABLED* by default. This choice is meant to avoid people not interested in MC to install Geant4 and the other dependencies.
In order to enable it, add the option In order to enable it, add the option
-DJCaPA_ENABLE_MC=YES -DJZCaPA_ENABLE_MC=YES
while cmaking. Please note that you need the Geant4 toolkit (and the corresponding dependencies) to successfully enable the MC support. while cmaking. Please note that you need the Geant4 toolkit (and the corresponding dependencies) to successfully enable the MC support.
More details will come in the future. More details will come in the future.
...@@ -68,14 +69,14 @@ More details will come in the future. ...@@ -68,14 +69,14 @@ More details will come in the future.
#### Doxygen documentation #### #### Doxygen documentation ####
First, check that doxygen is installed on your machine. First, check that doxygen is installed on your machine.
If it's not the case, just check it out using If it's not the case, just check it out using
By default a folder "doxygen" will also be installed in your JCaPA_INSTALL folder. By default a folder "doxygen" will also be installed in your JZCaPA_INSTALL folder.
To obtain the documentation, just execute To obtain the documentation, just execute
doxygen JCaPA_doxy.cnf doxygen JZCaPA_doxy.cnf
This will generate for you $JCaPA/html and $JCaPA/latex folder. This will generate for you $JZCaPA/html and $JZCaPA/latex folder.
If you start $JCaPA/html/index.html with your browser, you will get your doxygen docs (surfable). If you start $JCaPA/html/index.html with your browser, you will get your doxygen docs (surfable).
Alternatively, you can compile the latex static documentation in $JCaPA/latex Alternatively, you can compile the latex static documentation in $JZCaPA/latex
#### Structure of processed data #### #### Structure of processed data ####
...@@ -104,7 +105,7 @@ and ...@@ -104,7 +105,7 @@ and
M branches of size N for the processed data from rcdaqAnalysis. M is an arbitrary number. M branches of size N for the processed data from rcdaqAnalysis. M is an arbitrary number.
#### XML Setting file support - Beta version #### #### XML Setting file support - Beta version ####
Since 29th January you will need to install also xercesc as a dependency to compile JCaPA. This is rather straight forward on machines where you have root access. Since 29th January you will need to install also xercesc as a dependency to compile JZCaPA. This is rather straight forward on machines where you have root access.
You've just to run You've just to run
your_package_installer install xerces-c your_package_installer install xerces-c
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment