Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Riccardo Longo
JZCaPA
Commits
22db3325
Commit
22db3325
authored
Dec 15, 2018
by
Riccardo Longo
Browse files
Updated README.md file
parent
c2dc32ce
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
22db3325
...
...
@@ -5,21 +5,17 @@ Basic structure defined and discussed during the Thursday meeting on 12/13/2018
JCaPA
Analysis
include
src
userFunctions
include
src
userFunctions
MC (to be implemented)
2018_Utils (
to be added
)
2018_Utils (
empty for the moment
)
The project is cmake based, so you need a reasonably new cmake version ( version > 2.8 )
The standalone Analysis part requires only a root installation (https://root.cern.ch)
The MC part will be conditional since it requires additional software as Geant4 and all its dependencies
The corresponding README part will be written once MC will be included.
The 2018_Utils folder will be meant to contain useful files for 2018 test beam analysis (e.g. Summary of various scans etc)
The project is cmake based, so you need a reasonably new cmake version ( version > 2.8 )
The standalone Analysis part requires only a root installation (https://root.cern.ch)
The MC part will be conditional since it requires additional software as Geant4 and all its dependencies
The corresponding README part will be written once MC will be included.
The 2018_Utils folder will be meant to contain useful files for 2018 test beam analysis (e.g. Summary of various scans etc)
#### CMake and installation ####
To install the software using cmake will be trivial.
...
...
@@ -50,13 +46,20 @@ Please check AnalysisExample.cpp if you're looking for a basic template.
Two main classes are provided at the moment:
-
DataReader
-
WFAnalysis (inherits from Analysis.h)
They are well commented by Yakov for each available method.
A doxygen documentation can also be created following the instruction below
They are well commented by Yakov for each available method.
A doxygen documentation can also be created following the instruction below
.
#### Doxygen documentation ####
First, check that doxygen is installed on your machine.
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.
First, check that doxygen is installed on your machine.
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.
To obtain the documentation, just execute
doxygen JCaPA_doxy.cnf
This will generate for you $JCaPA/html and $JCaPA/latex folder.
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
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment