-
Notifications
You must be signed in to change notification settings - Fork 1
/
documentation.html
154 lines (143 loc) · 10.4 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<!DOCTYPE html>
<!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->
<!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->
<!--[if !IE]><!--> <html lang="en"> <!--<![endif]-->
<head>
<title>Documentation · GammaCombo</title>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<link rel="shortcut icon" href="favicon.ico">
<link href='http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
<!-- Global CSS -->
<link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">
<!-- Plugins CSS -->
<link rel="stylesheet" href="assets/plugins/font-awesome/css/font-awesome.css">
<link rel="stylesheet" href="assets/plugins/prism/prism.css">
<link rel="stylesheet" href="assets/plugins/lightbox/dist/ekko-lightbox.min.css">
<link rel="stylesheet" href="assets/plugins/elegant_font/css/style.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/styles.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body class="body-blue">
<div class="page-wrapper">
<!-- ******Header****** -->
<header id="header" class="header">
<div class="container">
<div class="branding">
<h1 class="logo">
<a href="index.html">
<!--<span aria-hidden="true" class="icon_documents icon"></span>-->
<span class="text-highlight">Gamma</span><span class="text-bold">Combo</span>
</a>
</h1>
</div><!--//branding-->
<ol class="breadcrumb">
<li><a href="index.html">Home</a></li>
<li class="active">Documentation</li>
</ol>
</div><!--//container-->
</header><!--//header-->
<div class="doc-wrapper">
<div class="container">
<div id="doc-header" class="doc-header text-center">
<h1 class="doc-title"><span aria-hidden="true" class="icon icon_documents"></span> Documentation</h1>
<div class="meta"><i class="fa fa-clock-o"></i> Last updated: Jan 25th, 2016</div>
<div class=doc-content">For a quick start guide go to the <a href="start.html">quick start page</a> </div>
<div class=doc-content">For more detailed examples go to the <a href="examples.html">examples page</a> </div>
</div><!--//doc-header-->
<div class="doc-body">
<div class="doc-content">
<div class="content-inner">
<section id="manual" class="doc-section">
<h2 class="section-title">Users manual</h2>
<div class="section-block">
<p>Most of the code is documented in considerable detail in the users manual</p>
<a class="btn btn-green" href="manual.pdf" target="_blank"><i class="fa fa-download"></i>Download Users Manual</a>
</div><!--//section-block-->
</section><!--//doc-section-->
<section id="doxygen" class="doc-section">
<h2 class="section-title">Doxygen</h2>
<div id="projects" class="section-block">
<p> Eventually it would be nice to display the doxygen dynamically on this page however for now it has been compiled and can be found <a href="doxy/index.html">here</a> </p>
<a class="btn btn-green" href="doxy/index.html" target="_blank"><i class="fa fa-eye"></i>Browse Doxygen</a>
</div><!--//section-block-->
</section><!--//doc-section-->
<section id="structure" class="doc-section">
<h2 class="section-title">Code Structure</h2>
<div id="projects" class="section-block">
<p> The code structure can be a little bit confusing but it does have a logic behind it. </p>
<ul>
<li> The top level directory <code>gammacombo</code> contains all the <b>public</b> parts of the code</li>
<li> The bulk of the framework (written in C++) lives in a subdirectory called <code>core</code> </li>
<li> For each measurement / combination you want to perform you should create a subdirectory within the top level <code>gammacombo</code></li>
<li> An example is already provided called <code>tutorial</code> </li>
<li> Several measurements / combinations are performed by this code but they are held <b>privately</b> </li>
<li> If you are a member of the LHCb collaboration you can access them at the CERN GitLab group <a href="https://gitlab.cern.ch/gammacombo">gammacombo</a> </li>
<li> Rather confusingly one of them is also called <code>gammacombo</code> - this performs the LHCb, HFlav and PDG combinations of CKM angle γ </li>
</ul>
<div class="screenshot-holder">
<a href=""><img class="img-responsive" src="assets/images/structure.pdf" alt="structure" /></a>
</div>
</div><!--//section-block-->
</section><!--//doc-section-->
<section id="making" class="doc-section">
<h2 class="section-title">Making your own combiner</h2>
<div id="projects" class="section-block">
<p> In order to make your own combiner you will need to create your own subdirectory
(following the strucutre above) and then inside this: </p>
<ul>
<li> Create the subdirectories <code>include</code> <code>src</code> <code>main</code> </li>
<li> Create a <code>CMakeLists.txt</code> to instruct the compiler (copy the example from tutorial) </li>
<li> Your parameters should be defined in a class which inherits from <code>ParametersAbs</code> - the
header should go in the <code>include</code> directory and the implementation in the <code>src</code>
directory </li>
<li> The class(es) defining your PDFs should inherit from <code>PDF_Abs</code> - with the header and implementation
in <code>include</code> and <code>src</code> respecitively </li>
<li> The executable which you will eventually run should be put in the <code>main</code> directory</li>
<li> You can have your own ROOT or RooFit classes which requires a slight modification to the
<code>CMakeLists.txt</code> file (just edit / uncomment the relevant lines given in the tutorial) </li>
</ul>
<a class="btn btn-green" href="doxy/index.html" target="_blank"><i class="fa fa-eye"></i>Browse Doxygen</a>
</div><!--//section-block-->
</section><!--//doc-section-->
</div><!--//content-inner-->
</div><!--//doc-content-->
<div class="doc-sidebar">
<nav id="doc-nav">
<ul id="doc-menu" class="nav doc-menu hidden-xs" data-spy="affix">
<li><a class="scrollto" href="#manual">Users Manual</a></li>
<li><a class="scrollto" href="#doxygen">Doxygen</a></li>
<li><a class="scrollto" href="#structure">Code Structure</a></li>
<li><a class="scrollto" href="#making">Making your own</a></li>
</ul><!--//doc-menu-->
</nav>
</div><!--//doc-sidebar-->
</div><!--//doc-body-->
</div><!--//container-->
</div><!--//doc-wrapper-->
</div><!--//page-wrapper-->
<footer id="footer" class="footer text-center">
<div class="container">
<!--/* This template is released under the Creative Commons Attribution 3.0 License. Please keep the attribution link below when using for your own project. Thank you for your support. :) If you'd like to use the template without the attribution, you can check out other license options via our website: themes.3rdwavemedia.com */-->
<small class="copyright">Web template by <a href="http://themes.3rdwavemedia.com/" target="_blank">Xiaoying Riley</a></small>
</div><!--//container-->
</footer><!--//footer-->
<!-- Main Javascript -->
<script type="text/javascript" src="assets/plugins/jquery-1.12.3.min.js"></script>
<script type="text/javascript" src="assets/plugins/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="assets/plugins/prism/prism.js"></script>
<script type="text/javascript" src="assets/plugins/jquery-scrollTo/jquery.scrollTo.min.js"></script>
<script type="text/javascript" src="assets/plugins/lightbox/dist/ekko-lightbox.min.js"></script>
<script type="text/javascript" src="assets/plugins/jquery-match-height/jquery.matchHeight-min.js"></script>
<script type="text/javascript" src="assets/js/main.js"></script>
</body>
</html>