/usr/share/doc/python-pebl/html/devguide.html is in python-pebl-doc 1.0.2-2build1.
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 | <!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>Developer’s Guide — Pebl v1.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="top" title="Pebl v1.0.1 documentation" href="index.html" />
<link rel="next" title="Configuration Parameters Reference" href="paramref.html" />
<link rel="prev" title="Tutorial" href="tutorial.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="paramref.html" title="Configuration Parameters Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Pebl v1.0.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="developer-s-guide">
<span id="devguide"></span><h1>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h1>
<p>This page contains information useful for developing pebl (adding code to it),
not for using it. For instructions on using pebl, consult the <a class="reference internal" href="tutorial.html#tutorial"><em>Tutorial</em></a>.</p>
<div class="section" id="setting-up-a-development-environment-for-pebl">
<h2>Setting up a development environment for Pebl<a class="headerlink" href="#setting-up-a-development-environment-for-pebl" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p class="first">Checkout pebl code from the subversion repository:</p>
<div class="highlight-python"><pre>svn co http://pebl-project.googlecode.com/svn/trunk pebl</pre>
</div>
</li>
<li><p class="first">Install development-related dependencies. Install nose (<strong class="command">easy_install nose</strong>)
for unit tests and sphinx (<strong class="command">easy_install sphinx</strong>) for creating
documentation.</p>
</li>
<li><p class="first">Install pebl in development mode. This allows you to make changes to the
source code and have it reflected in the “installed” version of pebl
immediately.:</p>
<div class="highlight-python"><pre>sudo python setup.py build develop</pre>
</div>
</li>
</ol>
<p>You can now modify pebl source code and use the changes simply by importing
pebl. If you modify C or C++ code, you must run <strong class="command">python setup.py
build</strong> again.</p>
</div>
<div class="section" id="coding-guildelines">
<h2>Coding guildelines<a class="headerlink" href="#coding-guildelines" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p class="first">Style guidelines</p>
<blockquote>
<div><p>We follow the python community standard <span class="target" id="index-0"></span><a class="pep reference external" href="http://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a> for coding style although
in-project consistency is more important that strict compliance with
<span class="target" id="index-1"></span><a class="pep reference external" href="http://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a>.</p>
</div></blockquote>
</li>
<li><p class="first">Using pebl.config</p>
<blockquote>
<div><p>Use the <a class="reference internal" href="config.html#module-pebl.config" title="pebl.config: Pebl's configuration system"><tt class="xref py py-mod docutils literal"><span class="pre">pebl.config</span></tt></a> module to parameterize your code. Configuration
should be read during object initialization (in __init__) even if it is not
used until later. Any changes to configuration parameters after object
intialization should not affect your object.</p>
</div></blockquote>
</li>
<li><p class="first">Testing</p>
<blockquote>
<div><p>We’re not religious about following strict unit testing methodologies but ALL
critical code should be accompanied by tests (unit tests are preferred but
doctests are also accepted). Run the unit tests by running
<strong class="command">nosetests -v pebl.test</strong> from any directory. Run unit tests
frequently during development and especially before commiting any code. You
can place test to be run manually in pebl/test.manual but automated unit
tests are strongly preferred.</p>
</div></blockquote>
</li>
</ol>
</div>
<div class="section" id="bug-reports">
<h2>Bug Reports<a class="headerlink" href="#bug-reports" title="Permalink to this headline">¶</a></h2>
<p>Use the Issues tab on the Google code site for all bug reports and proposed
enhancements. When closing a bug, include the subversion revison that
resolves the bug in the comments.</p>
</div>
<div class="section" id="committing-code">
<h2>Committing code<a class="headerlink" href="#committing-code" title="Permalink to this headline">¶</a></h2>
<p>Before you can commit code, I will have to you to the developers list in Google
code. Please email me for this.</p>
</div>
<div class="section" id="thanks-dude">
<h2>Thanks dude<a class="headerlink" href="#thanks-dude" title="Permalink to this headline">¶</a></h2>
<p>And finally, thank you for considering contributing code to Pebl. I envision pebl to be a community resource that can serve as a good base for further research into Bayesian networks. Feel free to contact me with any questions or comments (<a class="reference external" href="mailto:abhikshah%40gmail.com">abhikshah<span>@</span>gmail<span>.</span>com</a>).</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Developer’s Guide</a><ul>
<li><a class="reference internal" href="#setting-up-a-development-environment-for-pebl">Setting up a development environment for Pebl</a></li>
<li><a class="reference internal" href="#coding-guildelines">Coding guildelines</a></li>
<li><a class="reference internal" href="#bug-reports">Bug Reports</a></li>
<li><a class="reference internal" href="#committing-code">Committing code</a></li>
<li><a class="reference internal" href="#thanks-dude">Thanks dude</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="tutorial.html"
title="previous chapter">Tutorial</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="paramref.html"
title="next chapter">Configuration Parameters Reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/devguide.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="paramref.html" title="Configuration Parameters Reference"
>next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorial"
>previous</a> |</li>
<li><a href="index.html">Pebl v1.0.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008, Abhik Shah.
Last updated on Dec 31, 2011.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
</div>
</body>
</html>
|