[clml] r140 committed - Edited wiki page InstallationGuide through web user interface.
cl...@googlecode.com
Author: sam.r....@gmail.com
Date: Tue Jul 12 13:29:19 2011
Log: Edited wiki page InstallationGuide through web user interface.
http://code.google.com/p/clml/source/detail?r=140
Modified:
/wiki/InstallationGuide.wiki
=======================================
--- /wiki/InstallationGuide.wiki Sun Oct 31 13:13:33 2010
+++ /wiki/InstallationGuide.wiki Tue Jul 12 13:29:19 2011
@@ -1,6 +1,5 @@
#summary How to set up and use PyPhon.
#labels Featured,Phase-Deploy
-
=<a name="prereqs">Prerequisites</a>=
@@ -10,16 +9,10 @@
</p>
=<a name="downloads">Downloads</a>=
-<p>An installer for a recent release is available from the <a
href="http://code.google.com/p/clml/downloads/list">Downloads</a> tab. The
most current version of PyPhon can be downloaded from the <a
href="http://code.google.com/p/clml/source/checkout">Source</a> tab. </p>
+<p>The most current version of PyPhon can be downloaded from the <a
href="http://code.google.com/p/clml/source/checkout">Source</a> tab through
SVN. Source packages for relatively recent versions and an installer for an
older release is available from the <a
href="http://code.google.com/p/clml/downloads/list">Downloads</a> tab.</p>
=<a name="installation">Installation Instructions</a>=
-==<a name="installation-OSX" id="installation-OSX">Mac OS X
Installation:</a>==
-If you have Python 2.5 installed, simply download, unzip, and run the
PyPhon installer. If you have Python 2.6, continue to <a
href="#installation-source">Installation from Source</a>.
-
-==<a name="installation-OSX" id="installation-win">Windows
Installation:</a>==
-Simply download, unzip, and run the PyPhon installer.
-
==<a name="installation-source">Installation from Source (*Strongly
reccomended*):</a>==
_PyPhon is still in development, and many features are still being
implemented. The current version available in Source will have
functionality missing in released versions._
<ul>
@@ -46,46 +39,32 @@
<li>Windows: Open Start-All Programs-Accessories-Command Prompt</li>
<li>Linux/UNIX: You know where to look.</li>
</ul>
-<p>You may now interact with pyphon through the following commands:</p>
+<p>You may now interact with PyPhon through the following commands. A
tutorial is available [Tutorial_VowelHarmony here]. Argument structures and
basic help for each command can be found by running the command with no
arguments.</p>
==pyphon_makemodel.py==
{{{pyphon_makemodel.py}}}: read a PyPhon [ModelDescriptionFile model
description file] and
-write the resulting model to disk.
-
-{{{pyphon_makemodel.py descriptionFile [outputFile]}}}
-
-If outputFile is omitted, it defaults to [descriptionFile name].mod.
+write the resulting model to disk. Run this any time your model file is
changes.
==pyphon_maketableaux.py==
{{{pyphon_maketableaux.py}}}: read a PyPhon model (produced by
{{{makemodel}}}) and [InputFile list of inputs] and write the tableaux of
contender outputs to disk.
-{{{pyphon_maketableaux.py modelfile inputfile (opt) [outputfile
[separator]]}}}
-
-(opt) must be supplied as one of "OT", "HG"; it indicates
-whether the candidates in the tableaux should be OT-contenders or
-HG-contenders.
-
-If outputFile is omitted, it defaults to modelfile-inputfile-opt.csv.
-
-Separator, if given, should be a string that will be used to separate
output
-forms that are not distinguished by the model. If not given, it defaults to
-" | ".
-
-==pyphon_generate.py==
-
-{{{pyphon_generate.py}}}: read a PyPhon tableaux file with an optional
[GrammarDescriptionFile grammar file],
-and generate optima or typologies.
-
-{{{pyphon_generate.py tableaux outputfile (opt) [grammarfile [grammar]]}}}
-
-(opt) must be supplied as one of "OT", "HG"; it indicates whether optimal
-candidates will be selected according to the rules of OT or HG.
+==pyphon_generate.py==
+
+{{{pyphon_generate.py}}}: read a PyPhon tableaux file (or a model file and
an input file) with an optional [GrammarDescriptionFile grammar file], and
generate optima or typologies.
+
+=pyphon_recurse.py==
+
+{{{pyphon_generate.py}}}: read a PyPhon model (produced by
{{{makemodel}}}) and [InputFile list of inputs] and write the typology for
cyclic evaluation (described in
[http://www.stanford.edu/~sbowman/BowmanMA.pdf Bowman, 2011]).
+
+=pyphon_twotier.py==
+
+{{{pyphon_generate.py}}}: read a PyPhon model (produced by
{{{makemodel}}}) and [InputFile list of inputs] and write the typology for
two-tiered evaluation (described in
[http://www.stanford.edu/~sbowman/BowmanMA.pdf Bowman, 2011]).
==Example files:==
<blockquote>
-<p>Our example files are available as <a
href="http://clml.googlecode.com/files/examples.tar.gz">an archive</a> from
the Downloads tab.</p>
+<p>Our example files are available as <a
href="http://clml.googlecode.com/files/examples.tar.gz">an archive</a> from
the Downloads tab. The files needed for the tutorial are included with the
source.</p>
</blockquote>
<ul>
<li><strong>syllables.csv</strong>: a [ModelDescriptionFile model
description file] containing symbols and constraints for a simple syllable
structure model.</li>