[49c03f]: doc / html / about_pyke / installing_pyke.html  Maximize  Restore  History

Download this file

291 lines (276 with data), 14.7 kB

  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
<!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" lang="en" xml:lang="en">
<head>
<title>Installing Pyke</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="../stylesheets/pyke.css" type="text/css" />
</head>
<body>
<table id="page-table">
<thead class="head">
<tr id="header1"><th id="header" colspan="3">
&nbsp;
</th></tr>
<tr id="header2">
<th id="crumb-left"></th>
<th id="crumb-line">
<div id="nav">
<ul>
<li><a href="../index.html">Home</a></li>
<li>&gt;</li>
<li><a href="index.html">About Pyke</a></li>
<li>&gt;</li>
<li>Installing Pyke</li>
</ul>
</div>
</th>
<th id="crumb-right"></th>
</tr>
</thead>
<tbody id="body">
<tr id="body-tr">
<td id="left-nav">
<div id="left-nav-div">
<div class="title-nav"><a href="../index.html">Home</a></div><div class="nav-branch">
<div class="title-nav"><a href="index.html">About Pyke</a></div><div class="nav-branch">
<div class="normal-nav"><a href="cooking_functions.html">Cooking Functions</a></div>
<div class="normal-nav"><a href="what_is_pyke.html">What is Pyke?</a></div>
<div class="normal-nav"><a href="steps_to_using_pyke.html">Steps to Using Pyke</a></div>
<div class="normal-nav"><a href="installing_pyke.html">Installing Pyke</a></div>
</div>
<div class="normal-nav"><a href="../logic_programming/index.html">Logic Programming</a></div>
<div class="normal-nav"><a href="../knowledge_bases/index.html">Knowledge Bases</a></div>
<div class="normal-nav"><a href="../pyke_syntax/index.html">Pyke Syntax</a></div>
<div class="normal-nav"><a href="../using_pyke.html">Using Pyke</a></div>
<div class="normal-nav"><a href="../examples.html">Examples</a></div>
<div class="normal-nav"><a href="../PyCon2008-paper.html">PyCon 2008 Paper</a></div>
</div>
</div>
<div id="icons">
<div id="project-page">
<a href="http://sourceforge.net/projects/pyke/">Pyke Project Page</a>
</div>
Please Make a Donation:<br />
<a href="http://sourceforge.net/donate/index.php?group_id=207724">
<img src="http://images.sourceforge.net/images/project-support.jpg"
width="88" height="32" border="0"
alt="Support This Project" /> </a> <br /><br />
Hosted by: <br />
<a href="http://sourceforge.net/projects/pyke">
<img src="http://sflogo.sourceforge.net/sflogo.php?group_id=207724&amp;type=14"
width="150" height="40"
alt="Get Python Knowledge Engine (PyKE) at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>
</div>
</td>
<td id="main-td">
<div id="main">
<a name="startcontent" id="startcontent"></a>
<div class="document" id="installing-pyke">
<h1 class="title">Installing Pyke</h1>
<div class="section" id="index-to-this-page">
<h2>Index to This Page</h2>
<ul class="simple">
<li><a class="reference internal" href="#licensing">Licensing</a></li>
<li><a class="reference internal" href="#system-requirements">System Requirements</a></li>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#installing-the-executables">Installing the Executables</a></li>
<li><a class="reference internal" href="#installing-the-sources">Installing the Sources</a></li>
<li><a class="reference internal" href="#installing-the-examples">Installing the Examples</a></li>
<li><a class="reference internal" href="#installing-the-html-documentation">Installing the HTML Documentation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#mercurial-repositories">Mercurial Repositories</a><ul>
<li><a class="reference internal" href="#repository-directory-structure">Repository Directory Structure</a></li>
</ul>
</li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
</ul>
</div>
<div class="section" id="licensing">
<h2>Licensing</h2>
<p>This software is licensed under the MIT license:</p>
<pre class="literal-block">
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the &quot;Software&quot;), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
</pre>
</div>
<div class="section" id="system-requirements">
<h2>System Requirements</h2>
<p>Pyke is 100% Python, so it should run on any platform supported by Python.
So all you'll need is <a class="reference external" href="http://www.python.org">Python</a> 2.5 or 2.6.</p>
</div>
<div class="section" id="installation">
<h2>Installation</h2>
<div class="section" id="installing-the-executables">
<h3>Installing the Executables</h3>
<p>Pyke is registered on <a class="reference external" href="http://pypi.python.org/pypi">pypi</a>, so once you have <a class="reference external" href="http://www.python.org">Python</a> 2.5 or 2.6 with
<a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> you can just type (as root):</p>
<pre class="literal-block">
# easy_install pyke
</pre>
</div>
<div class="section" id="installing-the-sources">
<h3>Installing the Sources</h3>
<p>The source code for the latest release can be found on the <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project
download page</a> as <tt class="docutils literal"><span class="pre">pyke-&lt;release&gt;.tar.gz</span></tt>.</p>
<p>If you want the latest developer version, read <a class="reference internal" href="#mercurial-repositories">Mercurial Repositories</a>,
below.</p>
</div>
<div class="section" id="installing-the-examples">
<h3>Installing the Examples</h3>
<p>There are several examples that are contained in the source directory.
There is a README file for each one that explains how to run it.</p>
<p>These are in the source directory in the <tt class="docutils literal"><span class="pre">examples</span></tt> subdirectory.
To download just the examples (for example, if you used easy_install to
install Pyke), download the <tt class="docutils literal"><span class="pre">pyke_examples-&lt;release&gt;.tar.gz</span></tt> file.</p>
<p>See also <a class="reference external" href="../examples.html">Examples</a>.</p>
</div>
<div class="section" id="installing-the-html-documentation">
<h3>Installing the HTML Documentation</h3>
<p>If you'd like to view this html documentation from you hard drive,
it is in the source directory (doc/html), or you can download just the
documentation itself as <tt class="docutils literal"><span class="pre">pyke_doc_html-&lt;release&gt;.zip</span></tt> file from the
<a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project download page</a>.</p>
</div>
</div>
<div class="section" id="mercurial-repositories">
<h2>Mercurial Repositories</h2>
<p>With <a class="reference external" href="http://mercurial.selenic.com/wiki/">mercurial</a>, you clone the entire repository locally on your computer.
Then you can make changes and commit those changes to your local repository.
If you think those changes might be interesting to everybody, make your local
repository (or a clone of it) publically available (either on your own server,
or on one of the <a class="reference external" href="http://mercurial.selenic.com/wiki/MercurialHosting">mercurial hosting sites</a>) and send me an email. I will
examine your changes and pull them into the master repository on sourceforge.</p>
<p>To clone the development version of the entire project (including the
<a class="reference external" href="../examples.html">examples</a> and this documentation) into a directory called <em>foobar</em>:</p>
<pre class="literal-block">
$ hg clone http://pyke.hg.sourceforge.net:8000/hgroot/pyke/pyke foobar
</pre>
<p>Or to clone the latest release 1 branch:</p>
<pre class="literal-block">
$ hg clone http://pyke.hg.sourceforge.net:8000/hgroot/pyke/release_1 foobar
</pre>
<p>Use the <em>release_1</em> repository for any work that improves the quality of the
code (bug fixes, code formatting, comments, documentation) that won't break
existing programs and can go into the next point release.</p>
<p>Use the <em>pyke</em> repository for new features that will go into the next major
release. I merge all the changes done in the release_1 repository into the
pyke repository.</p>
<p>Finally, use the <em>pre_2to3</em> repository for any work that is specific to the
Python3 version of PyKE. Just don't run 2to3 in directly in your working
directory because it will change all of the .py files and we don't want those
changes committed! I merge all the changes done in the pyke repository
into the pre_2to3 repository.</p>
<div class="section" id="repository-directory-structure">
<h3>Repository Directory Structure</h3>
<p>You'll see the following directories.</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">doc</span></tt><ul>
<li>See <a class="reference internal" href="#documentation">Documentation</a>, below.</li>
</ul>
</li>
<li><tt class="docutils literal"><span class="pre">examples</span></tt><ul>
<li>There are several examples. Start with <em>family_relations</em>. Look at the
<tt class="docutils literal"><span class="pre">README</span></tt> file for each example to see how to run it. See also,
<a class="reference external" href="../examples.html">Examples</a>.</li>
</ul>
</li>
<li><tt class="docutils literal"><span class="pre">pyke</span></tt><ul>
<li>This is the top-level Python package directory for the Python sources.
This needs to be in a directory on your <tt class="docutils literal"><span class="pre">PYTHONPATH</span></tt>.
The sources for the compilers are in the <tt class="docutils literal"><span class="pre">krb_compiler</span></tt> subdirectory,
which is expected to be a subpackage of <tt class="docutils literal"><span class="pre">pyke</span></tt>.</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="documentation">
<h2>Documentation</h2>
<p>The <tt class="docutils literal"><span class="pre">doc/html</span></tt> directory in <a class="reference external" href="http://mercurial.selenic.com/wiki/">mercurial</a> contains all of these documents.
You can browse these on your hard drive if you'd like.</p>
<p>If you want to regenerate these documents, you'll also need:</p>
<ul class="simple">
<li><a class="reference external" href="http://sourceforge.net/projects/rest2web">Rest2web</a>, which requires:</li>
<li><a class="reference external" href="http://sourceforge.net/projects/docutils">Docutils</a></li>
</ul>
<p>The sources for the documentation are in <tt class="docutils literal"><span class="pre">doc/source</span></tt>.</p>
<p>To regenerate the documentation, in the <tt class="docutils literal"><span class="pre">doc/source</span></tt> directory run:</p>
<pre class="literal-block">
$ bin/gen_html
</pre>
<p>This:</p>
<ol class="arabic simple">
<li>Temporarily appends hyperlink references onto all of the *.txt files.</li>
<li>Runs <tt class="docutils literal"><span class="pre">r2w</span></tt> to regenerate the files in <tt class="docutils literal"><span class="pre">doc/html</span></tt><ul>
<li>except for those in <tt class="docutils literal"><span class="pre">doc/html/stylesheets</span></tt> and <tt class="docutils literal"><span class="pre">doc/html/images</span></tt>.</li>
</ul>
</li>
<li>Then strips all of the hyperlink references from the *.txt files.</li>
</ol>
<p>I've gone ahead and placed the generated html files in mercurial so that
you can browse the documentation without having to run <tt class="docutils literal"><span class="pre">bin/gen_html</span></tt>.</p>
<!-- ADD_LINKS MARKER -->
</div>
</div>
<!-- <div id="return-to-top">
<a href="#">Return to Top</a>
</div>
-->
</div>
</td>
<td id="right-nav">
<div id="right-nav-div">
<h3>More:</h3>
<div class="right-item"><a href="cooking_functions.html">Cooking Python Functions</a><p>Explanation of how Pyke &quot;cooks&quot; Python functions.</p>
</div>
<div class="right-item"><a href="what_is_pyke.html">What is Pyke?</a><p>An overview of Pyke's features.</p>
</div>
<div class="right-item"><a href="steps_to_using_pyke.html">Steps to Using Pyke</a><p>A brief list of the steps involved in programming in Pyke (with lots
of links).</p>
</div>
<div class="right-item"><a href="installing_pyke.html">Installing Pyke</a><p>System Requirements and installing Pyke.</p>
</div>
</div>
</td>
</tr>
</tbody>
<tfoot id="foot">
<tr id="foot2">
<td id="copyright" colspan="3">
Copyright &copy; 2007-2009 Bruce Frederiksen
</td>
</tr>
</tfoot>
</table>
<div id="last-modified">
Page last modified
Mon, Oct 19 2009.
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ?
"https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost +
"google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-6310805-1");
pageTracker._trackPageview();
} catch(err) {}
</script>
</body>
</html>

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks