[Pymerase-cvs-commit] Docs/output/modules iPymerase.tex,NONE,1.1

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

Update of /cvsroot/pymerase/Docs/output/modules
In directory sc8-pr-cvs1:/tmp/cvs-serv6629

Added Files:
	iPymerase.tex 
Log Message:
iPymerase documentation


--- NEW FILE: iPymerase.tex ---
% Pymerase Docs - iPymerase
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/05/07 00:10:57 $

\section{\cb iPymerase}
\subsection{\cb Description}
iPymerase is meant as an Output Module developement tool. It will drop
you into an ipython interactive interpreter and allow you to explore
the Pymerase API which has been filled up with your model. You can
explore the Pymerase API and learn how to use it and then write your
new Output Module.

\subsection{\cb Usage}
Just run pymerase using anything other than the Pymweb interface to
Pymerase and launch the iPymerase output module. You will see the
following output once iPymerase has been activated.

\begin{verbatim}
Welcome to iPymerase!

pymerase class list variable is 'classList'

Convenience Functions:
  printClassess(classList)
  printAttributes(attribList)
  printAssociations(assocList)
  getClassByName(classList, className)
  getAttribByName(attribList, attribName)
  getAssocByName(assocList, assocName)

In [1]: 
\end{verbatim}

Just start exploring the classList and your all set. 

\subsection{\cb Caveats}
\subsubsection{\cb pymerasegui.py / pymerase --gui}
If you run iPymerase from the Pymerase GUI, then you will have to make
sure you exit the ipython interpreter when your done, otherwise the
Pymerase GUI won't shutdown or let you run Pymerase again.