/[escript]/trunk/doc/docguide.tex
ViewVC logotype

Contents of /trunk/doc/docguide.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6949 - (show annotations)
Thu Feb 6 02:36:07 2020 UTC (15 months, 1 week ago) by uqaeller
File MIME type: application/x-tex
File size: 1934 byte(s)
Release version 5.5
1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Copyright (c) 2003-2020 by The University of Queensland
4 % http://www.uq.edu.au
5 %
6 % Primary Business: Queensland, Australia
7 % Licensed under the Apache License, version 2.0
8 % http://www.apache.org/licenses/LICENSE-2.0
9 %
10 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11 % Development 2012-2013 by School of Earth Sciences
12 % Development from 2014 by Centre for Geoscience Computing (GeoComp)
13 %
14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15
16 \clearpage
17 \vbox{}
18 \vfill
19 \begin{center}
20 \textbf{\Large Guide to Documentation}\pdfbookmark[0]{Documentation guide}{documentation guide}
21 \vspace{0.5cm}
22
23 Documentation for \module{esys.escript} comes in a number of parts.
24 Here is a rough guide to what goes where.
25
26 \vspace{1cm}
27 \hrule
28 \vspace{1cm}
29
30 \begin{tabular}{rp{10cm}}
31 \textbf{install.pdf} & ``Installation guide for \emph{esys-Escript}'':
32 Instructions for compiling \emph{escript} for your system from its
33 source code. \\
34 &\\
35 \textbf{cookbook.pdf} & ``The \textit{escript} COOKBOOK'':
36 An introduction to \emph{escript} for new users from a geophysics perspective.\\
37 &\\
38 \textbf{user.pdf} & ``\emph{esys-Escript} User's Guide: Solving Partial
39 Differential Equations with Escript and Finley'': Covers main \emph{escript} concepts.\\
40 & \\
41 \textbf{inversion.pdf} & ``\module{esys.downunder}: Inversion with \emph{escript}'':
42 Explanation of the\newline inversion toolbox for \emph{escript}.\\
43 & \\
44 \textbf{sphinx_api directory} & Documentation for \emph{escript} {\it Python} libraries.\\
45 & \\
46 \textbf{escript_examples(.tar.gz)/(.zip)} & Full example scripts referred to
47 by other parts of the documentation.\\
48 & \\
49 \textbf{doxygen directory} & Documentation for C++ libraries (mostly only of
50 interest for developers).\\
51 \end{tabular}
52 \end{center}
53 \vfill
54 \vbox{}
55 \pagebreak

  ViewVC Help
Powered by ViewVC 1.1.26