[Pymerase-cvs-commit] Docs/running_pymerase Run_Pymerase.tex,1.3,1.4

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

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

Modified Files:
	Run_Pymerase.tex 
Log Message:
2003-04-30
   Updated to provide information about Pymweb
   Cleaned up a little
   New pymerasegui.py screenshot
   removed Jython support


Index: Run_Pymerase.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/running_pymerase/Run_Pymerase.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** Run_Pymerase.tex	20 Mar 2003 20:27:28 -0000	1.3
--- Run_Pymerase.tex	30 Apr 2003 21:37:57 -0000	1.4
***************
*** 9,12 ****
--- 9,13 ----
  \usepackage{graphicx}
  \usepackage{color}
+ \usepackage[margin=3cm,noheadfoot]{geometry}
  
  \setlength{\parindent}{0in}
***************
*** 16,19 ****
--- 17,26 ----
  %\definecolor{light-blue}{rgb}{0.42,0.54,1}
  
+ %colors
+ \newcommand{\cb}{\color{blue}}
+ 
+ %new commands
+ \newcommand{\pymlink}{http://pymerase.sf.net}
+ 
  %document
  \begin{document}
***************
*** 21,27 ****
  %title page
  \begin{titlepage}
! \title{\color{blue} Pymerase Docs - Running Pymerase}
  \author{Brandon King\\Copyright \copyright  California Institute of Technology}
! \date{Version 0.1.2\\\today}
  \maketitle
  \thispagestyle{empty}
--- 28,34 ----
  %title page
  \begin{titlepage}
! \title{\cb Pymerase Docs - Running Pymerase}
  \author{Brandon King\\Copyright \copyright  California Institute of Technology}
! \date{Version 0.1.3\\\today}
  \maketitle
  \thispagestyle{empty}
***************
*** 29,90 ****
  
  % 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.eps}
--- 36,104 ----
  
  % SECTION: Method of Running Pymerase
! \section*{\cb Methods of Running Pymerase}
  \begin{tabular}{ll}
!   Command Line & Command Line Interface to Pymerase\\
!   Pymerase GUI & Python Tk GUI Interface to Pymerase\\
    Driver Program & Small Python script for providing pymerase\\
!   & with information. \\
!   Pymweb & Pymerase Web Interface
  \end{tabular}
  
  % SECTION: Pymerase: Command Line
! \section*{\cb Pymerase: Command Line}
  Currently works with Python: Yes\\
! Currently works with Jython: No longer needed, support dropped.
  
! Default Install Location: /usr/bin/pymerase\\
! CVS Checkout Location: pymerase/bin/pymerase
! 
! \begin{verbatim}
!  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
+   ...etc...
+ \end{verbatim}
  
  % SECTION: Pymerase: GUI
! \section*{\cb Pymerase: GUI}
  Currently works with Python: Yes\\
! Currently works with Jython: No longer needed, support dropped.
  
! Default Install Location: /usr/bin/pymerase\\
! CVS Checkout Location: 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, 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.eps}
***************
*** 92,140 ****
  
  % SECTION: Pymerase: Driver Program
! \section*{\color{blue}Pymerase: Driver Program}
  Currently works with Python: Yes\\
! Currently works with Jython: Yes\\
! \\
! ------------Driver Program Template-----------\\
! \color{red}
! \#!/usr/bin/env python
  
! \color{black}
! import sys\\
! import os
  
  import pymerase
-  
- \begin{tabbing}
- \color{red}
- \#In\=\color{red}put module to use (parseGenexSchemaXML.py would be\\
- \color{red}
- \# \> \color{red} pymerase.input.parseGenexSchemaXML)\\
- \color{black}
- import pymerase.input.\em nameOfInputModule \\
- \\
- \color{red}
- \#Output module to use (CreateDBAPI.py would\\
- \color{red}\# \> \color{red} be pymerase.output.CreateDBAPI)\\
- \color{black}
- import pymerase.output.\em nameOfOutputModule \\
- \\
- if \_\_name\_\_ == '\_\_main\_\_':\\
-   \> \color{red} \#Path to schema\\
- \color{black}
-   \>schema = os.path.abspath('../path2schema/schema') \\
-   \\
-   \> \color{red} \#Output Path\\
- \color{black}
-   \>outputPath = os.path.abspath('./outputPath')\\
-   \\
  
!   \> \color{red} \#Run pymerase\\
! \color{black}
!   \>pymerase.run(\=schema,\\
!   \>           \>pymerase.input.\em nameOfInputModule,\\
!   \>           \>outputPath,\\
!   \>           \>pymerase.output.\em nameofOutputModule)\\
! \end{tabbing}
  --------End Driver Program Template---------
  \end{document}
--- 106,146 ----
  
  % SECTION: Pymerase: Driver Program
! \section*{\cb Pymerase: Driver Program}
  Currently works with Python: Yes\\
! Currently works with Jython: No longer needed, support dropped.
  
! \begin{verbatim}
! ------------Driver Program Template-----------
! 
! #!/usr/bin/env python
  
+ import sys
+ import os
  import pymerase
  
! if __name__ == '__main__':
!   #Path to schema
!   schema = os.path.abspath('./path2schema/schema') 
!   
!   #Output Path
!   outputPath = os.path.abspath('./outputPath')
!   
!   #Run pymerase
!   pymerase.run(schema,
!                'nameOfInputModule',
!                outputPath,
!                'nameofOutputModule')
! 
  --------End Driver Program Template---------
+ \end{verbatim}
+ 
+ % SECTION: Pymerase: Pymweb
+ \section*{\cb Pymerase: Pymweb}
+ CVS Checkout Location: pymerase/pymweb/
+ 
+ Pymweb is in optional web interface for Pymerase. For more information
+ on Pymweb read documention called ``Pymerase Docs - Pymweb Install''
+ and ``Pymerase Docs - Pymweb Manual''. You can find these documents at
+ 'http://pymerase.sf.net/docs/'.
+ 
  \end{document}