Changes between Version 54 and Version 55 of WorkBook/LibraryInterface

Timestamp:

Dec 16, 2014, 11:59:52 PM (10 years ago)

Author:

Pavel Demin

Comment:

--

WorkBook/LibraryInterface

@@ -1 +1 @@
 == Library Interface ==
 
-Here is an explanation of how Delphes' library can be called from a program.
+Delphes can be used as a library and be included in a third party application.
+To do so, simply download and compile Delphes as explained in the [wiki:WorkBook/QuickTour Quick start guide].
 
-== Installation ==
+This creates among other things the {{{libDelphes.so}}} library that can be dynamically linked to any C++ binary.
+Header files are located in the modules and classes subdirectories:
 
-Commands to download and build the library:
-{{{
-setup ROOT environment variables
+- {{{modules/Delphes.h}}}
+- {{{classes/DelphesClasses.h}}}
+- {{{classes/DelphesFactory.h}}}
 
-wget http://cp3.irmp.ucl.ac.be/downloads/Delphes-3.1.2.tar.gz
-tar -zxf Delphes-3.1.2.tar.gz
-
-cd Delphes-3.1.2
-make -j 4
-
-# library
-ls libDelphes.so
-
-# headers
-ls modules/Delphes.h
-ls classes/DelphesClasses.h
-ls classes/DelphesFactory.h
-
-# config file
-ls examples/delphes_card_CMS.tcl
-}}}
-
-== Complete example ==
-
-A fully functional application using the Delphes library can be found in
-{{{
-readers/DelphesSTDHEP.cpp
-}}}
 
 == Simplified example ==
 
-{{{ReadEvent}}}, {{{ReadParticle}}}, {{{ConvertInput}}} and {{{ConvertOutput}}} functions should be implemented by the library's user.
+The code below shows the basic ingredients to build a standalone application using Delphes. In that template, the {{{ReadEvent}}}, {{{ReadParticle}}}, {{{ConvertInput}}} and {{{ConvertOutput}}} functions should be implemented by the user.
 
 {{{
@@ -178 +156 @@
 }
 }}}
+
+== Complete example ==
+
+A fully functional application using the Delphes library can be found in
+{{{
+readers/DelphesSTDHEP.cpp
+}}}