-
Notifications
You must be signed in to change notification settings - Fork 1
/
start.html
236 lines (223 loc) · 17.6 KB
/
start.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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!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>Quick Start · 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_alt 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">Quick Start</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"><i class="icon fa fa-paper-plane"></i> Quick Start</h1>
<div class="meta"><i class="fa fa-clock-o"></i> Last updated: Jan 25th, 2016</div>
<div class=doc-content">For full documentation go to the <a href="documentation.html">documentation 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="download-section" class="doc-section">
<h2 class="section-title">Download</h2>
<div class="section-block">
<p> Get hold of the code from <a href="github.com/gammacombo/gammacombo.git">github </a> (see <b>Installation</b>
below for command line instructions).
If you want to push changes back to the repository please push to your own fork and submit a pull
request to the main project.
The most up to date version will usually exist on the <code>development</code> branch which is
sporadically merged with the <code>master</code> branch.
Our policy is never to push directly to the <code>master</code>
</p>
<a href="github.com/gammacombo/gammacombo.git" class="btn btn-green" target="_blank"><i class="fa fa-download"></i> Download GammaCombo from github</a> <br> <br>
<a href="https://github.com/gammacombo/gammacombo#fork-destination-box" class="btn btn-green btn-cta"><i class="fa fa-code-fork"></i>Fork on github</a>
</div>
</section><!--//doc-section-->
<section id="dependencies-section" class="doc-section">
<h2 class="section-title">Dependencies</h2>
<div class=section-block">
<p> GammaCombo has the following package dependencies. It has been tested on both MacOS and Linux platforms.
If you are a CERN user running on lxplus then the environment setup can be automatically handled by the
<code>scripts/setup_lxplus.sh</code> script, otherwise you will require the following:
<ul>
<li>cmake - available <a href="https://cmake.org">here</a>
<li>ROOT (min v5.34.23) - available <a href="https://root.cern.ch">here</a> - ROOT5 and ROOT6 are both compatible
- needs to be compiled with RooFit</li>
<li>RooFit (min v3.60) - see above</li>
<li>Boost (min 1.57.0) - available <a href="http://www.boost.org">here</a></li>
<li>Doxygen - this is <b>OPTIONAL</b> but will build documentation for you - available
<a href="http://www.stack.nl/~dimitri/doxygen/">here</a></li>
</ul>
</p>
</div>
</section><!-- //doc-section-->
<section id="installation-section" class="doc-section">
<h2 class="section-title">Installation</h2>
<div class="section-block">
<p> The following steps will install the code. Note you will need a github user account and will need to setup an ssh key first - see <a href="https://help.github.com/articles/connecting-to-github-with-ssh/">here</a> </p>
<div class="code-block">
<pre><code class="language-bash" style="border: 1px;">git clone [email protected]:gammacombo/gammacombo.git
cd gammacombo
git checkout development
mkdir build
cd build
cmake ..
make # use make -j8 to install on multiple cores
make install </code></pre>
</div><!--//code-block-->
</div><!--//section-block-->
</section><!-- //doc-section-->
<section id="running-section" class="doc-section">
<h2 class="section-title">Running</h2>
<div class="section-block">
<p> For each measurement you would like to perform you should make a subdirectory in the
top level <code>gammacombo</code> directory. There are some tutorials already provided in the
<code>tutorial</code> subdirectory. The majority of the code used for statistical analysis, plotting etc.
is kept in the <code>core</code> subdirectory. The following subsections demonstrate how to run two of the
tutorials.
</p>
</div><!--//section-block-->
<div id="combination-tutorial" class="section-block">
<h3 class="block-title">Combination Tutorial</h3>
<p> A tutorial which combines various measurements of observables which all depend on some common parameters</p>
<p> <a class="scrollto" href="#installation-section" style="color: #58bbee;"> <b>Follow the installation instructions above to install the software</b></a></p>
<div class="code-block">
<h6>Get to the right working directory</h6>
<pre><code class="language-bash" style="border: 1px;">cd ../tutorial # note you should NOT be in the build subdirectory </pre></code>
<h6>Printing out useful information</h6>
<pre><code class="language-bash" style="border: 1px;">bin/tutorial -u # will print the various usage options
bin/tutorial -c 7 --info # will print some information about combination number 7
bin/tutorial -c 7 --info -v # will print detailed information about combination number 7</code></pre>
<h6>Scanning (fitting) for common parameters</h6>
<pre><code class="language-bash" style="border: 1px;">bin/tutorial -c 7 --var a_gaus # likelihood scan for parameter "a_gaus"
bin/tutorial -c 4 -c 7 --var a_gaus --var b_gaus # 2D scan for combinations 4 and 7
bin/tutorial -c 6 --var a_gaus --var b_gaus --scanrange -3:3 --scanrangey -3:3 # scan in a different range </code></pre>
<h6>Plotting (add the <code>-a plot</code> option)</h6>
<pre><code class="language-bash" style="border: 1px;">bin/tutorial -c 4 -c 6 -c 7 --var a_gaus --var b_gaus -a plot # should produce plot shown below</code></pre>
</div><!--//code-block-->
The very last command should produce the plot shown below. <br>
To see the full list of options (of which there are many) run with the <code>-h</code> option.
<div class="screenshot-holder">
<a href="assets/images/tutorial.pdf" target="_blank"><img class="img-responsive" src="assets/images/tutorial.pdf" alt="Combination Tutorial" style="margin: auto;"/></a>
<a class="mask" href="assets/images/tutorial.pdf" target="_blank" style="left: 18.75%; width: 62.5%;"></a>
</div><!--//screenshot-holder-->
</div><!--//section-block-->
<div id="datasets-tutorial" class="section-block">
<h3 class="block-title">Datasets Tutorial</h3>
<p> A tutorial which fits a dataset and measures parameters of the fit model</p>
<p> <a class="scrollto" href="#installation-section" style="color: #58bbee;"> <b>Follow the installation instructions above to install the software</b></a></p>
<div class="code-block">
<h6>Get to the right working directory</h6>
<pre><code class="language-bash" style="border: 1px;">cd ../tutorial # note you should NOT be in the build subdirectory </pre></code>
<h6>Make the workspace for input</h6>
<pre><code class="language-bash" style="border: 1px;">bin/tutorial_dataset_build_workspace # will create the file workspace.root</code></pre>
<h6>Scanning (fitting) for parameter in workspace</h6>
<pre><code class="language-bash" style="border: 1px;">bin/tutorial_dataset --var branchingRatio --scanrange 0:1.e-6 # likelihood scan for parameter "branchingRatio" </code></pre>
<h6>Plotting (add the <code>-a plot</code> option)</h6>
<pre><code class="language-bash" style="border: 1px;">bin/tutorial_dataset --var branchingRatio --scanrange 0:1.e-6 -a plot --cls 1 # add the CLs method as well</code></pre>
</div><!--//code-block-->
The very last command should produce the plot shown below. <br>
To see the full list of options (of which there are many) run with the <code>-h</code> option.
<div class="screenshot-holder">
<a href="assets/images/tutorial_dataset.pdf" target="_blank"><img class="img-responsive" src="assets/images/tutorial_dataset.pdf" alt="Combination Tutorial" style="margin: auto;"/></a>
<a class="mask" href="assets/images/tutorial_dataset.pdf" target="_blank" style="left: 18.75%; width: 62.5%;"></a>
</div><!--//screenshot-holder-->
</div><!--//section-block-->
<div class="section-block">
<div class="callout-block callout-info">
<div class="icon-holder">
<i class="fa fa-info-circle"></i>
</div><!--//icon-holder-->
<div class="content">
<h4 class="callout-title">Full Documentation</h4>
<p>This was just a quick start guide for the full documentation please go to the <a href="documentation.html">documentation</a> page</p>
</div><!--//content-->
</div><!--//callout-block-->
<div class="callout-block callout-success">
<div class="icon-holder">
<i class="fa fa-thumbs-up"></i>
</div><!--//icon-holder-->
<div class="content">
<h4 class="callout-title">Examples</h4>
<p>To see some real life examples (and step by steps guides on how to produce them) go to the <a href="examples.html">examples</a> page</p>
</div><!--//content-->
</div><!--//callout-block-->
</div><!--//section-block-->
</section><!--//doc-section-->
</div><!--//content-inner-->
</div><!--//doc-content-->
<div class="doc-sidebar hidden-xs">
<nav id="doc-nav">
<ul id="doc-menu" class="nav doc-menu" data-spy="affix">
<li><a class="scrollto" href="#download-section">Download</a></li>
<li><a class="scrollto" href="#dependencies-section">Dependencies</a></li>
<li><a class="scrollto" href="#installation-section">Installation</a></li>
<li>
<a class="scrollto" href="#running-section">Running</a>
<ul class="nav doc-sub-menu">
<li><a class="scrollto" href="#combination-tutorial">Combination Tutorial</a></li>
<li><a class="scrollto" href="#datasets-tutorial">Datasets Tutorial</a></li>
</ul><!--//nav-->
</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/" targe="_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>