-
Notifications
You must be signed in to change notification settings - Fork 1
/
install.html
291 lines (162 loc) · 8.17 KB
/
install.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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>3. Installation — BeamParticle 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="author" title="About these documents"
href="about.html"/>
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="BeamParticle 0.1.0 documentation" href="index.html"/>
<link rel="next" title="4. Important links" href="links.html"/>
<link rel="prev" title="2. Release notes" href="releasenotes.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> BeamParticle
</a>
<div class="version">
0.1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="about.html">1. About</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasenotes.html">2. Release notes</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">3. Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">3.1. Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">3.2. Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#debian-or-ubuntu">3.2.1. Debian or Ubuntu</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#building-from-source">3.3. Building from source</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#code">3.3.1. Code</a></li>
<li class="toctree-l3"><a class="reference internal" href="#building-the-deb-package">3.3.2. Building the deb package</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="links.html">4. Important links</a></li>
<li class="toctree-l1"><a class="reference internal" href="contact.html">5. Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">6. Frequently Asked Questions</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BeamParticle</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>3. Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/install.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="installation">
<span id="download-and-install"></span><h1>3. Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="requirements">
<h2>3.1. Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://www.debian.org/">Debian</a> or <a class="reference external" href="http://www.ubuntu.com/">Ubuntu</a> 16.04+</li>
</ul>
<p>Optional:</p>
</div>
<div class="section" id="id1">
<h2>3.2. Installation<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<div class="section" id="debian-or-ubuntu">
<h3>3.2.1. Debian or Ubuntu<a class="headerlink" href="#debian-or-ubuntu" title="Permalink to this headline">¶</a></h3>
<p>There is a deb package (beamparticle-<ver>_x86_64.deb), which directly installs on
base Debian 9 or Ubuntu system (16.04+).</p>
</div>
</div>
<div class="section" id="building-from-source">
<span id="download"></span><h2>3.3. Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline">¶</a></h2>
<p>The following packages must be installed otherwise the NIF (c code) for
eleveldb will fail to build. Note that libssl-dev is required
by snappy (a requirement of eleveldb).</p>
<blockquote>
<div>sudo apt-get install build-essential
sudo apt-get install libssl-dev</div></blockquote>
<div class="section" id="code">
<h3>3.3.1. Code<a class="headerlink" href="#code" title="Permalink to this headline">¶</a></h3>
<p>The development uses git version control and the code can be cloned
as follows:</p>
<blockquote>
<div>git clone <a class="reference external" href="https://github.com/beamparticle/beamparticle">https://github.com/beamparticle/beamparticle</a></div></blockquote>
</div>
<div class="section" id="building-the-deb-package">
<h3>3.3.2. Building the deb package<a class="headerlink" href="#building-the-deb-package" title="Permalink to this headline">¶</a></h3>
<p>Building the package is wrapped in a make target.</p>
<blockquote>
<div>make deb-package</div></blockquote>
</div>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="links.html" class="btn btn-neutral float-right" title="4. Important links" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="releasenotes.html" class="btn btn-neutral" title="2. Release notes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Neeraj Sharma.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>