[Pymerase-cvs-commit] htdocs/docs/running running_pymerase.html,NONE,1.1

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/pymerase/htdocs/docs/running
In directory sc8-pr-cvs1:/tmp/cvs-serv31543

Added Files:
	running_pymerase.html 
Log Message:
added latex generated html

--- NEW FILE: running_pymerase.html ---
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
           "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<meta name="GENERATOR" content="TtH 2.92">

<title> Pymerase Docs - Running Pymerase</title>

<h1 align="center"><font color="#0000FF">Pymerase Docs - Running Pymerase</font> </h1>

<h3 align="center">Brandon King<br />Copyright &#169;  California Institute of Technology </h3>

<h3 align="center">Version 0.1.2<br />Apr 16, 2003
</h3>

<p>

<h2><font color="#0000FF">Methods of Running Pymerase</font></h2>

<table>
<tr><td>Command Line </td><td>pymerase/bin/pymerase</td></tr>
<tr><td>Pymerase GUI </td><td>pymerase/bin/pymerasegui.py</td></tr>
<tr><td>Driver Program </td><td>Small Python script for providing pymerase</td></tr>
<tr><td></td><td>with information.
</td></tr></table>

<p>

<h2><font color="#0000FF">Pymerase: Command Line</font></h2>
Currently works with Python: Yes<br />
Currently works with Jython: No

Lo&#175;ca&#175;ti&#175;on: pymerase/bin/pymerase&#175; 
 
&nbsp;Useage: 
 
&nbsp;&nbsp;pymerase -s [source] -i [inputModule] -d [destination] -o [outputModule] 
 
&nbsp;&nbsp;pymerase -source=[source] -inputModule=[inputModule] 
&nbsp;&nbsp;&nbsp;-destination=[destination] -outputModule=[outputModule] 
 
&nbsp;&nbsp;Options: 
 
&nbsp;&nbsp;&nbsp;-s, -source=[foo] &nbsp;Location of input file or directory 
&nbsp;&nbsp;&nbsp;-i, -inputModule=[foo] &nbsp;Name of PyMerase input translation module 
&nbsp;&nbsp;&nbsp;-d, -destination=[foo] &nbsp;Location of output file or directory 
&nbsp;&nbsp;&nbsp;-o, -outputModule=[foo] &nbsp;Name of PyMerase output module 
 
&nbsp;&nbsp;&nbsp;-g, -gui &nbsp;GUI Interface to Pymerase 
 
&nbsp;&nbsp;&nbsp;-t, -translators &nbsp;Displays more info about translators 
&nbsp;&nbsp;&nbsp;-v, -version &nbsp;Displays version numbers 
&nbsp;&nbsp;&nbsp;-h, -help &nbsp;Displays this help page 
 
&nbsp;Input Translators Available: 
&nbsp;&nbsp;parseXMI 
&nbsp;&nbsp;parseGenexSchemaXML 
 
&nbsp;Output Translators Available: 
&nbsp;&nbsp;iPymerase 
&nbsp;&nbsp;CreateHtmlForms 
&nbsp;&nbsp;CreateTableXML 
&nbsp;&nbsp;... etc ...

<p>

<h2><font color="#0000FF">Pymerase: GUI</font></h2>
Currently works with Python: Yes<br />
Currently works with Jython: No

<p>
Location: pymerase/bin/pymerase -gui or pymerase/bin/pymerasegui.py

As you can see from the figure below, it's pretty straight forward. You give the path to your source files, choose the input module of your choice (parseXMI currently only works in Jython), select your output modules, and give the paths to where you want the output to go.

Note that iPymerase requires that ipython to be installed. Also, note that if you want to run ipython, all other options will be deselected.

<p>
<table border="0"><tr><td></td><td><table border="0"><tr><td><img src="images/PymeraseGUI.jpg">
</td></tr></table><!--vbox-->
</td><td>
</td></table><!--hboxt-->
<p>

<h2><font color="#0000FF">Pymerase: Driver Program</font></h2>
Currently works with Python: Yes<br />
Currently works with Jython: Yes<br />
<br />
----Driver Program Template----<br />
<font color="#FF0000">
#!/usr/bin/env python

<p>
<font color="#000000">
import sys<br />
import os

<p>
import pymerase

<p>
<font color="#FF0000">
#In&#175;<font color="#FF0000">put module to use (parseGenexSchemaXML.py would be<br />
<font color="#FF0000">
# &nbsp;<font color="#FF0000">pymerase.input.parseGenexSchemaXML)<br />
<font color="#000000">
import pymerase.input.<em>nameOfInputModule <br />
<br />
<font color="#FF0000">
#Output module to use (CreateDBAPI.py would<br />
<font color="#FF0000"># &nbsp;<font color="#FF0000">be pymerase.output.CreateDBAPI)<br />
<font color="#000000">
import pymerase.output.<em>nameOfOutputModule <br />
<br />
if __name__ == '__main__':<br />
  &nbsp;<font color="#FF0000">#Path to schema<br />
<font color="#000000">
  &nbsp;schema = os.path.abspath('../path2schema/schema') <br />
  <br />
  &nbsp;<font color="#FF0000">#Output Path<br />
<font color="#000000">
  &nbsp;outputPath = os.path.abspath('./outputPath')<br />
  <br />

<p>
  &nbsp;<font color="#FF0000">#Run pymerase<br />
<font color="#000000">
  &nbsp;pymerase.run(&#175;schema,<br />
  &nbsp;&nbsp;pymerase.input.<em>nameOfInputModule,<br />
  &nbsp;&nbsp;outputPath,<br />
  &nbsp;&nbsp;pymerase.output.<em>nameofOutputModule)<br />
</em></em></font></font></font></font></font></font></em></font></font></font></font></em></font></font></font></font></font>
---End Driver Program Template---
</font></font>
<br /><br /><hr /><small>File translated from
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 2.92.<br />On 16 Apr 2003, 15:30.</small>
</html>