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

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

Update of /cvsroot/pymerase/Docs/install
In directory sc8-pr-cvs1:/tmp/cvs-serv23173

Added Files:
	install.tex 
Log Message:
Installation Docs in latex format


--- NEW FILE: install.tex ---
% Pymerase Docs - Template
% Copyright (c) California Institute of Technology
%
% Authors: Brandon King
% $Revision: 1.1 $
% Modified $Date: 2003/04/03 00:46:58 $

\documentclass{article}
\usepackage{graphicx}
\usepackage{color}
\usepackage[margin=3cm,noheadfoot]{geometry}

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

%colors
\newcommand{\cb}{\color{blue}}

%new commands
\newcommand{\pymlink}{http://pymerase.sf.net}

%document
\begin{document}

%title page
\begin{titlepage}
\title{\cb Pymerase Docs - Installation}
\author{Diane Trout \\
Copyright \copyright  California Institute of Technology}
\date{Version 0.1.1\\\today}
\maketitle
\thispagestyle{empty}
\end{titlepage}

\tableofcontents
\thispagestyle{empty}
\newpage

%Document Body
\setcounter{page}{1}

\section{\cb Installation}
\subsection{\cb How to install?}
Pymerase depends on several components depending on what you'd like to
do with it.

\subsubsection{\cb GeneX Table Definition Format}
Currently the GeneX Table definition format is the best supported file
format (As it was the first mode I started developing against.)

However the XMI format is coming along as well.

At minimum it requires an XML parser. The default python XML parser is
called expat, newer versions are available at
http://sourceforge.net/projects/pyxml. Later versions of this might
work with the current table.dtd

2003 Apr 02: default parser seems to work, so the steps to install
pirxx \& xerces seem to be unnecessary. (But I'm leaving the section in
just in case.)  [Well, almost works, since the default xml parser
couldn't find the table.dtd file without using a full URL instead of
just a pathname]

  However the version of expat I was using didn't properly support
  entities with the XML files were using so I ended up using the
  xerces-c XML parser. 
  
  A project called pirxx is providing the python wrapper for xerces-c.
  
  xerces-c: http://xml.apache.org/xerces-c/index.html
  pirxx: http://sourceforge.net/projects/pirxx

END old instructions.

\subsubsection{\cb XMI file format}
The key thing for XMI files is you need to generate them somehow,
ArgoUML is the tool we're currently using for testing. 

http://argouml.tigris.org

The current XMI parser was written by Teemu Toivanen and is available
from the MGED/Mage sourceforge site in the directory lib/Python/pyXMI.

\subsubsection{\cb DB Support}
The code generated by CreateDBAPI, needs the mxTools Date Time
extension as well as the postgresql python db api module.

The mx tools is available from:
http://www.egenix.com/files/python/mxDateTime.html 

The database interface, pgdb, is distributed with postgresql
(http://www.postgresql.org) 

Also, the SQL code generated by CreateSQL is using postgresql's sequence
feature, and so is currently dependent on postgresql. 

\end{document}