[Pymerase-cvs-commit] Docs/running_pymerase Run_Pymerase.tex,NONE,1.1

[<ki...@us...>]

Update of /cvsroot/pymerase/Docs/running_pymerase
In directory sc8-pr-cvs1:/tmp/cvs-serv8447

Added Files:
	Run_Pymerase.tex 
Log Message:
Running Pymerase Docs redone in LaTeX =o)


--- NEW FILE: Run_Pymerase.tex ---
% Pymerase Docs - Running Pymerase
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/03/07 02:52:56 $

\documentclass{article}
\usepackage{graphicx}
\usepackage{color}

\setlength{\parindent}{0in}
\setlength{\parskip}{2mm}

%colors
%\definecolor{light-blue}{rgb}{0.42,0.54,1}

%document
\begin{document}

%title page
\begin{titlepage}
\title{\color{blue} Pymerase Docs - Running Pymerase}
\author{Brandon King\\Copyright \copyright  California Institute of Technology}
\date{Version 0.1.1\\\today}
\maketitle
\end{titlepage}

% SECTION: Method of Running Pymerase
\section*{\color{blue}Methods of Running Pymerase}
\begin{tabular}{ll}
  Command Line & pymerase/bin/pymerase\\
  Pymerase GUI & pymerase/bin/pymerasegui.py\\
  Driver Program & Small Python script for providing pymerase\\
  & with information.
\end{tabular}

% SECTION: Pymerase: Command Line
\section*{\color{blue}Pymerase: Command Line}
Currently works with Python: Yes\\
Currently works with Jython: No

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


% SECTION: Pymerase: GUI
\section*{\color{blue}Pymerase: GUI}
Currently works with Python: Yes\\
Currently works with Jython: No

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.

\includegraphics[width=\textwidth]{images/PymeraseGUI}


% SECTION: Pymerase: Driver Program
\section*{\color{blue}Pymerase: Driver Program}
Currently works with Python: Yes\\
Currently works with Jython: Yes\\
\\
------------Driver Program Template-----------\\
\#!/usr/bin/env python 

import sys\\
import os

import pymerase
 
\begin{tabbing}
\#In\=put module to use (parseGenexSchemaXML.py would be\\
\# \> pymerase.input.parseGenexSchemaXML)\\
import pymerase.input.\em nameOfInputModule \\
\\
\#Output module to use (CreateDBAPI.py would\\
\# \> be pymerase.output.CreateDBAPI)\\
import pymerase.output.\em nameOfOutputModule \\
\\
if \_\_name\_\_ == '\_\_main\_\_':\\
  \>\#Path to schema\\
  \>schema = os.path.abspath('../path2schema/schema') \\
  \\
  \>\#Output Path\\
  \>outputPath = os.path.abspath('./outputPath')\\
  \\
  \>\#Run pymerase\\
  \>pymerase.run(\=schema,\\
  \>           \>pymerase.input.\em nameOfInputModule,\\
  \>           \>outputPath,\\
  \>           \>pymerase.output.\em nameofOutputModule)\\
\end{tabbing}
--------End Driver Program Template---------
\end{document}