-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathInstallation.html
159 lines (157 loc) · 7.86 KB
/
Installation.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>OpenANN: Installation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="openann-logo-small.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">OpenANN
 <span id="projectnumber">1.1.0</span>
</div>
<div id="projectbrief">An open source library for artificial neural networks.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Installation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="Requirements"></a>
Requirements</h1>
<p>At the moment we support only the operating systems Linux and MacOS and the compilers GCC and Clang.</p>
<p>The following programs and libraries are required to use <a class="el" href="namespaceOpenANN.html">OpenANN</a>:</p>
<table class="doxtable">
<tr>
<th>Compilation </th><th>Documentation </th><th>Examples </th><th>Python bindings </th><th>Benchmarks </th></tr>
<tr>
<td valign="top"><ul>
<li><a href="http://www.cmake.org" target="_blank">CMake</a></li>
<li>pkg-config</li>
<li><a href="http://eigen.tuxfamily.org" target="_blank">Eigen 3</a></li>
<li>shell</li>
<li>wget</li>
<li>unzip</li>
<li>make </li>
</ul>
</td><td valign="top"><ul>
<li><a href="http://www.stack.nl/~dimitri/doxygen/" target="_blank">doxygen</a></li>
<li><a href="http://www.graphviz.org" target="_blank">Graphviz</a> </li>
</ul>
</td><td valign="top"><ul>
<li>OpenGL</li>
<li>GLUT</li>
<li>libxmu</li>
<li>Qt4 </li>
</ul>
</td><td valign="top"><ul>
<li>Python (header files)</li>
<li>NumPy</li>
<li>Cython </li>
</ul>
</td><td valign="top"><ul>
<li>Python</li>
<li>Matplotlib</li>
<li>SciPy </li>
</ul>
</td></tr>
</table>
<h1><a class="anchor" id="Installation"></a>
Installation</h1>
<p>Go to the OpenANN directory and execute</p>
<div class="fragment"><div class="line">mkdir build</div>
<div class="line">cd build</div>
<div class="line">cmake -D CMAKE_BUILD_TYPE=Release ..</div>
<div class="line">sudo make install</div>
<div class="line">sudo ldconfig</div>
</div><!-- fragment --><h1><a class="anchor" id="BuildConfiguration"></a>
Build Configuration</h1>
<p>The OpenANN build is influenced by some options. These can be set with cmake: </p>
<pre class="fragment">cmake -D <option>=<value> ..
</pre><p> You will see an example in the previous section.</p>
<table class="doxtable">
<tr>
<th>Option </th><th>Description </th><th>Default </th></tr>
<tr>
<td>CMAKE_BUILD_TYPE </td><td>Build configuration. Available options are: Debug, Release. </td><td>Release </td></tr>
<tr>
<td>LOG_LEVEL </td><td><a class="el" href="classOpenANN_1_1Log.html" title="Global logger. ">Log</a> level of the internal logging. Available options are: DISABLED, ERROR, INFO, DEBUG </td><td>INFO </td></tr>
<tr>
<td>PARALLEL_CORES </td><td>Number of CPU cores that OpenANN can use. </td><td>4 </td></tr>
<tr>
<td>ALWAYS_BUILD_DOCUMENTATION </td><td>Add documentation target to default target (i.e. "make all"). </td><td>OFF </td></tr>
<tr>
<td>BUILD_PYTHON </td><td>(De)activate building Python bindings for OpenANN. </td><td>ON </td></tr>
<tr>
<td>EXCLUDE_TESTS_FROM_ALL </td><td>You can build all examples, benchmarks and the test suite with the standard build target when you deactivate this. This might be useful for developers. </td><td>ON </td></tr>
</table>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 9 2014 08:57:52 for OpenANN by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>