(r13) GlaSiDGettingStarted < LinearCollider

LinearCollider Web>GlaSiD>GlaSiDGettingStarted (revision 13) (raw view)~~EditAttach~~
---+ Getting Started with SiD DD4HEP

<br />At the moment, our code is committed to the DESY SVN repository, where the core DD4hep software and the CLIC and ILD models are stored as well. This is to make it easier to include !SiD in the standard tests. The latest/work version is labelled !SiD_o1_v03. The XML configuration is located in =lcgeo/SiD/compact/SiD_o1_v01= and the C++ drivers are located in =lcgeo/detector/=.

Browse or check out the code via https://svnsrv.desy.de/websvn/wsvn/General.ddsim/lcgeo

If needed for read access, a new basic account can be registered for anyone, by anyone else who has a grid certificate, at https://svnsrv.desy.de/admin/svn

%TOC%

---+++ Important version notes

We are running on SL6 machines and haven't tried other architectures. Note that you must have =cvmfs= installed (ask your local sysadmin).
Latest update was on 5 Sept 16, using the latest ilcsoft release *v01-17-10* for everything.


---++ Building the detector model (lcgeo)

Download the code and remove some unneeded ILD drivers (these first five steps are to be done one time only):
<verbatim>
svn co https://svnsrv.desy.de/basic/ddsim/lcgeo/trunk lcgeo
rm lcgeo/detector/calorimeter/SHcal*
rm lcgeo/detector/calorimeter/SEcal*
rm lcgeo/detector/CaloTB/CaloPrototype*
mkdir lcgeo/build
</verbatim>

Setup the environment (these steps will have to be repeated at the beginning of every session):
<verbatim>
source /cvmfs/sft.cern.ch/lcg/releases/gcc/4.8.4/x86_64-slc6/setup.sh
source /cvmfs/ilc.desy.de/sw/x86_64_gcc48_sl6/v01-17-10/init_ilcsoft.sh
cd lcgeo/build/
</verbatim>

Prepare the build environment (note the ending double-dots!):
<verbatim>
cmake -DCMAKE_CXX_COMPILER=`which g++` -DCMAKE_C_COMPILER=`which gcc` -C /cvmfs/ilc.desy.de/sw/x86_64_gcc48_sl6/v01-17-10/ILCSoft.cmake ..
</verbatim>

Build the code with
<verbatim>
make -j4
make install
</verbatim>

You will now have to update your environment to include the newly created apps
<verbatim>
source ../bin/thislcgeo.sh
</verbatim>

---+++ Modifying the code 

If you modify the detector model, =lcgeo= needs to be rebuilt. 

If you *add, remove, or move* files from the directories, you have to rerun =cmake= as above (note the double-dots .. at the end)
<verbatim>
cmake -DCMAKE_CXX_COMPILER=`which g++` -DCMAKE_C_COMPILER=`which gcc` -C /cvmfs/ilc.desy.de/sw/x86_64_gcc48_sl6/v01-17-10/ILCSoft.cmake ..
</verbatim>
If you *edit* files (source code) you need re-run =make=:
<verbatim>
make -j4
make install
</verbatim>
(or simply =make -j4 install=)


---++ Running simulation and reconstruction

