[2bb500]: doc / html / about_pyke / installing_pyke.html Maximize Restore History

Download this file

installing_pyke.html    257 lines (243 with data), 13.3 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
<!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"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=207724&amp;type=3" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a> -->
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=207724&amp;type=4" width="125" height="37" border="0" alt="SourceForge.net Logo" /></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">
<h2><a id="index-to-this-page" name="index-to-this-page">Index to This Page</a></h2>
<ul class="simple">
<li><a class="reference" href="#licensing">Licensing</a></li>
<li><a class="reference" href="#system-requirements">System Requirements</a></li>
<li><a class="reference" href="#installation">Installation</a><ul>
<li><a class="reference" href="#installing-the-executables">Installing the Executables</a></li>
<li><a class="reference" href="#installing-the-sources">Installing the Sources</a></li>
<li><a class="reference" href="#installing-the-examples">Installing the Examples</a></li>
<li><a class="reference" href="#installing-the-html-documentation">Installing the HTML Documentation</a></li>
</ul>
</li>
<li><a class="reference" href="#subversion-directories">Subversion Directories</a></li>
<li><a class="reference" href="#documentation">Documentation</a></li>
</ul>
</div>
<div class="section">
<h2><a id="licensing" name="licensing">Licensing</a></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">
<h2><a id="system-requirements" name="system-requirements">System Requirements</a></h2>
<p>Pyke is 100% Python, so it should run on any platform supported by Python.
You'll need:</p>
<ul class="simple">
<li><a class="reference" href="http://www.python.org">Python 2.5</a></li>
<li><a class="reference" href="http://www.dabeaz.com/ply/">PLY 2.3</a> (<a class="reference" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> automatically installs this)</li>
</ul>
</div>
<div class="section">
<h2><a id="installation" name="installation">Installation</a></h2>
<div class="section">
<h3><a id="installing-the-executables" name="installing-the-executables">Installing the Executables</a></h3>
<p>Pyke is registered on <a class="reference" href="http://pypi.python.org/pypi">pypi</a>, so once you have <a class="reference" href="http://www.python.org">Python 2.5</a> with
<a class="reference" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a> you can just type:</p>
<pre class="literal-block">
$ sudo easy_install-2.5 pyke
</pre>
<p>This will automatically install <a class="reference" href="http://www.dabeaz.com/ply/">PLY 2.3</a> too.</p>
</div>
<div class="section">
<h3><a id="installing-the-sources" name="installing-the-sources">Installing the Sources</a></h3>
<p>The source code for the latest release can be found on the <a class="reference" 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" href="#subversion-directories">Subversion Directories</a>,
below.</p>
</div>
<div class="section">
<h3><a id="installing-the-examples" name="installing-the-examples">Installing the Examples</a></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" href="../examples.html">Examples</a>.</p>
</div>
<div class="section">
<h3><a id="installing-the-html-documentation" name="installing-the-html-documentation">Installing the HTML Documentation</a></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" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project download page</a>.</p>
</div>
</div>
<div class="section">
<h2><a id="subversion-directories" name="subversion-directories">Subversion Directories</a></h2>
<p>To check out the entire project (including the example and this documentation)
into a directory called <em>foobar</em>:</p>
<pre class="literal-block">
$ svn checkout https://pyke.svn.sourceforge.net/svnroot/pyke/trunk foobar
</pre>
<p>Anybody can check out the code, but only project members may do
<tt class="docutils literal"><span class="pre">commits</span></tt>. Send me an email if you'd like to lend a hand!</p>
<p>You'll see the following directories. You can also use <tt class="docutils literal"><span class="pre">svn</span></tt> to check these
out individually by simply adding the directory name onto the end of the url in
the example above and changing the directory that you want it to go into.</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">doc</span></tt><ul>
<li>See <a class="reference" 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" 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 class="section">
<h2><a id="documentation" name="documentation">Documentation</a></h2>
<p>The <tt class="docutils literal"><span class="pre">doc/html</span></tt> directory in subversion 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" href="http://sourceforge.net/projects/rest2web">Rest2web</a>, which requires:</li>
<li><a class="reference" 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/sources</span></tt>.</p>
<p>To regenerate the documentation, in the <tt class="docutils literal"><span class="pre">doc/sources</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 subversion so that
you can checkout 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-2008 Bruce Frederiksen
</td>
</tr>
</tfoot>
</table>
<div id="last-modified">
Page last modified Wed, Sep 24 2008.
</div>
</body>
</html>