Official ESTEL Documentation

From SourceWiki
Revision as of 19:29, 9 March 2007 by Jprenaud (talk | contribs)
Jump to navigation Jump to search


Build system

The ESTEL documentation is slowly being moved to the estel-doc subversion repository. It consists of several files in LaTeX and BibTex format which can be compiled with pdfLaTeX to generate screen-ready PDF documents.

The PDFs are not stored in the subversion tree and instead, the PDFs are rebuilt daily (if any of the LaTeX files has been modified). Therefore, the documents linked below might change at any time and without notice. The date a PDF file has been rebuilt last is explicitly written on the first page of the document.

Documents

Version v5p6

ESTEL-3D User Manual

ESTEL-2D User Manual

Note: although v5p6 is currently the stable version of ESTEL, the documentation of ESTEL-2D is not complete (in the automated build system).

Development version

Documentation files not yet available.

Subversion access

The source files are hosted under the estel-doc repository on the source subversion server. All ESTEL developers have access to these files. Following a similar subversion repository structure to that of ESTEL-2D or ESTEL-3D, the documentation for the latest version is in the "trunk/" and for a given stable version in "branches/RB-vxpy/"

Requirements to build the documentation

pdfLaTeX (list required packages)

BibTex