To run the code, you have to initialise your environment at the beginning of your work *session* (i.e. when starting a new shell, after ssh). 
Remember that you also have to rebuild the code in case you modify any of the source files. 
If you've just built =lcgeo= as above, you've already initialised your environment, so you can [[#Running_simulation][skip the next subsection]]. 

---+++ Session initialisation

You must run these commands *at the beginning of every session* (assuming you are in the =lcgeo= directory):
<verbatim>
source /cvmfs/sft.cern.ch/lcg/releases/gcc/4.8.4/x86_64-slc6/setup.sh
source /cvmfs/ilc.desy.de/sw/x86_64_gcc48_sl6/v01-17-10/init_ilcsoft.sh
source bin/thislcgeo.sh
</verbatim>

Depending on your system, you might have to type the following 7 commands 
<verbatim>
export LCGRELEASES=/cvmfs/sft.cern.ch/lcg/releases/LCG_84
export PYTHONDIR=/cvmfs/sft.cern.ch/lcg/releases/LCG_84/Python/2.7.10/x86_64-slc6-gcc48-opt
export PATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_84/Python/2.7.10/x86_64-slc6-gcc48-opt/bin:$PATH
export LD_LIBRARY_PATH=$PYTHONDIR/lib:$LD_LIBRARY_PATH 
export PYTOOLSDIR=/cvmfs/sft.cern.ch/lcg/releases/LCG_84/pytools/1.9_python2.7/x86_64-slc6-gcc48-opt
export PYTHONPATH=/cvmfs/sft.cern.ch/lcg/releases/LCG_84/pytools/1.9_python2.7/x86_64-slc6-gcc48-opt/lib/python2.7/site-packages:$PYTHONPATH 
export PATH=$PYTOOLSDIR/bin:$PATH
</verbatim>


---+++ Running  simulation

Assuming you are in the =lcgeo= directory (else do =cd ../=), and that you have *initialised your session as above*, do
<verbatim>
python example/lcio_particle_gun.py
ddsim --compactFile=SiD/compact/SiD_o1_v01/SiD_o1_v03.xml --runType=batch --inputFile mcparticles.slcio -N=1 --outputFile=testSiD_o1_v03.slcio
</verbatim>

Then to inspect the output use:
<verbatim>
dumpevent testSiD_o1_v03.slcio 1
</verbatim>
or
<verbatim>
anajob testSiD_o1_v03.slcio
</verbatim>

---+++ Running reconstruction

Use the latest [[%PUBURLPATH%/%WEB%/%TOPIC%/SiDReconstruction_v03_160711.xml][SiDReconstruction.xml]] attached to this twiki page. You also need to have the basic [[%PUBURLPATH%/%WEB%/%TOPIC%/gear_sid.xml][gear_sid.xml]] file in your directory. For example (assuming you are in the =lcgeo= directory):
<verbatim>
wget https://twiki.ppe.gla.ac.uk/pub/LinearCollider/GlaSiDGettingStarted/SiDReconstruction_v03_160711.xml
wget https://twiki.ppe.gla.ac.uk/pub/LinearCollider/GlaSiDGettingStarted/gear_sid.xml
</verbatim>

Once you've done this, and assuming you are still in the =lcgeo= directory, and you have *initialised your session as above*, run
<verbatim>
Marlin SiDReconstruction_v03_160711.xml
</verbatim>
and this will produce a file named =sitracks.slcio= located in the current directory.

---+++ Visualizing the output using CED

Note that for the event display to work I had to ask my local sysadmin to install *freeglut* (e.g. for SLC6, =freeglut-2.6.0-1.el6.x86_64=) so that the library =libglut.so= was available. Point to a CED installation with glced:
<verbatim>
export PATH=/cvmfs/ilc.desy.de/sw/x86_64_gcc44_sl6/CED/v01-09-02/bin/:$PATH
</verbatim>

This needs a few extra parameters that were missing from the =SiD_o1_v03.xml= in =v01-17-10=, so put the modified =SiD_o1_v03a.xml= attached to this page in your local =lcgeo/SiD/compact/SiD_o1_v01/= directory.
You may need to make the following environment modification, depending on your local machine and how you connect to it:
<verbatim>
unset LIBGL_ALWAYS_INDIRECT
</verbatim>

Then run, assuming you are still in the lcgeo directory:
<verbatim>
ced2go -d SiD/compact/SiD_o1_v01/SiD_o1_v03.xml sitracks.slcio
</verbatim>

---++ Analysing the output

We could run a simple analysis and draw a few plots. For this let us re-run =ddsim= and =ddreco= with a few more events
<verbatim>
ddsim --compactFile=SiD/compact/SiD_o1_v01/SiD_o1_v03.xml --runType=batch --inputFile mcparticles.slcio -N=1000 --outputFile=testSiD_o1_v03.slcio
Marlin SiDReconstruction_v03_160711.xml
</verbatim>
Now the files  =testSiD_o1_v03.slcio=  and =sitracks.slcio= each contain 1000 events.

Our example analysis code can be found [[%PUBURLPATH%/%WEB%/%TOPIC%/TrackAna.tgz][here]], and it will contain
<verbatim>
CMakeLists.txt
gear_sid.xml  
HitResiduals.xml
include/fpcompare.h
include/LinkDef.h  
include/HitResiduals.h
src/HitResiduals.cc
</verbatim>
Assuming you are in the lcgeo directory, and you have *initialised your session as above*, let us compile the example with:
<verbatim>
cd Tracking
mkdir build lib
cd build
cmake -DCMAKE_CXX_COMPILER=`which g++` -DCMAKE_C_COMPILER=`which gcc` \
  -DILCUTIL_DIR=/cvmfs/ilc.desy.de/sw/x86_64_gcc48_sl6/v01-17-10/ilcutil/v01-03/ -C $ILCSOFT/ILCSoft.cmake ..
make -j4 install
</verbatim>

Now we run processor with
<verbatim>
cd ../
CWD=`pwd`
export MARLIN_DLL=$MARLIN_DLL:$CWD/lib/libTrackAna.so
Marlin HitResiduals.xml
</verbatim>
This will produce a file named =hitresiduals.root= which contains something like this: 
 
<img src="%PUBURLPATH%/%WEB%/%TOPIC%/resX.png" alt="resX.png" width="899" height="633" /> 

   * [[%PUBURLPATH%/%WEB%/%TOPIC%/SiDReconstruction_v03_160711.xml][SiDReconstruction_v03_160711.xml]]: Tutorial reconstruction XML
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
xml	SiDReconstruction_v03_160711.xml	r2 r1	manage	37.4 K	2016-09-21 - 17:58	DanProtopopescu	Tutorial reconstruction XML
xml	SiD_o1_v03a.xml	r1	manage	8.4 K	2016-09-07 - 11:27	AidanRobson	minor modified SiD_o1_v03.xml for ced event display
tgz	TrackAna.tgz	r1	manage	6.9 K	2016-09-19 - 16:24	DanProtopopescu	Track analysis example
xml	gear_sid.xml	r1	manage	0.3 K	2016-09-05 - 13:47	AidanRobson	basic gear file to satisfy reconstruction
png	resX.png	r1	manage	41.1 K	2016-09-19 - 16:22	DanProtopopescu	resX example plot
Topic revision: r13 - 2016-09-21 - DanProtopopescu
LinearCollider