summaryrefslogtreecommitdiff
path: root/doc/UsersGuide
diff options
context:
space:
mode:
authorswhite <swhite@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-02-21 13:13:52 +0000
committerswhite <swhite@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-02-21 13:13:52 +0000
commit00cff78eaf6430d8058c7cecb8418687c6b5cd4d (patch)
tree9aad345d6f10e81b911cdf00a940fa156e4b4b49 /doc/UsersGuide
parent2781a9290b05b9dfb7203e2cb85828ab7e888588 (diff)
commented out references to non-existent documentation,
Toned down the language Updated address Updated LaTeX git-svn-id: http://svn.cactuscode.org/flesh/trunk@4257 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide')
-rw-r--r--doc/UsersGuide/Preface.tex65
1 files changed, 31 insertions, 34 deletions
diff --git a/doc/UsersGuide/Preface.tex b/doc/UsersGuide/Preface.tex
index 98f3c33d..a4bf1699 100644
--- a/doc/UsersGuide/Preface.tex
+++ b/doc/UsersGuide/Preface.tex
@@ -31,7 +31,7 @@ try and fix them as soon as possible.
\vskip .5cm
-{\bf Overview of documentation}
+\textbf{Overview of documentation}
\vskip .5cm
@@ -39,54 +39,51 @@ This guide covers the following topics
\begin{Lentry}
-\item [{\bf Part~\ref{part:RunningCactus}: Installation and Running.}]
- We give an overview of required hardware and
- software and talk you through the installation of a working
- Cactus tool kit.
- You will be able to verify the correct installation with our
- test suite technology.
-
-\item [{\bf Part~\ref{part:ThornWriters}: Application Thorn Writing.}]
- We introduce thorn
- concepts and describe all you need to know for creating, writing
- and maintaining application thorns. You will learn how to use the
+\item [\textbf{Part~\ref{part:RunningCactus}: Installation and Running.}]
+ A description of required hardware and software and an installation guide
+ for Cactus.
+ Describes how to check the installation with Cactus test suites.
+
+\item [\textbf{Part~\ref{part:ThornWriters}: Application Thorn Writing.}]
+ An introduction to thorn concepts and description of how to create, write
+ and maintain application thorns. Explanation of use of the
programming interface to take advantage of parallelism and modularity.
-\item [{\bf Part~\ref{part:UtilityRoutines}: Utility Routines.}]
- This part discusses low-level
- utility routines available in Cactus, such as key/value tables.
+\item [\textbf{Part~\ref{part:UtilityRoutines}: Utility Routines.}]
+ A discussion of low-level utility routines available in Cactus, such as
+ key/value tables.
-\item [{\bf Part~\ref{part:Infrastructure}:
- Infrastructure Thorn Writer's Guide.}] In this more
- advanced part, we talk about user supplied infrastructure routines such
- as \textit{additional output routines, drivers, etc.} [This part is not
- yet complete, and is currently under construction.]
+\item [\textbf{Part~\ref{part:Infrastructure}:
+ Infrastructure Thorn Writer's Guide.}]
+ A more advanced discussion of user supplied infrastructure routines such
+ as additional \textit{output routines}, \textit{drivers}, etc.
+ [\emph{This part is currently under construction.}]
-\item [\bf Part~\ref{part:Appendices}: Appendices.]
+\item [\textbf{Part~\ref{part:Appendices}: Appendices.}]
These contain a description of the Cactus Configuration Language,
a glossary,
- and other odds and ends, such as how to use GNATS or TAGS.
+ and other odds and ends, such as how to use GNATS and TAGS.
\end{Lentry}
-Other topics to be discussed in separate documents include:
+Related topics are discussed in separate documents including:
\begin{Lentry}
-\item [{\bf Reference Manual}] This contains ``manual pages''
- for all the APIs provided by the Cactus flesh, along with
+\item [\textbf{Reference Manual}] Contains detailed descriptions of
+ the functions provided by the Cactus flesh API, along with
other reference material.
-\item [{\bf Computational Thorn Guide}] This will contain details about the
-arrangements and thorns making up the standard Cactus Computational Tool Kit.
+%\item [{\bf Computational Thorn Guide}] This will contain details about the
+%arrangements and thorns making up the standard Cactus Computational Tool Kit.
-\item [{\bf Relativity Thorn Guide}] This will contain details about the arrangements and thorns making up the Cactus Relativity Tool Kit, one of the major
- motivators, and still the driving force, for the Cactus Code.
+%\item [{\bf Relativity Thorn Guide}] This will contain details about the arrangements and thorns making up the Cactus Relativity Tool Kit, one of the major
+% motivators, and still the driving force, for the Cactus Code.
-\item [{\bf Flesh Maintainers Guide}]
- This will contain all the gruesome details
- about the inner workings of Cactus, for all those who want or need to
- expand or maintain the core of Cactus.
+%\item [{\bf Flesh Maintainers Guide}]
+% This will contain all the gruesome details
+% about the inner workings of Cactus, for all those who want or need to
+% expand or maintain the core of Cactus.
\end{Lentry}
@@ -120,7 +117,7 @@ The Cactus Team\\
Albert Einstein Institute\\
Max Planck Institute for Gravitational Physics\\
Am M\"{u}hlenberg 1\\
-D-14476 Golm\\
+D-14476 Potsdam\\
Germany