RestFrames  v1.0.1 RestFrames HEP Event Analysis Software Library
doc/doxygen_mainpage.md
1 ---
2 RestFrames: HEP Event Analysis Library {#mainpage}
3 =================================
4 Developed by Christopher Rogan (crogan@cern.ch)
5
6 Copyright (c) 2014-2016, Christopher Rogan
7
8 Installation
9 ---
10
11 To build and install **RestFrames** simply cd to the RestFrames home
12 directory and do:
13
14  >$./configure 15 >$ make
16  >$make install 17 18 Note: the above commands will attempt to install **RestFrames** in 19 your /usr/local area. If you do not have write permission for this 20 area, or would like to install **RestFrames** somewhere else, you can 21 replace the >$ ./configure step above with:
22
23  >$./configure --prefix=your_path_here 24 25 For example, you can simply install **RestFrames** in your current 26 directory: 27 28 >$ ./configure --prefix=$PWD 29 30 See the RestFrames/INSTALL file for more details and options about configuring 31 and installing **RestFrames**. 32 33 Examples 34 --- 35 36 The RestFrames distribution includes a collection of examples 37 that can be run from the ROOT command line as macros, or as compiled 38 executables. To run the compiled examples one can type: 39 40 >$ ./examples_example_macro.x
41
42 In order to run these examples as ROOT macros, you must first set the RestFrames environmental
43 variables and library paths for auto-loading of the RestFrames shared library:
44
45  >\$ source setup_RestFrames.sh(csh)
46
47 Example macros can then be run from the ROOT command line by typing:
48
49  root [0] .x examples/example_macro.C+
50
51 NOTE: Running example macros without the + option (without ROOT
52 ACLiC compilation) is currently not supported in ROOT5. In ROOT6,
53 users can run the example macros uncompiled with the CLING
54 interpreter:
55
56  root [0] .x examples/example_macro.C
57
58 or with ACLiC compilation. In this latter case, due to an unresolved
59 issue with automatic loading of shared libraries, users must first
60 declare an instance of a **RestFrames** class in the ROOT command line
61 environment before running the macro:
62
63  root [0] RestFrames::RFKey load_libRestFrames(1);
64  root [1] .x examples/example_macro.C+
65
66 With respect to this last limitation, if users open ROOT from the
67 RestFrames or RestFrames/examples directory the existing
68 rootlogon.C files contained therein with automatically ensure a
69 class instance is declared (assuming the user is not using an
70 alternatice rootlogon.C file).
71
72 A description of each of the available examples can be found in
73 the [examples](/examples/) page.