summaryrefslogtreecommitdiff
path: root/doc/UsersGuide/Preface.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/UsersGuide/Preface.tex')
-rw-r--r--doc/UsersGuide/Preface.tex33
1 files changed, 16 insertions, 17 deletions
diff --git a/doc/UsersGuide/Preface.tex b/doc/UsersGuide/Preface.tex
index 69d24f8d..66f227f9 100644
--- a/doc/UsersGuide/Preface.tex
+++ b/doc/UsersGuide/Preface.tex
@@ -22,8 +22,10 @@
\vskip .5cm
-This document is a complete guide to using and
-developing with the Cactus Code.
+This document contains a quick-start guide to installing and running
+a Cactus application. In subsequent chapters, it provides more detailed
+information on advanced user's topics, as well as an introduction to
+thorn writing.
Please report omissions, errors, or suggestions to
any of our contact addresses below.
@@ -33,29 +35,26 @@ any of our contact addresses below.
\begin{Lentry}
-\item [\textbf{Part~\ref{part:RunningCactus}: Installation and Running.}]
- A description of required hardware and software and an installation guide
- for Cactus.
+\item [\textbf{Part~\ref{part:Introduction}: Introduction to Cactus.}]
+ A guide through the process of obtaining and installing Cactus and running
+ a simple example application with it.
+
+\item [\textbf{Part~\ref{part:Notes}: Additional Notes.}]
+ A more in-depth description of required hardware and software, along with
+ configuration, installation and running options.
Describes how to check the installation with Cactus test suites.
-\item [\textbf{Part~\ref{part:ThornWriters}: Application Thorn Writing.}]
+\item [\textbf{Part~\ref{part:ThornWriting}: 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 [\textbf{Part~\ref{part:UtilityRoutines}: Utility Routines.}]
- A discussion of low-level utility routines available in Cactus, such as
- key/value tables.
-
-\item [\textbf{Part~\ref{part:Infrastructure}:
- Infrastructure Thorn Writer's Guide.}]
- A more advanced discussion of user supplied infrastructure routines such
+ This is followed by a more advanced discussion of user supplied
+ infrastructure routines such
as additional \textit{output routines}, \textit{drivers}, etc.
-
\item [\textbf{Part~\ref{part:Appendices}: Appendices.}]
- These contain a description of the Cactus Configuration Language,
- a glossary,
+ These contain a glossary, a description of the Cactus Configuration
+ Language, the Utility routines
and other odds and ends, such as how to use GNATS and TAGS.
\end{Lentry}