pymerase-cvs-commit

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

Update of /cvsroot/pymerase/Docs/faq
In directory sc8-pr-cvs1:/tmp/cvs-serv5559

Modified Files:
	faq.tex 
Log Message:
update


Index: faq.tex
===================================================================
RCS file: /cvsroot/pymerase/Docs/faq/faq.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** faq.tex	21 Mar 2003 00:36:40 -0000	1.1
--- faq.tex	21 Mar 2003 02:43:30 -0000	1.2
***************
*** 28,32 ****
  \author{Brandon King \& Diane Trout\\
  Copyright \copyright  California Institute of Technology}
! \date{Version 0.1.1\\\today}
  \maketitle
  \thispagestyle{empty}
--- 28,32 ----
  \author{Brandon King \& Diane Trout\\
  Copyright \copyright  California Institute of Technology}
! \date{Version 0.1.2\\\today}
  \maketitle
  \thispagestyle{empty}
***************
*** 40,43 ****
--- 40,44 ----
  \setcounter{page}{1}
  
+ %GENERAL
  \section{\cb FAQ - General}
  \subsection{\cb Why the name ''Pymerase''?}
***************
*** 53,56 ****
--- 54,63 ----
  Institute of Technology (Caltech).
  
+ \subsection{\cb What is the Wold Lab?}\label{woldlab}
+ The Wold Lab, run by Barbara Wold, is a Bioinformatics / Biology Lab at the
+ California Institute of Technology. The Lab consists of both
+ biologists and computational members. For more information visit
+ http://woldlab.caltech.edu/.
+ 
  \subsection{\cb Who originally developed Pymerase?}
  Diane Trout and Brandon King originally developed Pymerase in the Wold
***************
*** 65,68 ****
--- 72,128 ----
  including Sigmoid and MAGE.
  
+ \subsection{\cb What License is Pymerase distributed under?}
+ Pymerase is distributed under the MIT license which can be found in
+ the source code of Pymerase or on the web at
+ http://www.opensource.org/licenses/
+ 
+ \subsection{\cb Does Pymerase support all versions of ArgoUML and/or
+   XMI?}
+ Please see section \ref{argouml} for more information.
+ 
+ %CONTRIBUTING TO PYMERASE
+ \section{\cb FAQ - Contributing to Pymerase}
+ \subsection{\cb Can I contribute to Pymerase?}
+ Yes, anyone with the will to help may contribute to the Pymerase
+ project. Be it with programming skills, documention, examples, money
+ or good old moral support, we could use all the help we can get. If
+ you would like contribute in any way please send an e-mail to
+ pymerase-devel at lists.sourceforge.net or contact on of the curent
+ developers.
+ 
+ \subsection{\cb What ways can I contribute?}
+ Pymerase as an open source project servives from the support of the
+ Open Source community. Any help is welcome. Becoming a programmer
+ is probably the most obvious way to help, but is not the only way one
+ can contribute.
+ 
+ Here is just a small list of things one can do to help:
+ \begin{itemize}
+ \item writting documentation
+ \item testing code
+ \item creating examples
+ \item updating the web site
+ \item contributing expertice
+ \item contributing ideas
+ \item funding development
+ \end{itemize}
+ 
+ Please send e-mail to the mailing list pymerase-devel at
+ lists.sourceforge.net if you would like to contribute in any way.
+ 
+ \subsection{\cb How can I help fund development and how will it help?}
+ If you would like to help fund the Pymerase project or other projects
+ in the Wold Lab please contact Barbara Wold or send an e-mail to
+ pymerase-devel at lists.sourceforge.net. You can find out more about
+ the Wold Lab in section \ref{woldlab}
+ 
+ Additional funding for Pymerase would help in many ways. First of all,
+ Diane and myself (Brandon) also work on other projects in the Wold
+ Lab, so not all of our time goes into the project. Funding would help
+ with the continuing development by providing more time for us to work
+ on the project or the highering of more programmers to work on the
+ project.
+ 
+ %INPUT MODULES
  \section{\cb FAQ - Input Modules}
  \subsection{\cb parseGenexSchemaXML}
***************
*** 71,78 ****
  No. It's called parseGenexSchemaXML to give credit to the GeneX
  project for coming up with the file format used for this particular
! input module and the schema of the GeneX 2.x project. The format can
  be used to make any number of schemas using it. Special thanks goes to
  Jason Stewart of OpenInformatics.org for the original design of this
  XML format.
  
  \end{document}
--- 131,182 ----
  No. It's called parseGenexSchemaXML to give credit to the GeneX
  project for coming up with the file format used for this particular
! input module and the schema of the GeneX~2.x project. The format can
  be used to make any number of schemas using it. Special thanks goes to
  Jason Stewart of OpenInformatics.org for the original design of this
  XML format.
+ 
+ \subsubsection{\cb Does parseXMI support all versions of
+   XMI?}\label{argouml}
+ No. Unfortunately, the XMI standard is still developing rapidly, so
+ different versions of XMI can become incompatible with previous
+ versions. Supporting XMI was difficult in the first place as it's a
+ complicated standard. The XMI parser that was used in parseXMI was
+ written in Java, so Jython has to be used when running parseXMI.
+ 
+ I will have to find out what the latest version of ArgoUML that can be
+ used before they switch over to a new XMI parser. I know
+ ArgoUML~v0.10.* should work with Pymerase.
+ 
+ If you want to know more information on which versions of ArgoUML
+ export the version of XMI that Pymerase can read, please e-mail the
+ mailing list pymerase-devel at lists.sourceforge.net.
+ 
+ \subsubsection{\cb Why does parseGenexSchemaXML only work with
+   Jython?}
+ Finding an XMI parser that is developed enough and has documentation
+ on how to use it is difficult at this point in time. The XMI parser
+ that Diane used in parseXMI is written in Java, so Jython has to be
+ used when using the parseXMI input module.
+ 
+ %OUTPUT MODULES
+ \section{\cb FAQ - Output Modules}
+ \subsection{\cb General}
+ \subsubsection{\cb What modules do hope to include in the future?}
+ In the future we hope to include many more output modules. One of the
+ output modules we hope to develop is the generation of a C++ API which
+ then could be swig wrapped to allow many different languages like,
+ Python, Perl, and Java to use the same generate API.
+ 
+ \subsection{\cb CreateDBAPI}
+ \subsubsection{\cb What does CreateDBAPI do?}
+ CreateDBAPI generates a Python Database API for a given
+ schema. Currently the generated DBAPI is only compatible with
+ PostgreSQL databases. With some work, it could be ported to other
+ Relational Database Management Systems such as MySQL or Oracle.
+ 
+ \subsection{\cb CreateSQL}
+ \subsubsection{\cb What does CreateSQL do?}
+ CreateSQL generates a file containing SQL statements for the creation
+ of a PostgreSQL database for a given schema.
  
  \end{document}