This file is indexed.

/usr/share/doc/python-pebl/html/install.html is in python-pebl-doc 1.0.2-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<!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/html; charset=utf-8" />
    
    <title>Installation &#8212; Pebl 1.0.1 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.0.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Pebl 1.0.1 documentation" href="index.html" />
    <link rel="next" title="Tutorial" href="tutorial.html" />
    <link rel="prev" title="Pebl Introduction" href="intro.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head>
  <body role="document">
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Unfortunatly, installing pebl is not a one-stop process although it should take
no longer than a few minutes. If you experience any problems, please contact me
at <a class="reference external" href="mailto:abhikshah&#37;&#52;&#48;gmail&#46;com">abhikshah<span>&#64;</span>gmail<span>&#46;</span>com</a>.</p>
<p>Pebl is known to run on Linux and Mac OSX and should also run on Windows and
any platform that supports Python 2.5 and numpy. Pebl depends on the following
packages:</p>
<blockquote>
<div><ul class="simple">
<li>Numpy: tested with version 1.0.4 but should work with other recent versions</li>
<li>Pydot: tested with version 1.0.2</li>
<li>Matplotlib (optional): tested with version 0.91.2 but should work with other
recent versions</li>
<li>Graphviz (optional): any recent version of dot and neato</li>
<li>IPython1 (optional): curently, require r2815 from svn trunk</li>
<li>boto (optional): any recent version</li>
</ul>
</div></blockquote>
<div class="section" id="install-python-2-5">
<h2>Install Python 2.5<a class="headerlink" href="#install-python-2-5" title="Permalink to this headline"></a></h2>
<p>Check what version of Python you have with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">--</span><span class="n">version</span>
</pre></div>
</div>
<p>You can download Python 2.5 from <a class="reference external" href="http://python.org/download">http://python.org/download</a></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Pebl requires Python 2.5 or greater and will not run under earlier versions.</p>
</div>
</div>
<div class="section" id="install-easy-install">
<h2>Install easy_install<a class="headerlink" href="#install-easy-install" title="Permalink to this headline"></a></h2>
<p>easy_install lets you install python packages and their requirements in one
easy step. Unfortunately, easy_install is not distributed with python and needs
to be installed separately.</p>
<ol class="arabic simple">
<li>Download ez_setup.py from <a class="reference external" href="http://peak.telecommunity.com/dist/ez_setup.py">http://peak.telecommunity.com/dist/ez_setup.py</a></li>
<li>Run <strong class="command">python ez_setup.py</strong> to install easy_install</li>
</ol>
<p>Run <strong class="command">easy_install --help</strong> to make sure that it is in your path. On
unix-type systems, it is usually installed in /usr/bin/ and on Windows in
C:\Python2.5\Scripts\</p>
</div>
<div class="section" id="install-numpy">
<h2>Install Numpy<a class="headerlink" href="#install-numpy" title="Permalink to this headline"></a></h2>
<p>Numpy can be tricky to install because it require C and Fortran compilers and
several libraries. You can try installing it from source using easy_install:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">numpy</span>
</pre></div>
</div>
<p>If that doesn&#8217;t work or if you&#8217;d rather install using a binary package, consult
<a class="reference external" href="http://www.scipy.org/Download">http://www.scipy.org/Download</a>.</p>
</div>
<div class="section" id="install-pebl">
<h2>Install Pebl<a class="headerlink" href="#install-pebl" title="Permalink to this headline"></a></h2>
<p>You can now install (or upgrade) pebl and it&#8217;s required dependencies using
easy_install:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">pebl</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The current version of Pebl is 1.0.1</p>
</div>
<p>If you have downloaded the source code for Pebl (or installing pebl from svn),
you can run <strong class="command">sudo python setup.py install</strong> from pebl&#8217;s root directory
instead.</p>
</div>
<div class="section" id="testing-pebl-installation">
<h2>Testing Pebl Installation<a class="headerlink" href="#testing-pebl-installation" title="Permalink to this headline"></a></h2>
<p>To test pebl installation, you can run the automated unit tests by first install nose:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">nose</span>
</pre></div>
</div>
<p>and then running nose from the command line, in any directory:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">nosetests</span> <span class="o">-</span><span class="n">v</span> <span class="n">pebl</span><span class="o">.</span><span class="n">test</span>
</pre></div>
</div>
<p>If you haven&#8217;t installed all the optional dependencies, certain tests will fail
but the name of the tests should make it clear whether it&#8217;s a normal feature or
an optional one.</p>
</div>
<div class="section" id="installing-optional-dependencies">
<h2>Installing optional dependencies<a class="headerlink" href="#installing-optional-dependencies" title="Permalink to this headline"></a></h2>
<p>Certain features of pebl require additional dependencies. You only need to
install these if you need the optional features. Without the optional features,
you can load data, learn networks and output networks in dot format, although
not as an image. If installing pebl on a cluster, the optional features are
only necessary on the controller or the machine used  interactively by the
user.</p>
<div class="section" id="for-creating-html-reports-of-pebl-results">
<h3>For creating HTML reports of Pebl results<a class="headerlink" href="#for-creating-html-reports-of-pebl-results" title="Permalink to this headline"></a></h3>
<p>Pebl uses Graphviz to visualize networks and matplotlib for plotting. If using
Pebl on a cluster, these don&#8217;t need to be installed on the worker nodes.</p>
<ol class="arabic simple">
<li>Install Graphviz from <a class="reference external" href="http://www.graphviz.org/Download.php">http://www.graphviz.org/Download.php</a></li>
<li>Install matplotlib from <a class="reference external" href="http://matplotlib.sourceforge.net/installing.html">http://matplotlib.sourceforge.net/installing.html</a></li>
</ol>
<p>Finally, install simplejson using easy_install:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">simplejson</span>
</pre></div>
</div>
<p>simplejson sometimes fails to install on Windows. In that case, you can use a
binary package:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">pebl</span><span class="o">-</span><span class="n">project</span><span class="o">.</span><span class="n">googlecode</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">files</span><span class="o">/</span><span class="n">simplejson</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">3</span><span class="o">-</span><span class="n">py2</span><span class="o">.</span><span class="mi">5</span><span class="o">-</span><span class="n">win32</span><span class="o">.</span><span class="n">egg</span>
</pre></div>
</div>
<p>To test the html-report feature, run:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">nosetests</span> <span class="o">-</span><span class="n">v</span> <span class="n">pebl</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">test_result</span><span class="p">:</span><span class="n">TestHtmlReport</span>
</pre></div>
</div>
</div>
<div class="section" id="for-the-xgrid-task-controller">
<h3>For the XGrid Task Controller<a class="headerlink" href="#for-the-xgrid-task-controller" title="Permalink to this headline"></a></h3>
<p>Apple XGrid is a grid solution for Apple computers that lets desktops and
dedicated servers be used in a computational grid.</p>
<p>The Xgrid task controller only runs on platforms where XGrid is available
(currently, only Mac OSX). Pebl uses the PyXG package to access the XGrid
controller:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">PyXg</span>
</pre></div>
</div>
<p>To test the XGrid feature, find the location where pebl was installed by
easy_install and navigate to the src/pebl/test.manual directory.  There, create
a file called xgridconfig.txt and include the relevant configuration
parameters. The file should look like:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">xgrid</span><span class="p">]</span>
<span class="n">controller</span> <span class="o">=</span> <span class="n">your</span><span class="o">.</span><span class="n">controller</span><span class="o">.</span><span class="n">com</span>
<span class="n">password</span> <span class="o">=</span> <span class="n">yourpassword</span>
<span class="n">grid</span> <span class="o">=</span> <span class="n">gridnumber</span>
<span class="n">pollinterval</span> <span class="o">=</span> <span class="mi">30</span>
</pre></div>
</div>
<p>Then, execute the test_xgrid.py test:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">test_xgrid</span><span class="o">.</span><span class="n">py</span> <span class="n">xgridconfig</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p>Pebl will create and run 10 short learners over the XGrid. It will print some
information about submitting and retrieving data from the Xgrid controller and
finally print a list of machines where the tasks ran.</p>
</div>
<div class="section" id="for-the-ipython1-task-controller">
<h3>For the IPython1 Task Controller<a class="headerlink" href="#for-the-ipython1-task-controller" title="Permalink to this headline"></a></h3>
<p>IPython1 is the next version of the popular IPython shell that also includes an
interactive, clustering solution. Pebl can use IPython1 to execute learners in
parallel.</p>
<p>You will need to install both IPython and IPython1.  IPython1 is in active
development and pebl requires a specific version. Once, IPython1 is oficially
released, we will use that package:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">ipython</span>

<span class="n">svn</span> <span class="n">co</span> <span class="o">-</span><span class="n">r</span> <span class="mi">2815</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">ipython</span><span class="o">.</span><span class="n">scipy</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">svn</span><span class="o">/</span><span class="n">ipython</span><span class="o">/</span><span class="n">ipython1</span><span class="o">/</span><span class="n">trunk</span> <span class="n">ipython1</span><span class="o">-</span><span class="mi">2815</span>
<span class="n">cd</span> <span class="n">ipython1</span><span class="o">-</span><span class="mi">2815</span>
<span class="n">sudo</span> <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
<p>To test the IPython1 feature, make sure that IPython1&#8217;s ipcluster is in the
path and run:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">nosetests</span> <span class="o">-</span><span class="n">v</span> <span class="n">pebl</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">test_taskcontroller</span><span class="p">:</span><span class="n">TestIPython1TC</span>
</pre></div>
</div>
<p>The test will create three local IPython1 engines and run tasks on them. The
test cannot, unfortunately, terminate the engines and that needs to be done
manually. Simply run &#8216;ps&#8217; and terminate the appropriate processes.</p>
</div>
<div class="section" id="for-the-ec2-task-controller">
<h3>For the EC2 Task Controller<a class="headerlink" href="#for-the-ec2-task-controller" title="Permalink to this headline"></a></h3>
<p>Amazon EC2 is an on-demand cloud computing solution from Amazon. It allows
users to rent computing power on an as-needed basis. Pebl can reserve, create,
use and terminate EC2 instances automatically. More information available at
<a class="reference external" href="http://aws.amazon.com/ec2/">http://aws.amazon.com/ec2/</a></p>
<p>Before you can use Amazon&#8217;s EC2 platform, you need to register with Amazon and
create the required authentication credentials.  Consult the <a class="reference external" href="http://docs.amazonwebservices.com/AWSEC2/2008-02-01/GettingStartedGuide/">Getting Started
Guide</a> at
Amazon for further information.</p>
<p>Pebl uses the boto package to interact with EC2:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">boto</span>
</pre></div>
</div>
<p>Also see the instructions above for installing dependencies for the IPython1
Task Controller (which is required by the EC2 Task Controller).</p>
<p>To test the EC2 feature, find the location where pebl was installed by
easy_install and navigate to the src/pebl/test.manual directory.  There, create
a file called ec2config.txt and include the relevant configuration
parameters. The file should look like:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">EC2</span><span class="p">]</span>
<span class="n">access_key</span> <span class="o">=</span> <span class="n">YOUR_AMAZON_ACCESSKEY</span>
<span class="n">secret_access_key</span> <span class="o">=</span> <span class="n">YOUR_AMAZON_SECRET_ACCESS_KEY</span>

<span class="n">ami</span> <span class="o">=</span> <span class="n">ami</span><span class="o">-</span><span class="mi">66</span><span class="n">a3470f</span>    <span class="c1"># or any AMI with pebl, IPython1 and svn installed</span>
<span class="n">key_name</span> <span class="o">=</span> <span class="n">keyname</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">use</span>
<span class="n">credential</span> <span class="o">=</span> <span class="o">~/</span><span class="n">foo</span><span class="o">/</span><span class="n">private</span><span class="o">-</span><span class="n">key</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">use</span>
</pre></div>
</div>
<p>Then, execute the test_ec2.py test:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">test_ec2</span><span class="o">.</span><span class="n">py</span> <span class="n">ec2config</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p>Pebl will reserve and use 3 EC2 instances, upgrade the version of pebl
installed, run 10 shorts tasks on them and terminate the instances when
finished. If all works sucessfully, Pebl will print the hostnames of the
machines used.</p>
</div>
<div class="section" id="for-developing-pebl">
<h3>For developing Pebl<a class="headerlink" href="#for-developing-pebl" title="Permalink to this headline"></a></h3>
<p>Pebl developers will also need nose for testing and sphinx for generating html
documentation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">easy_install</span> <span class="n">nose</span>
<span class="n">easy_install</span> <span class="n">sphinx</span>
</pre></div>
</div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#install-python-2-5">Install Python 2.5</a></li>
<li><a class="reference internal" href="#install-easy-install">Install easy_install</a></li>
<li><a class="reference internal" href="#install-numpy">Install Numpy</a></li>
<li><a class="reference internal" href="#install-pebl">Install Pebl</a></li>
<li><a class="reference internal" href="#testing-pebl-installation">Testing Pebl Installation</a></li>
<li><a class="reference internal" href="#installing-optional-dependencies">Installing optional dependencies</a><ul>
<li><a class="reference internal" href="#for-creating-html-reports-of-pebl-results">For creating HTML reports of Pebl results</a></li>
<li><a class="reference internal" href="#for-the-xgrid-task-controller">For the XGrid Task Controller</a></li>
<li><a class="reference internal" href="#for-the-ipython1-task-controller">For the IPython1 Task Controller</a></li>
<li><a class="reference internal" href="#for-the-ec2-task-controller">For the EC2 Task Controller</a></li>
<li><a class="reference internal" href="#for-developing-pebl">For developing Pebl</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="intro.html" title="previous chapter">Pebl Introduction</a></li>
      <li>Next: <a href="tutorial.html" title="next chapter">Tutorial</a></li>
  </ul></li>
</ul>
</div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/install.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2016, Abhik Shah.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
      
      |
      <a href="_sources/install.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>